Skip to content
TikTok Shop Partner API

Query Target Collaboration Detail

GET
/affiliate_seller/202508/target_collaborations/{target_collaboration_id}

This API is used by Sellers to get target collaboration information.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
target_collaboration_id
required
string

The ID of the target collaboration

Query Parameters

Section titled “Query Parameters”
shop_cipher
required
string

Identifies the shop. Obtain it from the Get Authorized Shops API.

Responses

Section titled “Responses”

200

Section titled “200”

Success

Media typeapplication/json
object
code

Status code; 0 means success.

integer format: int64
message

Success or failure message.

string
request_id

Request log ID.

string
data
object
target_collaboration

Target Collaboration detail.

object
id

Target collaboration ID.

string
name

Target collaboration name.

string
message

Message seller has sent to creators about seller’s introduction and why excited to collaborate.

string
seller_contact_info

Contact information for the seller in the target collaboration.

object
email

The seller’s email address.

string
phone_number

The phone number of the seller.

string
whatsapp

The phone number used by the seller to register for WhatsApp.

string
telegram

The seller’s Telegram username or phone number.

string
line

The phone number used by the seller to register for the Line app.

string
start_time

The start time of the target collaboration, as a Unix timestamp in seconds.

integer format: int64
end_time

The end time of the target collaboration, as a Unix timestamp in seconds.

integer format: int64
update_time

The update time of the target collaboration, as a Unix timestamp in seconds.

integer format: int64
creator_invited_count

The count of creators invited in the target collaboration. The count will only include the NORMAL state.

integer format: int64
showcase_creator_count

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.

integer format: int64
content_creator_count

The number of creators who posted content featuring products from target collaboration. The count will only include the NORMAL state.

integer format: int64
product_count

The count of products added in the target collaboration. The count will only include the NORMAL state.

integer format: int64
free_sample_rule

The free sample rules set by the seller in the target collaboration.

object
has_free_sample

If true, free samples are provided to creators invited to the target collaboration group.

boolean
is_sample_approval_exempt

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.

boolean
products

The information of products in the target collaboration.

Array<object>
object
id

The product identifier.

string
main_image_url

The product image url.

string
title

The product name.

string
original_price

The original price of the product.

object
currency

The currency in the sale region.

string
minimum_amount

The minimum original price of all skus of this product.

string
maximum_amount

The maximum original price of all skus of this product.

string
commission

Commission info.

object
rate

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].

integer format: int64
effective_time

The time when the commission becomes effective, as a Unix timestamp in seconds represented as a string.

string
currency

The currency code.

string
minimum_amount

The minimum estimated commission amount for all SKUs of this product.

string
maximum_amount

The maximum estimated commission amount for all SKUs of this product.

string
shop_ads_commission_rate

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%.
integer format: int64
status

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
string
commission_effective_status

The effectiveness of this product’s target collaboration commission across creators. Field values:

  • EFFECTIVE_ALL: The commission is effective for all creators.
  • EFFECTIVE_PARTIALLY: The commission is effective for some creators.
  • EFFECTIVE_NONE: The commission is not effective for any 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.
string
collaboration_status

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.
string
creators

The information of creators in the target collaboration.

Array<object>
object
username

The TikTok user name.

string
nickname

The TikTok nick name.

string
avatar

Data associated with the TikTok creator’s profile avatar.

object
url

The URL for the creator’s TikTok profile avatar.

string
selection_region

The regions in which the creator is eligible to promote products in showcases, videos, and live streams.

string
showcase_product_count

This field indicates the number of products creator has added to the showcase from target collaboration. The count includes NORMAL and DELETING states.

integer format: int64
content_product_count

This field indicates the number of products creator has posted video or live from target collaboration. The count includes NORMAL and DELETING states.

integer format: int64
collaboration_status

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.
string
product_effective_status

The effectiveness of the target collaboration’s product commissions for this creator. Field values:

  • EFFECTIVE_ALL: The commission is effective for this creator on all products in the target collaboration.
  • EFFECTIVE_PARTIALLY: The commission is effective for this creator on some products in the target collaboration.
  • EFFECTIVE_NONE: The commission is not effective for this creator on any products in the target collaboration. 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.
string
creator_open_id

Creator Open ID. More details

string
type

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.
string
Example
{
  "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&nonce=49646&refresh_token=b53364a3a1947c4ac7a0c4bea62e31ea&x-expires=1727175600&x-signature=ASPIxFDNDkN1cknLEItlyC%2Bcfbw%3D&shp=a5d48078&shcp=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&x-expires=1712988000&x-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"
}
DocsSDKsAPI Reference

Start here

Getting StartedConceptsAuthorizationWebhooksErrors

SDKs

Choose an SDK

OpenAPI

The spec