stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /affiliate_seller/202508/target_collaborations/{target_collaboration_id}
#§2 Method: [GET]
#§3 Function Description
This API is used by Sellers to get target collaboration information.
§4 Common Parameters
For common parameters, refer to How to call TikTok Shop APIs - Common Parameters
| Properties | Location | Type | Require | Sample | Properties description |
|---|---|---|---|---|---|
| shop_cipher | query | string | Y | GCP_XF90igAAAABh00qsWgtvOiGFNqyubMt3 | 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 | |||||
| content-type | header | string | Y | application/json | Allowed type: application/json |
§5 Request Path Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| target_collaboration_id | string | Y | 1234 | The ID of the target collaboration |
§6 Request Query Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| app_key | string | Y | 38abcd | Every single app will have a unique key. Please use the specific key assigned to your app. |
| sign | string | Y | 5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c | Signature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders. |
| timestamp | int | Y | 1623812664 | Unix timestamp GMT (UTC+00:00). This timestamp is used across all API requests. Developers can use this convert to local time. |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/affiliate_seller/202508/target_collaborations/1234?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY
§8 Response Parameters
| Properties | Type | Sample | Properties description |
|---|---|---|---|
| code | int | 0 | The success or failure status code returned in API response. |
| message | string | Success | The success or failure messages returned in API response. Reasons of failure will be described in the message. |
| request_id | string | 202203070749000101890810281E8C70B7 | Request log |
| data | object | Specific return information | |
| ^target_collaboration | object | Target Collaboration detail. | |
| ^^id | string | 789078671231123124 | Target collaboration ID. |
| ^^name | string | target_collaboration | Target collaboration name. |
| ^^message | string | test | Message seller has sent to creators about seller's introduction and why excited to collaborate. |
| ^^seller_contact_info | object | Contact information for the seller in the target collaboration. | |
| string | test@bytedance.com | Seller's email contact information. | |
| ^^^phone_number | string | 1234 | The phone number of the seller. |
| string | aaaa | The phone number used by the seller to register for WhatsApp. | |
| ^^^telegram | string | 1234 | The seller's Telegram username or phone number. |
| ^^^line | string | asd | The phone number used by the seller to register for the Line app |
| ^^start_time | int | 1715654330 | The start time of the target collaboration. |
| ^^end_time | int | 1715654330 | The end time of the target collaboration. |
| ^^update_time | int | 1715654330 | The update time of the target collaboration. |
| ^^creator_invited_count | int | 10 | The count of creators invited in the target collaboration. |
| The count will only include the NORMAL state. | |||
| ^^showcase_creator_count | int | 2 | This field indicates the number of creators who added the product to the showcase from target collaboration. |
| The count will only include the NORMAL state. | |||
| ^^content_creator_count | int | 1 | The number of creators who posted content featuring products from target collaboration. |
| The count will only include the NORMAL state. | |||
| ^^product_count | int | 30 | The count of products added in the target collaboration. |
| The count will only include the NORMAL state. | |||
| ^^free_sample_rule | object | The free sample rules set by the seller in the target collaboration. | |
| ^^^has_free_sample | bool | true | If true, free samples are provided to creators invited to the target collaboration group. |
| ^^^is_sample_approval_exempt | bool | true | If true, creators invited to the target collaboration are exempt from seller review and will automatically be approved for a free sample. |
| Note that if has_free_sample=false, this field will not take effect. | |||
| ^^products | []object | The information of products in the target collaboration. | |
| ^^^id | string | 789078671231312312 | The product identifier. |
| ^^^main_image_url | string | https://p16-sign-useast2a.tiktokcdn.com/tos-useast2a/12345~c5_168x168.webp?lk3s=a5d48078\u0026nonce=49646\u0026refresh_token=b53364a3a1947c4ac7a0c4bea62e31ea\u0026x-expires=1727175600\u0026x-signature=ASPIxFDNDkN1cknLEItlyC%2Bcfbw%3D\u0026shp=a5d48078\u0026shcp=39dffb78 | The product image url. |
| ^^^title | string | Christmas Gift | The product name. |
| ^^^original_price | object | The original price of the product. | |
| ^^^^currency | string | USD | The currency code. |
| ^^^^minimum_amount | string | 12.21 | The lowest original price of all SKUs of the product. |
| ^^^^maximum_amount | string | 100.00 | The highest original price of all SKUs of the product. |
| ^^^commission | object | Commission info. | |
| ^^^^rate | int | 3000 | The commission rate in hundredths of a percent. For example, 3587 is a commission rate of 35.87%. This value must a minimum of 1000. The range of this value is [100, 8000]. |
| ^^^^effective_time | string | 1715654330 | Commission effective time. It is a timestamp. |
| ^^^^currency | string | USD | The currency code. |
| ^^^^minimum_amount | string | 34.3 | The minimum estimated commission amount for all SKUs of this product. |
| ^^^^maximum_amount | string | 55.7 | The maximum estimated commission amount for all SKUs of this product. |
| ^^^^shop_ads_commission_rate | int | 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%. | ^^^status |string |LIVE |Product's status. Field values:
- LIVE: When the product is normal for sale, return to the LIVE status
- OUT_OF_STOCK: When the product is out of stock for the consumer, the OUT_OF_STOCK state is returned
- SELLER_DEACTIVATE: When the product is deactivated by the merchant, the SELLER_DEACTIVATE status is returned
- PLATFORM_DEACTIVATE: When the product is deactivated by the platform or is not available for sale, the PLATFORM_DEACTIVATE status is returned
- GNE_REJECT: When the product is governed or the target collaboration is dismissed, the GNE_REJECT state is returned
- DELETE: When the product is deleted, the DELETE status is returned
- OTHER: When the product is in an unsaleable state, such as draft, frozen, review, etc, the OTHER status is returned | ^^^commission_effective_status |string |EFFECTIVE_ALL |The effectiveness of the creators' commissions and products. Field values:
- EFFECTIVE_ALL: The current product commission is effective for all creators.
- EFFECTIVE_PARTIALLY: The current product commission are effective for some creators.
- EFFECTIVE_NONE: The current product commission is not effective for all creators. Normally, the commission for a product will be the same for all creators. If the merchant participates in TOP_CREATOR_PROGRAM, and TOP_CREATOR_PROGRAM includes the current product and some creators, the commission rate will be based on TOP_CREATOR_PROGRAM. The product commission under the current Target Collaboration will be effective for some creators, corresponding to EFFECTIVE_PARTIALLY status. | ^^^collaboration_status |string |NORMAL |The status of the product in the current target cooperation. Field values:
- NORMAL: The status of the product in the current target collaboration is normal.
- DELETING: The status of the product in the current target collaboration is deleting.Product in the DELETING state will end their delayed effectiveness state and move to the DELETED state at 00:00 the next day.
- DELETED: The status of the product in the current target collaboration is deleted. | ^^creators |[]object | |The information of creators in the target collaboration. | ^^^username |string |123456 |The TikTok user name. | ^^^nickname |string |123456 |The TikTok nick name. | ^^^avatar |object | |Data associated with the TikTok creator's profile avatar. | ^^^^url |string |https://p16-sign-useast2a.tiktokcdn.com/tos-useast2a-avt-0068-giso/2bf6a2485ec8bf93483e4a6ed907e6fd~c5_720x720.webp?lk3s=a5d48078\u0026x-expires=1712988000\u0026x-signature=E8US22KfUCwKz0R%2FMFF6%2FMOmogs%3D |The URL for the TikTok creator's avatar image file. | ^^^selection_region |string |US |The regions in which the creator is eligible to promote products in showcases, videos, and live streams. | ^^^showcase_product_count |int |2 |This field indicates the number of products creator has added to the showcase from target collaboration. The count includes NORMAL and DELETING states. | ^^^content_product_count |int |1 |This field indicates the number of products creator has posted video or live from target collaboration. The count includes NORMAL and DELETING states. | ^^^collaboration_status |string |NORMAL |The status of the creator in the current target cooperation. Field values:
- NORMAL: The status of the creator in the current target collaboration is normal.
- DELETING: The status of the creator in the current target collaboration is deleting.The creator's product promotion relationship in the DELETING status will end the delayed effectiveness status and flow to the DELETED status at 00:00 the next day.
- DELETED: The status of the creator in the current target collaboration is deleted. | ^^^product_effective_status |string |EFFECTIVE_ALL |The effectiveness of the creators' commissions and products. Field values:
- EFFECTIVE_ALL: The current product commission is effective for all creators.
- EFFECTIVE_PARTIALLY: The current product commission are effective for some creators.
- EFFECTIVE_NONE: The current product commission is not effective for all creators. Normally, the commission rate for all products under Target Collaboration is effective. If the merchant participates in TOP_CREATOR_PROGRAM, and TOP_CREATOR_PROGRAM includes the current creator and some products, the commission rate will be based on TOP_CREATOR_PROGRAM. The products' commission under the current Target Collaboration will only be partially effective for the creator, corresponding to EFFECTIVE_PARTIALLY status. | ^^^creator_open_id |string |uACafQAAAABmUU2qon4R0vUYvUVS3QC6CICP2m5A2-wd77j8R9G0yg |Creator Open ID. More details | ^^type |string |STANDARD |The type of target collaboration. Field values:
- STANDARD: The target collaboration is created by sellers manually selecting products and creators.
- TOP_CREATOR_PROGRAM: The target collaboration created by seller joining TikTok Shop Top Creator Program, requiring only product submission. |
§9 Response Sample
{"code":0,"data":{"target_collaboration":{"id":"789078671231123124","name":"target_collaboration","message":"test","seller_contact_info":{"email":"test@bytedance.com","phone_number":"1234","whatsapp":"aaaa","telegram":"1234","line":"asd"},"start_time":1715654330,"end_time":1715654330,"update_time":1715654330,"creator_invited_count":10,"showcase_creator_count":2,"content_creator_count":1,"product_count":30,"free_sample_rule":{"has_free_sample":true,"is_sample_approval_exempt":true},"products":[{"id":"789078671231312312","main_image_url":"https://p16-sign-useast2a.tiktokcdn.com/tos-useast2a/12345~c5_168x168.webp?lk3s=a5d48078\\u0026nonce=49646\\u0026refresh_token=b53364a3a1947c4ac7a0c4bea62e31ea\\u0026x-expires=1727175600\\u0026x-signature=ASPIxFDNDkN1cknLEItlyC%2Bcfbw%3D\\u0026shp=a5d48078\\u0026shcp=39dffb78","title":"Christmas Gift","original_price":{"currency":"USD","minimum_amount":"12.21","maximum_amount":"100.00"},"commission":{"rate":3000,"effective_time":"1715654330","currency":"USD","minimum_amount":"34.3","maximum_amount":"55.7","shop_ads_commission_rate":100},"status":"LIVE","commission_effective_status":"EFFECTIVE_ALL","collaboration_status":"NORMAL"}],"creators":[{"username":"123456","nickname":"123456","avatar":{"url":"https://p16-sign-useast2a.tiktokcdn.com/tos-useast2a-avt-0068-giso/2bf6a2485ec8bf93483e4a6ed907e6fd~c5_720x720.webp?lk3s=a5d48078\\u0026x-expires=1712988000\\u0026x-signature=E8US22KfUCwKz0R%2FMFF6%2FMOmogs%3D"},"selection_region":"US","showcase_product_count":2,"content_product_count":1,"collaboration_status":"NORMAL","product_effective_status":"EFFECTIVE_ALL","creator_open_id":"uACafQAAAABmUU2qon4R0vUYvUVS3QC6CICP2m5A2-wd77j8R9G0yg"}],"type":"STANDARD"}},"message":"Success","request_id":"202203070749000101890810281E8C70B7"}
§10 Error Code
For common error codes, refer to How to call TikTok Shop APIs - Common Error Code
| Code | Message |
|---|---|
| 50001700 | seller cannot access this target collaboration |
| 36009003 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. |