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.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”Identifies the shop. Obtain it from the Get Authorized Shops API.
Request Bodyrequired
Section titled “Request Bodyrequired”object
The name of the target collaboration.
The message sent to creators associated with the target collaboration.
The date at which the target collaboration ends, in Unix epoch time.
A list of metadata and data for the products provided by the seller for target collaboration. Maximum length of the list is 100 products.
object
The product identifier.
The desired commission rate for the target 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.
The commission rate applies only to orders generated from ads. If a creator’s video is used as an ad without this rate being set, the resulting orders will instead earn either:
- The Shop Ads commission you configured in open collaboration, or
- The standard commission defined in this invitation. The commission rate is specified in increments of 1/10,000. For example, 1000 stands for 0.1 or 10%.
Maximum length of the list is 50 user open identifiers. Creator Open ID. More details
Metadata and data associated with the seller contact information.
object
The seller’s email address.
The phone number of the seller.
The phone number used by the seller to register for WhatsApp.
The seller’s Telegram username or phone number.
The phone number used by the seller to register for the Line app.
A set of properties that control the free sample behavior for the product.
object
If set to true, free samples are provided to creators invited to the target collaboration group. If set to false, free samples are not provided.
If set to true, creators invited to the target collaboration are exempt from seller review and are automatically approved for a free product sample. Note that the has_free_sample property overrides the free sample behavior.
Preferred creator content type, “LIVE” or “VIDEO”
Example
{ "name": "openapi_test", "message": "this is a message", "end_time": "1715654330", "products": [ { "id": "789078671231312312", "target_commission_rate": 1000, "shop_ads_commission_rate": 1000 } ], "creator_user_open_ids": [ "uACafQAAAABmUU2qon4R0vUYvUVS3QC6CICP2m5A2-wd77j8R9G0yg" ], "seller_contact_info": { "email": "test@tiktokshop.com", "phone_number": "1234567890", "whatsapp": "1234567890", "telegram": "1234567890", "line": "1234567890" }, "free_sample_rule": { "has_free_sample": true, "is_sample_approval_exempt": true }, "preferred_content_type": "LIVE"}Responses
Section titled “Responses”Success
object
Status code; 0 means success.
Success or failure message.
Request log ID.
object
The target collaboration.
object
The target collaboration identifier.
A list of user and product identifiers with target collaboration conflicts that caused target collaboration failure.
object
Creator Open ID. More details
The product identifier.
The list of open id that caused the create to fail.
The list of product id that caused the create to fail.
The create time of the target collaboration.
Example
{ "code": 0, "data": { "target_collaboration": { "id": "7365861555575916210" }, "target_collaboration_conflicts": [ { "creator_user_open_id": "uACafQAAAABmUU2qon4R0vUYvUVS3QC6CICP2m5A2-wd77j8R9G0yg", "product_id": "789078671231" } ], "invalid_open_id_list": [ "xxxx" ], "invalid_product_id_list": [ "1234" ], "create_time": 1715654330 }, "message": "Success", "request_id": "202203070749000101890810281E8C70B7"}