stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存,可追溯
- 官方原文可核对
资料正文
§1 Path: /affiliate_seller/202508/sample_applications/search
#§2 Method: [POST]
#§3 Function Description
This API is provided for sellers to query sample applications based on various criteria such as products, creators, or application statuses. By using this API, sellers can retrieve detailed information about sample application records, including the creator's information and the specifics of each application.
§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 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 | b2Zmc2V0PTAK | 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. |
§6 Request Body Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| product_id | string | N | 123456 | The unique identifier of a product. It is used to specify which product's sample application details are being queried. |
| title | string | N | product name | Product name, supports fuzzy search queries. It allows sellers to search for products by name when managing sample applications. |
| creator_user_oepn_id | string | N | 123456 | TikTok User ID of a creator |
| username | string | N | test_tt_name | TikTok User Name of a creator, supports fuzzy search |
| target_collabration_id | string | N | 123456 | The unique ID generated after creating a target collaboration. |
| order_id | string | N | 123456 | Main order ID associated with a sample order when the sample application is approved by seller. |
| status | string | N | 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.
- 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_seller/202508/sample_applications/search?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY&page_token=b2Zmc2V0PTAK&page_size=50
Body
{"product_id":"123456","title":"product name","creator_user_oepn_id":"123456","username":"test_tt_name","target_collabration_id":"123456","order_id":"123456","status":"PENDING"}
§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 |
| ^total_count | int | 100 | total count |
| ^sample_applications | []object | The sample applications from creators | |
| ^^id | string | 123456 | The unique id of sample request application ID |
| ^^commission_rate | string | 0.1 | The commission rate for this product is set by merchants for creators. |
- The range of this value is [0.01, 0.8]. | ^^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.
- DEL_OPEN_COLLAB: The open collaboration plan 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 finished creating the content. | ^^order_id |string |123456 |The sample order is generated after the sample application is approved by seller | ^^available_quantity |int |50 |The remaining stock quota of a sample product. | ^^approve_expiration_time |int |1728674995 |The expire time for a seller to approve a sample application. | ^^shipment_expiration_time |int |1728674995 |The deadline for a seller to ship a sample for a sample application. | ^^tracking_number |string |123456 |The logistics tracking number for the sample application order | ^^fulfillment_status |string |ONGOING |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. | ^^is_approvable |bool |true |The sample application can be approved or not. | ^^disapprovable_reasons |[]string |["Product out of stock"] |The reasons why can not approve the sample application | ^^partner_name |string |ABC |The name of the partner if the sample application is submitted on behalf of a creator by an agency. It is only populated when an agency handles the application process instead of the creator directly. | ^^creator |object | |Creator detailed information. It includes various details such as the creator's TikTok user name, TikTok user id, and performance metrics related to creator e-commerce activities, such as sales, fulfillment rates, and other relevant statistics. | ^^^creator_open_id |string |uACafQAAAABmUU2qon4R0vUYvUVS3QC6CICP2m5A2-wd77j8R9G0yg |Creator Open ID. More details | ^^^username |string |test.name |TikTok User Name of a creator | ^^^nickname |string |Test Name |TikTok Nick Name of a creator | ^^^follower_count |int |200 |The number of creator's followers | ^^^avatar_url |string |https://p16-sign-va.tiktokcdn.com/tos-maliva-avt-0068xxxxx |The URL of the creator's avatar image | ^^^gmv |object | |GMV generated by a creators' shoppable content over the past 30 days. It is formatted as a floating-point number with a currency symbol (e.g., "$1234.56"). If the creator has not authorized the disclosure of this information, the field returns an empty string. | ^^^^amount |string |500 |GMV amount | ^^^^currency |string |USD |currency | ^^^content_count |int |4 |The number of contents a creator has posted in the last 30 days. It is formatted as an integer. If the creator has not authorized the sharing of this information, the field returns an empty string. | ^^^fulfillment_percentage |string |60.50 |Sample fulfillment rate of a creator received sample from seller over the past 90 days, formatted as a floating-point percentage with two decimal places (e.g., "60.85%"). If the creator has not authorized the disclosure of this information, the field returns an empty string. | ^^^ec_video_view |int |1200 |The median number of creators' shoppable video views over the past 30 days. If the creator has not authorized the sharing of this information, the field returns an empty string. | ^^product |object | |product information | ^^^id |string |123456 |The product identifier. | ^^^title |string |A women dress |The product name of the product. | ^^^sku_id |string |123456 |The unique id of product sku which creator apply for as sample. | ^^^sku_image_url |string |https://p16-oec-va.ibyteimg.com/tos-malivaxxxxx |The URL of SKU image. | ^^^sku_name |string |Soft Cover |The description of sku |
§9 Response Sample
{"code":0,"data":{"next_page_token":"aDU2dHIzMlFhME5CUzJKUDhDdVJhTDM1WmJkeFVTVW9LTkRaSnNaZCtuWjJXVU5CSDhlaA==","total_count":100,"sample_applications":[{"id":"123456","commission_rate":"0.1","status":"PENDING","order_id":"123456","available_quantity":50,"approve_expiration_time":1728674995,"shipment_expiration_time":1728674995,"tracking_number":"123456","fulfillment_status":"ONGOING","is_approvable":true,"disapprovable_reasons":["Product out of stock"],"partner_name":"ABC","creator":{"creator_open_id":"uACafQAAAABmUU2qon4R0vUYvUVS3QC6CICP2m5A2-wd77j8R9G0yg","username":"test.name","nickname":"Test Name","follower_count":200,"avatar_url":"https://p16-sign-va.tiktokcdn.com/tos-maliva-avt-0068xxxxx","gmv":{"amount":"500","currency":"USD"},"content_count":4,"fulfillment_percentage":"60.50","ec_video_view":1200},"product":{"id":"123456","title":"A women dress","sku_id":"123456","sku_image_url":"https://p16-oec-va.ibyteimg.com/tos-malivaxxxxx","sku_name":"Soft Cover"}}]},"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. |
