stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /affiliate_seller/202409/sample_applications/{application_id}/fulfillments/search
#§2 Method: [POST]
#§3 Function Description
You, the seller, can use this API to get the fulfillment status of the specific sample application and whether the fulfillment resulted in orders. This allows Sellers to track the current progress or analyze the results of their sample distribution program.
§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 |
|---|---|---|---|---|
| application_id | string | Y | 123456789 | The application identifier. |
§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. |
§7 Request Body Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| content_format | string | N | LIVE | The content type generated by the creator after receiving the samples. Possible enumerations: |
- LIVE
- VIDEO |
§8 Request Sample
Query
https://open-api.tiktokglobalshop.com/affiliate_seller/202409/sample_applications/123456789/fulfillments/search?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY
Body
{"content_format":"LIVE"}
§9 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 | |
| ^fulfillments | []object | Fulfillments | |
| ^^product | object | Product information | |
| ^^^id | string | 123456 | The product identifier. |
| ^^^main_image_url | string | https://www.example.com | The cover image url of product. |
| ^^content | object | Fulfillment content information. | |
| ^^^id | string | 123456 | The video or live room identifier. |
| ^^^format | string | LIVE | The format of the generated content: |
- LIVE
VIDEO| ^^^url |string |https://www.example.com |The content source link. | ^^^view_count |int |100 |The cumulative total number of content viewed. | ^^^like_count |int |123 |The cumulative total number of content liked. | ^^^comment_count |int |10 |The cumulative total number of content commented. | ^^^paid_order_count |int |1 |The cumulative total number of orders paid for content. | ^^^page_link |string |https://www.example.com |Content page url of TikTok. | ^^^description |string |abc def gh |The title of video or the description of the live room. | ^^^create_time |int |1723529426 |- Whenformat==VIDEO, it refers to the time when the video is first set to public and linked to the product.- When
format==LIVE, it refers to the time when the product link is first added to the live stream. | ^^^live_end_time |int |1723529426 |Only whenformat==LIVE. It refers to the time when the product link is removed from the live room. If the product link remains active and is not removed, then it is the end of the live stream. |
§10 Response Sample
{"code":0,"data":{"fulfillments":[{"product":{"id":"123456","main_image_url":"https://www.example.com"},"content":{"id":"123456","format":"LIVE","url":"https://www.example.com","view_count":100,"like_count":123,"comment_count":10,"paid_order_count":1,"page_link":"https://www.example.com","description":"abc def gh","create_time":1723529426,"live_end_time":1723529426}}]},"message":"Success","request_id":"202203070749000101890810281E8C70B7"}
§11 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. |