Returns up to 100 products ranked by GMV for the target date range.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”Identifies the shop. Obtain it from the Get Authorized Shops API.
Filter products by a Level 1 category ID.
The inclusive end date of the query period, in ISO 8601 YYYY-MM-DD format and the shop’s registered time zone. The period spans the selected time_slot and ends on this date (for example, 7D queries the seven days ending on this date). The date must be on or before the latest available date. If a request uses a later date, the error response identifies the latest available date; retry with that date or an earlier date.
The length of the query period ending on date. Supported values are:
- 1D — 1 day
- 7D — 7 days
- 30D — 30 days
Currency for monetary values. Use USD for US dollars or LOCAL for the local currency where the shop is registered. Default: LOCAL.
Responses
Section titled “Responses”Success
object
Status code; 0 means success.
Success or failure message.
Request log ID.
object
List of bestselling product records for the target date range.
object
GMV rank of the product.
GMV range of the product, in the currency specified by currency.
Product ID
Product name
Product rating in history
Product image information, including URI, URLs, thumbnail URLs, height, and width.
object
The image height. Unit: px
The image width. Unit: px
The URLs to view the image thumbnails.
The URI of the image.
The URLs to view the images.
The TikTok Shop name.
The ID of the TikTok Shop associated with the product.
Example
{ "code": 0, "data": { "products": [ { "rank": 1, "gmv_range": "$97000.00~$191000.00", "id": "123456", "name": "Labubu", "rating": "4.5", "product_image": { "height": 2000, "width": 2000, "thumb_urls": [ "tos-useast5-i-omjb5zjo8w-tx/cad4b7c7409f459a87c54baf31ff8a20" ], "uri": "tos-useast5-i-omjb5zjo8w-tx/cad4b7c7409f459a87c54baf31ff8a20", "urls": [ "https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/157d5bf9ac5a4af5855a2284626605c8~tplv-o3syd03w52-origin-jpeg.jpeg" ] }, "shop_name": "Nia Batik", "shop_id": "7028916274713380866" } ] }, "message": "Success", "request_id": "202203070749000101890810281E8C70B7"}