stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存,可追溯
- 官方原文可核对
资料正文
§1 Path: /affiliate_creator/202412/sample_applications/single_query
#§2 Method: [POST]
#§3 Function Description
Get the sample detail of specified sample application.
§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. |
§6 Request Body Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| product_id | string | Y | 1729480364147774364 | The product identifier. |
| application_id | string | N | 8070590921506065183 | Free sample application ID, required when application type is "FREE_SAMPLE". |
| application_type | string | Y | FREE_SAMPLE | The type of creator sample application. |
- FREE_SAMPLE : free sample supplied by seller which creator can apply for by themselves from product detail page.
- SAMPLE_COUPON: creator claimed sample coupon (a type of coupon) and used it to place orders at a discount price.
- SAMPLE_CAMPAIGN: activity organized by the platform. Creators can participate in this activity to obtain sample products provided by the platform for free. | main_order_id |string |N |579622078763731743 |The real main order identifier, required when application is "SAMPLE_COUPON" or "SAMPLE_CAMPAIGN" or "REFUNDABLE_SAMPLE". |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/affiliate_creator/202412/sample_applications/single_query?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268
Body
{"product_id":"1729480364147774364","application_id":"8070590921506065183","application_type":"FREE_SAMPLE","main_order_id":"579622078763731743"}
§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 | |
| ^sample_application | object | The sample application information. | |
| ^^id | string | 8070590921506065183 | Sample application identifier. |
| ^^create_time | int | 1731298837 | Sample application create time in seconds. |
| ^^sample_product | object | The sample product information. | |
| ^^^id | string | 1729863469568985219 | The product identifier. |
| ^^^sku_id | string | 1729480364147774364 | The SKU identifier. |
| ^^^sku_sale_property_value_names | []string | "red, large size" | Sku property name list for this sku id. |
| ^^main_order_id | string | 57871819384716917 | The sample order is generated after the sample application is approved by seller. |
| ^^activity_id | string | 74378918272345199 | The sample activity identifier id( only for sample campaign). |
| ^^type | string | FREE_SAMPLE | The type of creator sample application. |
- FREE_SAMPLE : free sample supplied by seller which creator can apply by themselves from pdp page.
- SAMPLE_COUPON: creator claimed sample coupon (a type of coupon) and used it to purchase orders at a discount price.
- SAMPLE_CAMPAIGN: activity organized by the platform. Creators can participate in this activity to obtain sample products provided by the platform for free. | ^^status |string |PENDING |The status of sample applications. The possible enumerated values are:
- PENDING: The sample application is waiting for the seller's review.
- AWAITING_SHIPMENT: The application is approved, and the seller needs to ship the sample.
- SHIPPED: The sample has been shipped by the seller and is waiting for the creator to receive the package.
- CONTENT_PENDING: The creator has received the sample package and is expected to create content.
- REJECT_CANCELLED: The sample application has been rejected by the seller.
- OVERDUE_CANCELLED: The sample application has expired due to being overdue.
- UNFULFILL_CANCELLED: The creator did not fulfill the commitment to create content within the agreed timeframe.
- SELLER_NOT_SHIP_CANCELLED: The seller did not ship the sample within the required timeframe.
- WITHDRAW_CANCELLED: The creator withdrew the sample application before the seller approved it.
- UNFULFILLABLE_CANCELLED: The application was cancelled due to reasons beyond the creator's control, making it impossible to create content.
- OPS_CANCELLED: The application was manually cancelled by operations staff.
- OPS_FAILED: The application was marked as failed by operations staff.
- OPS_ COMPLETED: The application was manually marked as completed by operations staff.
- COMPLETED: The application is complete, and the creator has posted the content. This field allows for tracking the status of a sample application throughout its lifecycle, providing visibility into each stage of the process for sellers and creators. | ^^creator_fulfillment |object | |Fulfillment info for this sample application. | ^^^id |string |87147319238415178 |Fulfillment identifier. | ^^^expiration_time |int |1726301400 |Fulfillment deadline timestamp, in seconds. | ^^^total_suspend_duration |int |7641234 |Total suspension duration for fulfillment, in seconds. | ^^^status |string |PENDING |Fulfillment status, It indicates the current status of the fulfillment process. The possible values are:
- PENDING: The creator is yet to fulfill the content creation obligation.
- ONGOING: Fulfillment is in progress; content has been created and is being evaluated against criteria.
- SUCCEED: Fulfillment has been successfully completed; the content meets the required standards.
- FAILED: Fulfillment failed; the content did not meet the required standards.
- OVERDUE: Fulfillment is overdue; the creator did not meet the deadline.
- SUSPEND: Fulfillment has been suspended.
- CANCELLED: Fulfillment has been cancelled, either by the creator or due to operational reasons.
- EXEMPTED: The creator has been exempted from the fulfillment obligation. |
§9 Response Sample
{"code":0,"data":{"sample_application":{"id":"8070590921506065183","create_time":1731298837,"sample_product":{"id":"1729863469568985219","sku_id":"1729480364147774364","sku_sale_property_value_names":"\"red, large size\""},"main_order_id":"57871819384716917","activity_id":"74378918272345199","type":"FREE_SAMPLE","status":"PENDING","creator_fulfillment":{"id":"87147319238415178","expiration_time":1726301400,"total_suspend_duration":7641234,"status":"PENDING"}}},"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 |
|---|---|
| 36009003 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. |
