POST Seller Search Affiliate Open Collaboration Product

Seller Search Affiliate Open Collaboration Product Shop Required scope: seller.affiliate_collaboration.read This API is used to search the information of products with open collaboration by category, commission rate, and keywords. It will return all products on the TikTok Shop Affiliate Product Marketplace that are in an open collaboration. Sellers can only search for open collaboration within the regions they are registered to sell in. Version 202405

POST/affiliate_seller/202405/open_collaborations/products/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.
sort_order	string	The sort order for the sort_field parameter. Default: ASCPossible values:- ASC: Ascending order- DESC: Descending order
sort_field	string	The returned results will be sorted by the specified field. See the description of the field values in the request body for more information about each field.Default: commission_ratePossible values:- commission_rate- product_sales_price- commission- units_sold
page_token	string	An opaque token used to retrieve the next page of a paginated result set. Retrieve this value from the result of the next_page_token from a previous response. It is not needed for the first page.
page_size Required	int	The number of results to be returned per page. Valid range: [1-20].
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
title_keywords	[]string	A list of product keywords. Product titles, or names, are loosely matched. Keywords in the list form a query and the resulting set of matching product names is based on the conjunctive operator AND between each keyword. For example, the keyword list ["Men", "Fashion"] creates a query "Men" AND "Fashion" and the resulting set of matching product names contains the loosely matched conjuction of "Men" and "Fashion" such as "Male Fashionable". Maximum length of the list is 20 keywords. Maximum keyword string length is 255 characters.
sales_price_range	object	Restricts the products in the search results to those with prices greater than or equal to the expressed minimum price and less than the expressed maximum price
category	object	Restricts the products in the search results to those that are associated with the expressed product category.
commission_rate_range	object	Restricts products in the search results to those with a commision rate greater than the expressed minimum commission rate and less than the expressed maximum commission rate.

Example

CurlGoNode.jsJavaEnable word wrap

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

Error Code

View common error codes

| Code | Message | | --- | --- | | Empty. No business logic error codes. |

Is this content helpful?Helpful

Not Helpful

PreviousNext