stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /product/202606/skpps/search
#§2 Method: [POST]
#§3 Function Description
Batch query SKPP status for the seller's products.
§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. |
| 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。 |
§6 Request Body Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| product_ids | []string | N | ["7345678901","7345678902"] | Product IDs generated by Tiktok Shop; up to 100 per call. |
| skpp_status | string | N | QUALIFIED | Optional filter. |
| Possible values:QUALIFIED (already an SKPP product) / NOT_QUALIFIED (not yet meeting the standard, but eligible to take SKPP tasks). | ||||
| page_size | int | N | 50 | Page number, starts at 1; used with page_size. |
| page_no | int | N | 1 | page no |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/product/202606/skpps/search?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY&locale=en-US
Body
{"product_ids":["7345678901","7345678902"],"skpp_status":"QUALIFIED","page_size":50,"page_no":1}
§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 | |
| ^products | []object | Product list, each with its SKPP status.。 | |
| ^^product_id | string | 7345678901234567890 | Product IDs generated by Tiktok Shop |
| ^^title | string | Premium Cotton T-Shirt | Product title. |
| ^^skpp_status | string | QUALIFIED | Possible values: QUALIFIED / NOT_QUALIFIED |
| ^^affiliate_program_status | string | ACTIVE | Affiliate Program enrolment status. Possible values: ACTIVE / INACTIVE. |
| ^^total_score | int | 8 | Current SKPP total score, as of update_time. |
| ^^target_score | int | 7 | Score threshold to qualify for SKPP. |
| ^^rewards | []object | Rewards data. | |
| ^^^reward_type | string | ADS_CREDIT | Possible values: ADS_CREDIT / TOP_CREATOR_MATCHMAKING / SHOPTAB_PV. |
| ^^^status | string | AVAILABLE | Possible values: NOT_GRANTED (below threshold, locked) / PENDING (qualified, not yet granted) / AVAILABLE (granted). |
| ^^^value | string | $15 | Granted amount/quantity; present only when status = AVAILABLE. Currency-typed (ADS_CREDIT) leads with the currency symbol (e.g. $15); count-typed (TOP_CREATOR_MATCHMAKING, SHOPTAB_PV) are bare numbers. |
| ^^^ad_credit_claim_status | string | CLAIMED | Ad-credit-only sub-status, returned only when reward_type = ADS_CREDIT and status = AVAILABLE. Possible values: UNCLAIMED (eligible, not yet claimed) / CLAIMED (claimed). Ad credit must be claimed manually. |
| ^total_count | int | 1234 | Total products matching the filter. |
| ^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. |
§9 Response Sample
{"code":0,"data":{"products":[{"product_id":"7345678901234567890","title":"Premium Cotton T-Shirt","skpp_status":"QUALIFIED","affiliate_program_status":"ACTIVE","total_score":8,"target_score":7,"rewards":[{"reward_type":"ADS_CREDIT","status":"AVAILABLE","value":"$15","ad_credit_claim_status":"CLAIMED"}]}],"total_count":1234,"update_time":1779129600},"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. |