String docs
Site integrations

Shopee

Shopee product cards by product id or URL: title, prices and discount, shop, rating, likes, category, variations and images.

Call these actions with your String API key; see Authentication. Every call answers with the envelope described in Responses & errors, whose data holds the rows below.

  • Site: shopee
  • Version: 0.1.0
  • Reads from: shopee.sg
ActionDescriptionListed price
productsProduct cards for up to 300 known Shopee products, in input order: title, current, voucher and list prices, discount, shop and its location, rating and count, likes, category path, variation names and images. Products travel 50 to a call. Sold counts, stock and per-variation prices are not on the card. A product Shopee has delisted or will not show comes back as a failure.Billed per request at your plan's rates

products

Product cards for up to 300 known Shopee products, in input order: title, current, voucher and list prices, discount, shop and its location, rating and count, likes, category path, variation names and images. Products travel 50 to a call. Sold counts, stock and per-variation prices are not on the card. A product Shopee has delisted or will not show comes back as a failure.

POST https://request.usestring.ai/v1/integrations/shopee/products

Input

Unknown fields are rejected.

FieldTypeDescription
itemsstring[]Required. Shopee products: product page URLs (https://shopee.sg/\-i.<shopId>.<itemId> or https://shopee.sg/product/\/<itemId>), or shopId.itemId pairs such as 1903244059.45465047307. 1 to 300 entries.
marketsgThe storefront: sg (shopee.sg, the default) Defaults to "sg".
collectionIdintegerThe product collection the lookup runs through, which only has to exist in the market; it does not limit which products come back. Defaults to a live collection per market. At least 1.

Output

data is an array of rows, one per result. Each row has:

FieldTypeDescription
itemIdinteger—
shopIdinteger—
urlstring—
titlestring | null—
brandIdinteger | nullShopee's brand id, set when the seller tagged a brand.
pricenumber | nullThe price the product sells at now, promotions applied, before vouchers.
priceWithVouchernumber | nullThe price after the shop or platform voucher Shopee recommends on the card, when one applies; else equal to price.
priceBeforeDiscountnumber | nullThe struck-through list price, when the product is discounted.
originalPricenumber | nullThe list price, discounted or not.
discountPercentinteger | nullShopee's discount badge, in percent: the list price against the price with the recommended voucher.
currencystringISO 4217, such as SGD.
isSoldOutboolean | null—
ratingnumber | nullAverage star rating, 0 to 5.
ratingCountinteger | null—
ratingCountsByStarinteger[] | nullRating counts for 1 to 5 stars, in that order.
likesinteger | null—
shopNamestring | null—
shopLocationstring | nullWhere the shop ships from, such as Singapore or Mainland China.
categoryIdinteger | nullThe leaf category id.
categoryIdsinteger[] | nullThe category path, top level first.
variationsobject[] | nullThe option groups a buyer picks from, such as Colour and Size, without per-option price or stock.
variations[].namestring—
variations[].optionsstring[] | null—
imagestring | null—
imagesstring[] | null—

Example

curl https://request.usestring.ai/v1/integrations/shopee/products \
  -H "Authorization: Bearer $STRING_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "items": ["1903244059.45465047307", "https://shopee.sg/product/1889854075/55214047413", "https://shopee.sg/Some-Product-i.442800909.57717808852", "66342314.42664291634", "1231058324.48912008834"]
  }'

data starts with these rows:

[
  {
    "itemId": 45465047307,
    "shopId": 1903244059,
    "url": "https://shopee.sg/product/1903244059/45465047307",
    "title": "Solar Powerbank 100000mAh 50000mAh Wireless Magnetic With 4 Cables LED Outdoor Portable",
    "brandId": null,
    "price": 15.35,
    "priceWithVoucher": 13.04,
    "priceBeforeDiscount": 15.5,
    "originalPrice": 15.5,
    "discountPercent": 16,
    "currency": "SGD",
    "isSoldOut": false,
    "rating": 4.686619718309859,
    "ratingCount": 284,
    "ratingCountsByStar": [8, 2, 16, 19, 239],
    "likes": 1,
    "shopName": "sip-linking.sg",
    "shopLocation": "Malaysia",
    "categoryId": 100486,
    "categoryIds": [100013, 100075, 100287, 100486],
    "variations": [
      {
        "name": "Style",
        "options": ["50000mah", "100000mah", "100000mah-Wireless", "20000mAh"]
      }
    ],
    "image": "https://down-sg.img.susercontent.com/file/my-11134211-7rasl-m35t1560j5kxfa",
    "images": ["https://down-sg.img.susercontent.com/file/my-11134211-7rasl-m35t1560j5kxfa", "https://down-sg.img.susercontent.com/file/my-11134207-7r990-lqg386m42tz2bb", "https://down-sg.img.susercontent.com/file/my-11134207-7r990-lqg386m448ji36", "https://down-sg.img.susercontent.com/file/my-11134207-7r98u-lqg386m45n3y24", "https://down-sg.img.susercontent.com/file/my-11134207-7r98t-lqg386m471oe94", "https://down-sg.img.susercontent.com/file/my-11134207-7r98o-lqg386m48g8u0e", "https://down-sg.img.susercontent.com/file/my-11134207-7r98r-lqg386m49uta7c", "https://down-sg.img.susercontent.com/file/my-11134207-7r98r-lqg386m4b9dq4c", "https://down-sg.img.susercontent.com/file/my-11134207-7r98y-lqg386m4e2im97"]
  },
  {
    "itemId": 55214047413,
    "shopId": 1889854075,
    "url": "https://shopee.sg/product/1889854075/55214047413",
    "title": "New Styles Available-蓉蓉直播间专属链接1",
    "brandId": null,
    "price": 65.29,
    "priceWithVoucher": 65.19,
    "priceBeforeDiscount": 65.29,
    "originalPrice": 65.29,
    "discountPercent": 1,
    "currency": "SGD",
    "isSoldOut": false,
    "rating": 4.957671957671957,
    "ratingCount": 203,
    "ratingCountsByStar": [1, 0, 1, 2, 199],
    "likes": 3,
    "shopName": "mistian 662",
    "shopLocation": "Mainland China",
    "categoryId": 100098,
    "categoryIds": [100016, 100098],
    "variations": [
      {
        "name": "",
        "options": [""]
      }
    ],
    "image": "https://down-sg.img.susercontent.com/file/cn-11134207-820l4-msasoooamadi40",
    "images": ["https://down-sg.img.susercontent.com/file/cn-11134207-820l4-msasoooamadi40", "https://down-sg.img.susercontent.com/file/cn-11134207-820l4-mqlohw3zun7v02"]
  }
]

Requests and billing

  • Requests: 1 Web Access request per batch of up to 50 entries in items.
  • Billing: passthrough. Each request the action makes bills at its own rate on your plan; there is no separate charge for the action. See Pricing.