stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /product/202606/skpps/sum
#§2 Method: [GET]
#§3 Function Description
Return the shop-level SKPP products roll-up.
§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. |
§6 Request Sample
Query
https://open-api.tiktokglobalshop.com/product/202606/skpps/sum?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY
§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 | |
| ^shop_summary | object | Shop-level SKPP overview. | |
| ^^qualified_products_count | int | 1 | Number of products that are already SKPP. |
| ^^eligible_products_count | int | 5 | Number of products that are already SKPP, plus those that have not yet met the standard but can take SKPP tasks. |
| ^^earned_ad_credit | string | $500 | Total ad credit earned by the shop, currency-prefixed. |
| ^^increased_visibility_l30d | string | 12345 | Incremental visibility gained from SKPP rewards in the last 30 days. |
§8 Response Sample
{"code":0,"data":{"shop_summary":{"qualified_products_count":1,"eligible_products_count":5,"earned_ad_credit":"$500","increased_visibility_l30d":"12345"}},"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 |
|---|---|
| 12081001 | Invalid request parameters. |
| 12081003 | Internal server error. |
| 12081006 | Unauthorized for SKPP on this shop. |