stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /affiliate_creator/202412/sample_applications/search
#§2 Method: [POST]
#§3 Function Description
Get sample application list of creator.
§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. |
| page_token | string | N | 87712341234 | Pagination offset determines where you begin to search for. It's empty when raise your first request. |
| page_size | int | N | 50 | The value of "page_size" must be greater than 0 and less than or equal to 50. |
| Default 20 |
§6 Request Body Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| application_statuses | []string | N | ["PENDING","AWAITING_SHIPMENT"] | 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.
- DEL_OPEN_COLLAB: Open collaboration has been deleted.
- 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. |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/affiliate_creator/202412/sample_applications/search?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&page_token=87712341234&page_size=50
Body
{"application_statuses":["PENDING","AWAITING_SHIPMENT"]}
§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 | |
| ^next_page_token | string | aDU2dHIzMlFhME5CUzJKUDhDdVJhTDM1WmJkeFVTVW9LTkRaSnNaZCtuWjJXVU5CSDhlaA== | Page token to query next page orders, last page is empty string. |
| ^sample_applications | []object | The sample application information. | |
| ^^id | string | 8070590921506065183 | The unique id of sample application. |
| ^^sample_product | object | The sample product information. | |
| ^^^id | string | 1729432087292775344 | The product identifier. |
| ^^^sku_id | string | 1729480364147774364 | The SKU identifier. |
| ^^^sku_sale_property_value_names | []string | red, large size | The SKU property value name. |
| ^^main_order_id | string | 13444222 | The sample order is generated after the sample application is approved by seller. |
| ^^activity_id | string | 13456677 | The sample activity identifier id(only for sample activity). |
| ^^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.
- 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.
- FULFILLMENT_SUSPEND: the application fulfillment was paused due to the product status being unpromotable.
- DEL_OPEN_COLLAB: Open collaboration has been deleted.
- 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.
- TO_BE_POST: the creator has not posted videos/lives for this sample
- POST_IN_REVIEW: the creator has posted videos/lives which have not satisfied fulfillment rules.
- POST_FAILED: the creator has posted videos/lives and deleted them before completing sample fulfillment.
- CANCELED: this application(order) has been canceled. This field allows 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 |123456 |Fulfillment ID. | ^^^expiration_time |int |1726301400 |Fulfillment deadline timestamp, in seconds. | ^^^total_suspend_duration |int |123 |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. | ^^^bound_product_status |string |LIVE |Represents the marketing status of a product associated with a fulfillment order. It indicates whether the product is available for marketing and fulfillment. The possible values are:
- UNKNOWN: The marketing status of the product is unknown.
- LIVE: The product is available and can be used 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. This field helps sellers and creators understand the current status of products associated with fulfillment orders, ensuring that all parties are aware of the availability and marketing status of the products involved in sample applications and collaborations. |
§9 Response Sample
{"code":0,"data":{"next_page_token":"aDU2dHIzMlFhME5CUzJKUDhDdVJhTDM1WmJkeFVTVW9LTkRaSnNaZCtuWjJXVU5CSDhlaA==","sample_applications":[{"id":"8070590921506065183","sample_product":{"id":"1729432087292775344","sku_id":"1729480364147774364","sku_sale_property_value_names":"red, large size"},"main_order_id":"13444222","activity_id":"13456677","status":"Pending","creator_fulfillment":{"id":"123456","expiration_time":1726301400,"total_suspend_duration":123,"status":"PENDING","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 |
|---|