POST Seller Search Sample Applications
Seller Search Sample Applications Shop Required scope: seller.affiliate_collaboration.read 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. Version 202508
POST/affiliate_seller/202508/sample_applications/search
Request
Header
| Properties | Type | Description |
|---|---|---|
| content-type Required | string | Allowed type: application/json |
| x-tts-access-token Required | string | The seller access_token value from Get Access Token, when user_type = 0. Follow this guide to get seller access_token. |
Query
| Properties | Type | Description |
|---|---|---|
| app_key Required | string | Every single app will have a unique key. Please use the specific key assigned to your app. |
| sign Required | string | Signature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders. |
| timestamp Required | int | 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 | Pagination offset determines where you begin to search for. It's empty when raise your first request. |
| page_size | int | The value of "page_size" must be greater than 0 and less than or equal to 50. |
| shop_cipher Required | string | 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 |
Body
| Properties | Type | Description |
|---|---|---|
| product_id | string | The unique identifier of a product. It is used to specify which product's sample application details are being queried. |
| title | string | Product name, supports fuzzy search queries. It allows sellers to search for products by name when managing sample applications. |
| creator_user_oepn_id | string | TikTok User ID of a creator |
| username | string | TikTok User Name of a creator, supports fuzzy search |
| target_collabration_id | string | The unique ID generated after creating a target collaboration. |
| order_id | string | Main order ID associated with a sample order when the sample application is approved by seller. |
| status | string | 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. |
Example
CurlGoNode.jsJavaEnable word wrap
12345678910111213curl-X POST 'https://open-api.tiktokglobalshop.com/affiliate_seller/202508/sample_applications/search?app_key=38abcd&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1623812664&shop_cipher=GCP_XF90igAAAABh00qsWgtvOiGFNqyubMt3&page_token=b2Zmc2V0PTAK&page_size=50' -H 'x-tts-access-token: TTP_pwSm2AAAAABmmtFz1xlyKMnwg74T2GJ5s0uQbS8jPjb_GkdFVCxPqzQXSyuyfXdQa0AqyDsea2tYFNVf4XeqgZHFfPyv0Vs659QqyLYfsGzanZ5XZAin3_ZkcIxxS0_In6u6XDeU96k' -H 'content-type: application/json' -d '{ "product_id": "123456", "title": "product name", "creator_user_oepn_id": "123456", "username": "test_tt_name", "target_collabration_id": "123456", "order_id": "123456", "status": "PENDING"}'
Response Parameters
| Properties | Type | Description |
|---|---|---|
| code | int | The success or failure status code returned in API response. |
| message | string | The success or failure messages returned in API response. Reasons of failure will be described in the message. |
| request_id | string | Request log |
| data | object | Specific return information |
Example
JSONEnable word wrap
{"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",
Error Code
View common error codes
| Code | Message | | --- | --- | | 36009003 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. |
Is this content helpful?Helpful
Not Helpful
PreviousNext