Apinoa Docs

Catalog

List one TikTok Shop store's products, 30 at a time.

View raw .mdx
GET | POST /v1/tiktokshop/catalog

Send parameters as a query string with GET, or as a JSON body with POST. Both are equivalent.

Parameters

ParameterTypeRequiredNotes
idstringyesThe store, by the marketplace's own id (on Shopify: its host or any URL on it).
cursorstringThe previous page's cursor, for the next 30 products.
regionstringBuyer country as ISO 3166-1 alpha-2; sets availability, shipping and price.

Request

curl "https://gateway.apinoa.com/v1/tiktokshop/catalog?id=7495904598724610138" \
  -H "x-api-key: $APINOA_API_KEY"

Response

Returns SearchResult in data. A real response, shortened: arrays keep their first entries and long text is cut.

{
  "success": true,
  "data": {
    "marketplace": "tiktokshop",
    "page": {
      "index": 1,
      "size": 30
    },
    "items": [
      {
        "marketplace": "tiktokshop",
        "id": "1730242444274471002",
        "url": "https://shop.tiktok.com/us/pdp/mini-bluetooth-5-4-true-wireless-in-ear-earphones-by-invisible/1730242444274471002",
        "title": "MSHUKCOE Mini Invisible True Wireless In-Ear Earphones - Bluetooth 5.4, Noise Cancelling, Stereo Audio, True Wireless D…",
        "price": {
          "currency": "USD",
          "amount": 18.99
        },
        "priceRange": {
          "min": {
            "currency": "USD",
            "amount": 18.99
          },
          "max": {
            "currency": "USD",
            "amount": 54.47
          }
        },
        "brand": "MSHUKCOE",
        "rating": {
          "average": 4.4,
          "count": 33593
        },
        "seller": {
          "id": "7495904598724610138",
          "name": "Listening Digital"
        },
        "salesCount": 234278,
        "delivery": {
          "free": true
        },
        "imageUrl": "https://p19-oec-general-useast5.ttcdn-us.com/tos-useast5-i-omjb5zjo8w-tx/cb5e11c34d3e45cab987b227a2996f9f~tplv-fhlh96ny…",
        "variantCount": 10,
        "badges": [
          "Free shipping"
        ],
        "promotions": [],
        "attributes": []
      }
    ],
    "cursor": "30_WzE4NSwyOTkwMDAwMCwxNzkxMTc4NTk1NTczLCIxNzMyNzIxNDU2OTYyNDQxMzA2Il0="
  }
}

Errors

StatusCodeMeaning
400INVALID_CURSORThe cursor is not one this operation returned. Start again without it.
400INVALID_PARAMSA parameter is missing, unknown or out of range. The message names it.
401UNAUTHORIZEDThe x-api-key header is missing, or the key is revoked or unknown.
402INSUFFICIENT_BALANCEThe balance does not cover this call. Top up in the dashboard.
404NOT_FOUNDThe store does not exist.
429MARKETPLACE_SATURATEDToo many concurrent calls. Retry after the Retry-After seconds.
502UPSTREAM_ERRORThe platform answered with something unusable. Retry with backoff.

Every code is listed in Errors. Failed calls are not billed.

Pricing

Price $0.001 per call. List price; the rate steps down above 1,000 calls a day.

Notes

  • id is the store's seller id, as a search item's seller.id carries it, or the store's URL (shop.tiktok.com/us/store/<name>/<id>).
  • Paging: pass the previous response's cursor for the next 30. The last page has no cursor.
  • A store with nothing on sale returns an empty first page.

On this page