stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /product/202606/skpps/{product_id}
#§2 Method: [GET]
#§3 Function Description
Return the SKPP diagnostic for one product.
§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 Path Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| product_id | string | Y | 7311223344556677889 | Product ID generated by Tiktok Shop. |
§6 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. |
| locale | string | N | en-US | The BCP-47 locale codes for displaying category information. |
| Default: The default locale of your shop. | ||||
| Possible values: |
- en
- en-GB
- zh-CN
- de-DE
- id-ID
- it-IT
- ja-JP
- ms-MY
- pt-BR
- th-TH
- vi-VN |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/product/202606/skpps/7311223344556677889?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY&locale=en-US
§8 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 | |
| ^product_id | string | 7311223344556677889 | Platform product ID. |
| ^affiliate_program_status | string | ACTIVE | Affiliate Program enrolment. Possible values: ACTIVE / INACTIVE. |
| ^total_score | int | 6 | Current SKPP total score, as of update_time. |
| ^target_score | int | 8 | Score threshold to qualify for SKPP. |
| ^rewards | []object | Reward list. | |
| ^^reward_type | string | AD_CREDIT | Possible values: ADS_CREDIT / TOP_CREATOR_MATCHMAKING / SHOPTAB_PV / BIG_PROMOTION_CAMPAIGN. |
| ^^title | string | Ad credit reward | Localized reward name, resolved from the shared Seller-Center content by the request locale. |
| ^^status | string | CLAIMABLE | Possible values: NOT_GRANTED / PENDING / AVAILABLE |
| ^^ad_credit_claim_status | string | UNCLAIMED | Ad-credit-only sub-status, returned only when reward_type = ADS_CREDIT and status = AVAILABLE. Possible values: UNCLAIMED (eligible, not yet claimed) / CLAIMED (claimed). |
| ^^value | string | 100 | Granted amount/quantity; currency-typed values lead with the currency symbol. |
| ^^claim_conditions | []object | Thresholds to unlock the reward; used by ADS_CREDIT. | |
| ^^^condition_type | string | SCORE | Possible values: GMV / ORDER. |
| ^^^current_value | string | 72 | Current progress; GMV-typed values lead with the currency symbol. |
| ^^^target_value | string | 100 | Threshold value; same formatting as current_value. |
| ^^campaign_id | string | 7390000000000000000 | Returned only for reward_type = BIG_PROMOTION_CAMPAIGN. |
| ^task_details | []object | Per-category score breakdown with suggested actions. | |
| ^^category | string | PRODUCT_CONTENT | Key for the scoring category. |
| ^^name | string | Improve product title | Localized category name, resolved from category via the shared content by the request locale. |
| ^^current_value | string | 12 | Current value of this dimension's metric (e.g. current price, commission rate, free-shipping status). |
| ^^target_value | string | 20 | Value this dimension must reach to pass; same unit/format as current_value. |
| ^^passed | bool | false | Whether this dimension meets its target_value. |
| ^^action_suggestions | []object | Suggested actions to complete this task; returned only when passed = false. A task may have multiple suggestions. | |
| ^^^score_increase | int | 8 | SKPP points added to total_score when this action is completed; for tiered actions, the maximum tier. |
| ^^^url | string | https://seller.tiktokglobalshop.com/product/edit | Link to the Seller Center page that completes the action. |
| ^update_time | int | 1779129600 | Date of the offline data snapshot that total_score, rewards and the score breakdown are derived from, returned as a Unix timestamp in seconds, pinned to the last second of that date in UTC (23:59:59Z). The value is date-level only — the time component is always 23:59:59 UTC — because the SKPP scoring runs in an offline pipeline with no intraday granularity. Latency is typically T+1 (the evening of day N publishes the day N−1 snapshot) and at most T+2. |
| ^skpp_status | string | QUALIFIED | Possible values: QUALIFIED / NOT_QUALIFIED / NOT_ELIGIBLE. |
§9 Response Sample
{"code":0,"data":{"product_id":"7311223344556677889","affiliate_program_status":"ACTIVE","total_score":6,"target_score":8,"rewards":[{"reward_type":"AD_CREDIT","title":"Ad credit reward","status":"CLAIMABLE","ad_credit_claim_status":"UNCLAIMED","value":"100","claim_conditions":[{"condition_type":"SCORE","current_value":"72","target_value":"100"}],"campaign_id":"7390000000000000000"}],"task_details":[{"category":"PRODUCT_CONTENT","name":"Improve product title","current_value":"12","target_value":"20","passed":false,"action_suggestions":[{"score_increase":8,"url":"https://seller.tiktokglobalshop.com/product/edit"}]}],"update_time":1779129600,"skpp_status":"QUALIFIED"},"message":"Success","request_id":"202203070749000101890810281E8C70B7"}
§10 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. |