stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /analytics/202509/shop_skus/performance
#§2 Method: [GET]
#§3 Function Description
Returns a list of SKU performance metrics.
§4 Common Parameters
For common parameters, refer to How to call TikTok Shop APIs - Common Parameters
| Properties | Location | Type | Require | Sample | Properties description |
|---|---|---|---|---|---|
| shop_cipher | query | string | Y | GCP_XF90igAAAABh00qsWgtvOiGFNqyubMt3 | Use this property to pass shop information in requesting the API. Failure in passing the correct value when requesting the API for cross-border shops will return incorrect response. |
| Get by API Get Authorization Shop | |||||
| content-type | header | string | Y | application/json | Allowed type: application/json |
§5 Request Query Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| app_key | string | Y | 38abcd | Every single app will have a unique key. Please use the specific key assigned to your app. |
| sign | string | Y | 5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c | Signature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders. |
| timestamp | int | Y | 1623812664 | Unix timestamp GMT (UTC+00:00). This timestamp is used across all API requests. Developers can use this convert to local time. |
| start_date_ge | string | Y | 2024-04-01 | Start time (ISO 8601 YYYY-MM-DD format) in shop registered timezone, inclusive. |
| end_date_lt | string | Y | 2024-04-08 | End time (ISO 8601 YYYY-MM-DD format) in shop registered timezone, exclusive. |
| page_size | int | N | 10 | Number of records per page. The maximum page_size value is 100 |
| page_token | string | N | cGFnZV9udW1iZXI9MQ== | Page token, indicating the current position. The page_token is empty by default, indicating first position. |
| sort_field | string | N | gmv | Sort field, possible values: |
- gmv (default)
- sku_orders
- units_sold | sort_order |string |N |DESC |Sort direction, possible values:
- DESC (default)
- ASC | category_filter |[]string |N |123123,321412 |List of category IDs used to filter returned SKU performance records. | product_status_filter |string |N |LIVE |LIVE INACTIVE ALL (default) | product_ids |[]string |N |123456789,34909989 |Filter SKUs by product IDs. If product_ids are provided, the API will only return SKUs for the given product IDs, otherwise it will return all SKUs for the shop | currency |string |N |USD |Currency:
- USD: US dollars
- LOCAL (default): Local currency where the shop is located |
§6 Request Sample
Query
https://open-api.tiktokglobalshop.com/analytics/202509/shop_skus/performance?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY&start_date_ge=2024-04-01&end_date_lt=2024-04-08&page_size=10&page_token=cGFnZV9udW1iZXI9MQ==&sort_field=gmv&sort_order=DESC&category_filter=123123,321412&product_status_filter=LIVE&product_ids=123456789,34909989¤cy=USD
§7 Response Parameters
| Properties | Type | Sample | Properties description |
|---|---|---|---|
| code | int | 0 | The success or failure status code returned in API response. |
| message | string | Success | The success or failure messages returned in API response. Reasons of failure will be described in the message. |
| request_id | string | 202203070749000101890810281E8C70B7 | Request log |
| data | object | Specific return information | |
| ^skus | []object | List of SKU performance metrics. | |
| ^^id | int | 18354627263453 | The ID of the SKU in the returned SKU performance record. |
| ^^product_id | int | 123456789 | The ID of the product that the returned SKU belongs to. |
| ^^gmv | object | Overall Gross Merchandise Value (GMV) for the SKU. | |
| ^^^amount | string | 135.42 | GMV amount in the corresponding currency. |
| ^^^currency | string | USD | GMV currency code (ISO 4217 standard). If LOCAL currency is requested, the value will be the local currency code of where the shop is registered (e.g. GBP). |
| ^^sku_orders | int | 10 | Total (sum of all) orders for a SKU |
| ^^units_sold | int | 10 | Number of units sold for a SKU |
| ^next_page_token | string | cGFnZV9udW1iZXI9MQ== | Page token for the next page request. |
| ^total_count | int | 20 | Total number of SKUs. |
| ^latest_available_date | string | 2024-04-07 | Latest date in local timezone where data is ready (ISO 8601 format). |
§8 Response Sample
{"code":0,"data":{"skus":[{"id":18354627263453,"product_id":123456789,"gmv":{"amount":"135.42","currency":"USD"},"sku_orders":10,"units_sold":10}],"next_page_token":"cGFnZV9udW1iZXI9MQ==","total_count":20,"latest_available_date":"2024-04-07"},"message":"Success","request_id":"202203070749000101890810281E8C70B7"}
§9 Error Code
For common error codes, refer to How to call TikTok Shop APIs - Common Error Code
| Code | Message |
|---|---|
| 36009003 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. |