GET Get Shop SKU Performance List
Get Shop SKU Performance List Shop Required scope: data.shop_analytics.public.read Returns a list of SKU performance metrics. Version 202509
GET/analytics/202509/shop_skus/performance
Request
Header
| Properties | Type | Description |
|---|---|---|
| content-type Required | string | Allowed type: application/json |
| x-tts-access-token Required | string | The seller access_token value from Get Access Token, when user_type = 0. Follow this guide to get seller access_token. |
Query
| Properties | Type | Description |
|---|---|---|
| app_key Required | string | Every single app will have a unique key. Please use the specific key assigned to your app. |
| sign Required | string | Signature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders. |
| timestamp Required | int | 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 Required | string | Start time (ISO 8601 YYYY-MM-DD format) in shop registered timezone, inclusive. |
| end_date_lt Required | string | End time (ISO 8601 YYYY-MM-DD format) in shop registered timezone, exclusive. |
| page_size | int | Number of records per page. The maximum page_size value is 100 |
| page_token | string | Page token, indicating the current position. The page_token is empty by default, indicating first position. |
| sort_field | string | Sort field, possible values:- gmv (default)- sku_orders- units_sold |
| sort_order | string | Sort direction, possible values:- DESC (default)- ASC |
| category_filter | []string | Category id array |
| product_status_filter | string | LIVEINACTIVEALL (default) |
| product_ids | []string | 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 | Currency:- USD: US dollars- LOCAL (default): Local currency where the shop is located |
| shop_cipher Required | string | 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 |
Example
CurlGoNode.jsJavaEnable word wrap
Response Parameters
| Properties | Type | Description |
|---|---|---|
| code | int | The success or failure status code returned in API response. |
| message | string | The success or failure messages returned in API response. Reasons of failure will be described in the message. |
| request_id | string | Request log |
| data | object | Specific return information |
Example
JSONEnable word wrap
Error Code
View common error codes
| Code | Message | | --- | --- | | 36009003 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. |
Is this content helpful?Helpful
Not Helpful
PreviousNext