Skip to main content

POST Create Open Collaboration

Create Open Collaboration Shop Required scope: seller.affiliate_collaboration.write This API allows the seller to create an open collaboration. You create an open collaboration by selecting products and setting a commission rate. Version 202412

POST/affiliate_seller/202412/open_collaborations

Request

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
product_id RequiredstringThe product ID for adding to the affiliate open collaboration.
commission_rate RequiredintThe desired commission rate for the open collaboration. The desired commission rate is expressed in hundredths of a percent. For example, 3587 is a commission rate of 35.87%. This value must a minimum of 100.

Example

CurlGoNode.jsJavaEnable word wrap

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

Error Code

View common error codes

| Code | Message | | --- | --- | | 16003012 | An open collaboration containing this product already exists. | | 16003025 | The seller's account is deactivated. | | 16003033 | The commission rate must be between 1% and 80%. | | 16003035 | One or more of the products you are trying to add are currently restricted by the platform. | | 16603010 | The seller is currently restricted by the platform. |

Is this content helpful?Helpful

Not Helpful

PreviousNext