Social Fetch
TikTok

List TikTok Shop store products

Lists products for a TikTok Shop store URL with cursor-based pagination and an optional region. When `data.page.hasMore` is true, pass `data.page.nextCursor` as the `cursor` query parameter on the next request.

Operation

GET/v1/tiktok/shop/products
Cost: 1 credit

Headers

x-api-keystringrequired(header)

API key (`sfk_...`)

Parameters

urlstringrequired(query)

Public TikTok Shop store URL whose products should be listed.

min 1 chars · max 4096 chars

cursorstring(query)

Pagination cursor from a previous response. Omit to request the first page.

min 1 chars · max 8192 chars

regionstring(query)

Optional region code for the shop catalog. When omitted, the default catalog region is US.

one of: US, GB, DE, FR, IT, ID, MY, MX, PH, SG, ES, TH, VN, BR, JP, IE

Response fields

data
objectrequired

Endpoint-specific response payload.

datalookupStatus
stringrequired

Whether the storefront resolved for this request.

one of: found, not_found

datashop
objectrequirednullable

Store summary when `lookupStatus` is `found`; null when the store could not be resolved.

datashopid
stringrequirednullable

Shop seller identifier, when available.

min 1 chars

datashopname
stringrequirednullable

Shop display name, when available.

min 1 chars

datashoplogoUrl
stringrequirednullable

Shop logo image URL, when available.

min 1 chars

datashopstoreUrl
stringrequirednullable

Canonical public URL for the shop storefront, when available.

min 1 chars

datashopregion
stringrequirednullable

Region code reported for the storefront, when available.

min 1 chars

datashoprating
numberrequirednullable

Average shop rating, when available.

≥ 0

datashopsoldCount
integerrequirednullable

Approximate units sold for the shop, when available.

≥ 0

datashopreviewCount
integerrequirednullable

Number of shop reviews, when available.

≥ 0

datashoponSellProductCount
integerrequirednullable

Count of products currently on sale, when available.

≥ 0

datashopfollowerCount
integerrequirednullable

Follower count for the shop, when available.

≥ 0

datashopvideoCount
integerrequirednullable

Video count associated with the shop, when available.

≥ 0

dataproducts
arrayrequired

Product cards returned for the requested page.

dataproducts[]id
stringrequired

TikTok Shop product identifier.

min 1 chars

dataproducts[]title
stringrequired

Product title text.

min 1 chars

dataproducts[]description
stringrequirednullable

Product description, when available.

dataproducts[]url
stringrequirednullable

Canonical public URL for the product page, when available.

min 1 chars

dataproducts[]imageUrl
stringrequirednullable

Primary product image URL, when available.

min 1 chars

dataproducts[]image
objectnullable

Structured image size metadata when the image URL is available.

dataproducts[]imagewidth
integerrequirednullable

Image width in pixels, when available.

≥ 0

dataproducts[]imageheight
integerrequirednullable

Image height in pixels, when available.

≥ 0

dataproducts[]imageurl
required

Primary product image URL.

dataproducts[]shipFrom
stringrequirednullable

Reported ship-from location text, when available.

dataproducts[]trustLabel
stringrequirednullable

TikTok Shop trust badge label, when available.

dataproducts[]labels
arrayrequired

Promotional, shipping, and trust labels for the product card.

dataproducts[]labels[]text
stringrequired

Label text shown for the product.

dataproducts[]labels[]type
integerrequirednullable

TikTok Shop label type code, when available.

dataproducts[]price
objectrequired

Displayed price data.

dataproducts[]pricecurrencyCode
stringrequirednullable

Currency name or code for displayed prices, when available.

dataproducts[]pricecurrencySymbol
stringrequirednullable

Currency symbol for the listed price, when available.

dataproducts[]pricecurrent
stringrequirednullable

Current sale price for the product, when available.

dataproducts[]priceoriginal
stringrequirednullable

Original or list price before discount, when available.

dataproducts[]pricediscountText
stringrequirednullable

Human-readable discount label, when available.

dataproducts[]pricesavingText
stringrequirednullable

Human-readable savings line, when available.

dataproducts[]metrics
objectrequired

Rating and sales metrics for the product.

dataproducts[]metricssold
integerrequirednullable

Approximate units sold, when available.

≥ 0

dataproducts[]metricsreviews
integerrequirednullable

Number of product reviews, when available.

≥ 0

dataproducts[]metricsrating
numberrequirednullable

Average product rating, when available.

≥ 0

dataproducts[]shop
objectrequired

Selling shop for the product.

dataproducts[]shopid
stringrequirednullable

TikTok Shop seller identifier, when available.

dataproducts[]shopname
stringrequirednullable

Shop display name, when available.

dataproducts[]shoplogoUrl
stringrequirednullable

Shop logo image URL, when available.

datapage
objectrequired

Pagination state for the current response.

datapagenextCursor
stringrequirednullable

Opaque cursor to pass as `cursor` on the next request when `hasMore` is true; otherwise null.

min 1 chars

datapagehasMore
booleanrequired

Whether another page of products can be requested for this store.

meta
objectrequired

Metadata describing the request and billing outcome.

metarequestId
stringrequired

Unique request identifier for tracing this API call.

min 1 chars

metacreditsCharged
integerrequired

Credits charged for this request.

≥ 0

metaversion
stringrequired

Public API version that served the response.

one of: v1

Code example

Responses

Store listing result. `data.lookupStatus` is `not_found` when the storefront cannot be resolved.

Error codes

bad_requestinsufficient_creditsinternal_errorlookup_failedtemporarily_unavailableunauthorized

On this page