stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /affiliate_creator/202409/sample_applications/fulfillments/search
#§2 Method: [POST]
#§3 Function Description
You, the creator, can use this API to query the fulfillment status for the received sample applications.
§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. |
| sort_order | string | N | DESC | The sort order for the field specified in the sort_field parameter. |
| Default: ASC | ||||
| Possible values: | ||||
| ASC: Ascending order | ||||
| DESC: Descending order | ||||
| sort_field | string | N | expired_time | Some sorting fields are as follows: |
- expired_time: sort by left time to fulfill.
- create_time: sort by fulfillment content create time. Default value is expired_time. |
§6 Request Body Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| fulfillment_statuses | []string | Y | ["PENDING", "ONGOING"] | A list of fulfillment statuses. The response is filtered to include sample fulfillments with the fulfillment_status field set to one of the specified values. The possible values are: |
- PENDING: The creator has not yet fulfilled 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 is exempt from the fulfillment obligation. |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/affiliate_creator/202409/sample_applications/fulfillments/search?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&sort_order=DESC&sort_field=expired_time
Body
{"fulfillment_statuses":["PENDING","ONGOING"]}
§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 | |
| ^fulfillments | []object | Creator fulfillment contents. | |
| ^^id | string | 123456 | The fulfillment identifier. |
| ^^shop_id | string | 123456 | The TikTok Shop identifier. |
| ^^application_id | string | 123456 | The sample application identifier. |
| ^^sample_application_type | string | FREE_SAMPLE | The type of the sample application. This is an enumerated type with values: |
- FREE_SAMPLE
- SAMPLE_COUPON
- SAMPLE_CAMPAIGN
- PLATFORM_FREE_SAMPLE | ^^product_id |string |123456 |The product identifier. | ^^expiration_time |int |1728542813 |Fulfillment deadline timestamp. Usually the value is
{you_receiving_sample_time} + 14Days. But if you apply for fulfillment suspension, the value is{you_receiving_sample_time} + 14Days + total_suspend_duration. | ^^total_suspend_duration |int |100020 |The duration you applied for fulfillment suspension in seconds. | ^^status |string |ONGOING |The fulfillment status.This is an enumerated type with values: - PENDING: The creator has not yet fulfilled 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 is exempt from the fulfillment obligation. | ^^bound_product_status |string |LIVE |The marketing status of the product associated with the fulfillment order. This is an enumerated type with values:
- UNKNOWN: The marketing status of the product is unknown.
- LIVE: The product is available for fulfillment.
- OUT_OF_STOCK: The product is out of stock and cannot be fulfilled.
- SELLER_DEACTIVATE: The product has been deactivated by the seller.
- PLATFORM_DEACTIVATE: The product has been deactivated by the platform.
- NO_PLAN: There is no valid plan available for the creator to market the product.
- PERMANENT_DELETED: The product has been permanently deleted and is no longer available. |
§9 Response Sample
{"code":0,"data":{"fulfillments":[{"id":"123456","shop_id":"123456","application_id":"123456","sample_application_type":"FREE_SAMPLE","product_id":"123456","expiration_time":1728542813,"total_suspend_duration":100020,"status":"ONGOING","bound_product_status":"LIVE"}]},"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 |
|---|