Skip to main content

POST Seller Search Sample Applications Fulfillments

Seller Search Sample Applications Fulfillments Shop Required scope: seller.affiliate_collaboration.read 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. Version 202409

POST/affiliate_seller/202409/sample_applications/{application_id}/fulfillments/search

Request

Path

PropertiesTypeDescription
application_id RequiredstringThe application identifier.

Header

PropertiesTypeDescription
content-type RequiredstringAllowed type: application/json
x-tts-access-token RequiredstringThe seller access_token value from Get Access Token, when user_type = 0. Follow this guide to get seller access_token.

Query

PropertiesTypeDescription
app_key RequiredstringEvery single app will have a unique key. Please use the specific key assigned to your app.
sign RequiredstringSignature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders.
timestamp RequiredintUnix timestamp GMT (UTC+00:00). This timestamp is used across all API requests. Developers can use this convert to local time.
shop_cipher RequiredstringUse 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

PropertiesTypeDescription
content_formatstringThe content type generated by the creator after receiving the samples. Possible enumerations: - LIVE- VIDEO

Example

CurlGoNode.jsJavaEnable word wrap

1234567curl-X POST 'https://open-api.tiktokglobalshop.com/affiliate_seller/202409/sample_applications/123456789/fulfillments/search?timestamp=1623812664&app_key=38abcd&shop_cipher=GCP_XF90igAAAABh00qsWgtvOiGFNqyubMt3&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c' -H 'x-tts-access-token: TTP_pwSm2AAAAABmmtFz1xlyKMnwg74T2GJ5s0uQbS8jPjb_GkdFVCxPqzQXSyuyfXdQa0AqyDsea2tYFNVf4XeqgZHFfPyv0Vs659QqyLYfsGzanZ5XZAin3_ZkcIxxS0_In6u6XDeU96k' -H 'content-type: application/json' -d '{ "content_format": "LIVE"}'

Response Parameters

PropertiesTypeDescription
codeintThe success or failure status code returned in API response.
messagestringThe success or failure messages returned in API response. Reasons of failure will be described in the message.
request_idstringRequest log
dataobjectSpecific return information

Example

JSONEnable word wrap

{"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}}

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