POST Create Target Collaboration
Create Target Collaboration Shop Required scope: seller.affiliate_collaboration.write This API is used to create a target collaboration. A target collaboration is a collaboration between a seller selected set of products (including a commission payout) and a set of creators the seller has added (invited) to the collaboration. Target collaborations are private and not visible in the Creator Marketplace to all creators; they are only visible to those that have been added to the collaboration. Version 202508
POST/affiliate_seller/202508/target_collaborations
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. |
| 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 |
|---|---|---|
| name Required | string | The name of the target collaboration. |
| message | string | The message sent to creators associated with the target collaboration. |
| end_time Required | string | The date at which the target collaboration ends, in Unix epoch time. |
| products Required | []object | A list of metadata and data for the products provided by the seller for target collaboration. Maximum length of the list is 100 products. |
| creator_user_open_ids Required | []string | Maximum length of the list is 50 user open identifiers. Creator Open ID. More details |
| seller_contact_info Required | object | Metadata and data associated with the seller contact information. |
| free_sample_rule Required | object | A set of properties that control the free sample behavior for the product. |
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 | | --- | --- | | 16024004 | test account and non test account can not cross invite | | 16024006 | The seller cannot invite their official creator. | | 16024008 | There are products that do not belong to this merchant. | | 16024016 | The invitation failed because the creator is already linked with a shop account. | | 16024019 | in sufficient quota to create invitation | | 16024020 | remove excluded creators to create invitation | | 16024021 | invitation contains creator exceed follower limit | | 16024022 | This invitation has exist creator and product, please check conflict pair. | | 50001702 | Your invitation target contains an unavailable creator or product. Please check your request params.Remove the unavailable creator or product id and try again. | | 50001703 | The request parameters contain sensitive words. | | 36009003 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. | | 98001004 | Parameter {param_name} is invalid. Reason: {reason}. Expected: {expected_value} |
Is this content helpful?Helpful
Not Helpful
PreviousNext