This API is used by sellers to update a STANDARD target collaboration. A successful response can still report creators or products that were not updated. Check data.update_failed and data.target_collaboration_conflicts before treating the update as complete.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The unique id of specific target collaboration.
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 end time of the target collaboration, as a Unix timestamp in seconds.
The information about the products provided by the seller for target collaboration with creators in the target collaboration. The maximum number of products is 100. When a product is deleted from the product list, if the deleted product has been added to the showcase by the creator, it will take effect at 0:00 the next day, otherwise it will take effect immediately.
object
The product identifier.
The desired commission rate for the target collaboration. The value is measured in ten thousandths. For example, 3587 means the commission fee equals 35.87% of the original price. The range is [100, 8000]. Increasing product commissions will take effect immediately, while reducing product commissions will take effect at 00:00 the next day if the current product has been added to the showcase by a creator, otherwise it will take effect immediately.
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%.
The list of Creators’ TikTok User Open IDs invited in the target collaboration. The maximum number of creators is 50. More details
Contact information for the seller in the target collaboration.
object
Seller’s email contact information
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
The free sample rules set by the seller in the target collaboration.
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.
Example
{ "name": "openapi_test", "end_time": "1715654330", "products": [ { "id": "789078671231312312", "commission_rate": 1000, "target_ad_commission_rate": 1000 } ], "creator_user_open_ids": [ "123123213213" ], "seller_contact_info": { "email": "test@bytedance.com", "phone_number": "1234567890", "whatsapp": "1234567890", "telegram": "1234567890", "line": "1234567890" }, "free_sample_rule": { "has_free_sample": true, "is_sample_approval_exempt": true }}Responses
Section titled “Responses”Success
object
Status code; 0 means success.
Success or failure message.
Request log ID.
object
A list of creators and products with target collaboration conflicts that caused target collaboration update failure.
object
Creator Open ID. More details
The product identifier.
Describe which fields were not updated successfully.
object
The list of creators’ TikTok User Open IDs that have not been successfully removed. More details:https://partner.tiktokshop.com/docv2/page/3obfokj6
The list of product ids that have not been successfully removed.
The list of creators’ TikTok User Open IDs that have not been successfully added. More details:https://partner.tiktokshop.com/docv2/page/3obfokj6
The list of products that have not been successfully added.
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 be a minimum of 1000.
The list of commission information that has not been successfully changed.
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 be a minimum of 1000.
The end time of the target collaboration, which has not been successfully updated.
Contact information for the seller in the target collaboration which has not been successfully updated.
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.
The name of the target collaboration.
The list of product id that caused the update to fail.
The list of open id that caused the update to fail.
Example
{ "code": 0, "data": { "target_collaboration_conflicts": [ { "creator_user_open_id": "7494656937121841111", "product_id": "789078671231" } ], "update_failed": { "remove_creator_open_ids": [ "12345" ], "remove_product_ids": [ "12345" ], "add_creator_open_ids": [ "12345" ], "add_products": { "id": "789078671231312312", "commission_rate": 1000 }, "change_commissions": { "product_id": "789078671231312312", "commission_rate": 1000 }, "end_time": 1715654330, "seller_contact_info": { "email": "test@bytedance.com", "phone_number": "(+62) 1234567890\n", "whatsapp": "(+62) 1234567890\n", "telegram": "(+62) 1234567890\n", "line": "(+62) 1234567890\n" }, "name": "openapi_test", "invalid_product_id_list": [ "1234" ], "invalid_open_id_list": [ "xxxxxx" ] } }, "message": "Success", "request_id": "202203070749000101890810281E8C70B7"}