stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存,可追溯
- 官方原文可核对
资料正文
§1 Path: /affiliate_creator/202412/samples/labels
#§2 Method: [GET]
#§3 Function Description
Check if a creator can apply for a sample of a specific product.
§4 Common Parameters
For common parameters, refer to How to call TikTok Shop APIs - Common Parameters
| Properties | Location | Type | Require | Sample | Properties description |
|---|---|---|---|---|---|
| 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. |
| product_id | string | Y | 1729480364147774364 | The TikTok Shop product identifier. |
§6 Request Sample
Query
https://open-api.tiktokglobalshop.com/affiliate_creator/202412/samples/labels?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&product_id=1729480364147774364
§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 | |
| ^label | object | Creator applicable sample label information. | |
| ^^can_apply | bool | true | Creator can apply this application or not. |
| ^^status | string | ONGOING | Status to describe if the creator has already applied this product as a free sample. |
- TO_APPLY: creator has not applied this product as a free sample.
- ONGOING: creator applied this product as a free sample while he/she has not finished sample fulfillment.
- COMPLETE: creator applied this product as a free sample and finished sample fulfillment. | ^^application_id |string |86427198341982134 |Sample Application ID. only appear when the creator has already applied this product. | ^^reach_limit |bool |true |If the creator has reached the sample application upper limit. | ^^sample_product |object | |The sample product information. | ^^^sample_sku_list |[]object | |The sample product SKU information. | ^^^^id |string |1731055098570377347 |The SKU identifier. | ^^^^sale_property_value_ids |string |7068196393634072325 |The combination of SKU properties for this SKU. | ^^^^price |object | |SKU price information. | ^^^^^amount |string |7588986 |The price amount. | ^^^^^currency |string |USD |The price currency code. | ^^^^sale_properties |[]object | |The SKU property information. | ^^^^^id |string |100000 |A SKU property identifier, short for "Stock Keeping Unit Property ID", is a specific identification code assigned to a particular property or characteristic of a SKU.(i.e: "100000" means "color") | ^^^^^name |string |color |The SKU property name. | ^^^^^value_id |string |7425668826861520646 |The SKU property value identifier is an identification code related to the specific values of the properties of a Stock Keeping Unit (SKU). When a SKU has certain properties like color, size, etc., each possible value for those properties has its own unique SKU property value identifier. For instance, if the property is "color" and the possible values are "red", "blue", "green", then "red" would have its own SKU property vvalue identifier, "blue" would have another one, and so on. | ^^^^^value_name |string |Default |The SKU property value name. | ^^^^is_available |bool |true |If this SKU is available. | ^^^^unavailable_reason |string |IS_PREORDER |The reason why the SKU is unavailable:
- IS_PREORDER : this product is a preorder product which does not support free sample
- IS_GIFT: this product is a gift product which does not support free sample
- OUT_OF_STOCK: product sold out
- EXCEED_CB_PRICE_THRESHOLD:
- ALREADY_APPLYED: creator has already applied this SKU. |
§8 Response Sample
{"code":0,"data":{"label":{"can_apply":true,"status":"ONGOING","application_id":"86427198341982134","reach_limit":true,"sample_product":{"sample_sku_list":[{"id":"1731055098570377347","sale_property_value_ids":"7068196393634072325","price":{"amount":"7588986","currency":"USD"},"sale_properties":[{"id":"100000","name":"color","value_id":"7425668826861520646","value_name":"Default"}],"is_available":true,"unavailable_reason":"IS_PREORDER"}]}}},"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. |
