POST Search Open Collaboration

Search Open Collaboration Shop Required scope: seller.affiliate_collaboration.read Retrieve all open collaboration information from merchants, including commission rate, add to showcase and post content creator count. Version 202412

POST/affiliate_seller/202412/open_collaborations/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 you raise your first request.
page_size Required	int	The value of "page_size" must be greater than 0 and less than or equal to 100.
sort_order	string	Default value of "sort_order" is DESC.Enum:- ASC：means to sort data in ascending order- DESC：means to sort data in descending order
sort_field	string	Some sorting fields are as follows:- product_original_price: sort by products' original price.By default, the open collaborations are sorted in descending order by creation time.
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
keyword_type	string	Pass in the parameter type which you use to query open collaborations. You can query based on:- PRODUCT_ID：If you use PRODUCT_ID to search, you can search for open collaboration information for a specified product ID.- PRODUCT_NAME: If you use PRODUCT_NAME to search, you can fuzzy search for open collaboration information involving related product names.
keyword	string	Search based on the product name or product ID. Pass in the appropriate value based on the keyword_type above.
top_level_category_id	string	The category of the searched product needs to be limited in this param.Prerequisites:- The value of field category_id must be greater than 0.- Currently, it only supports first-level categories

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