Search Creator Target Collaborations

POST

/affiliate_creator/202405/target_collaborations/search

Searches for the authenticated creator’s target collaborations and the products within them for the TikTok Shop specified by shop_id.

Authorizations

• accessToken

Parameters

Query Parameters

page_token

string

An opaque token used to retrieve the next page of a paginated result set. It is not needed for the first page. For each subsequent page, pass the previous response’s next_page_token unchanged as page_token and reuse the same page_size, shop_id, keyword, and keyword_type values, including whether optional keyword and keyword_type were omitted or provided.

page_size

required

integer format: int64

<= 100

The number of results to be returned per page. Valid range: [0-100].

Request Body^required

Media typeapplication/json

object

shop_id

required

The TikTok Shop identifier.

string

keyword_type

The type of value specified in keyword. Provide keyword and keyword_type together to filter by ID or name. Omit both fields to search without an ID or name filter. Possible values:

• TARGET_COLLABORATIONS_ID: Match by target collaboration ID and return matching collaborations in the LIVE, EXPIRED, DELETED, or ENDED state.
• TARGET_COLLABORATIONS_NAME: Match by target collaboration name and return matching collaborations in the LIVE state only.

string

Allowed values: TARGET_COLLABORATIONS_ID TARGET_COLLABORATIONS_NAME

keyword

The target collaboration ID or name to search for, as specified by keyword_type. For TARGET_COLLABORATIONS_ID, provide a base-10 integer. For TARGET_COLLABORATIONS_NAME, provide a value shorter than 500 bytes.

string

Example

{
  "shop_id": "789078671231",
  "keyword_type": "TARGET_COLLABORATIONS_ID",
  "keyword": "12312312"
}

Responses

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

total_count

The total number of target collaborations that match the search criteria.

integer format: int64

next_page_token

An opaque token used to retrieve the next page of a paginated result set.

string

target_collaborations

A list of target collaboration objects.

Array<object>

object

id

The target collaboration identifier.

string

name

The target collaboration name.

string

status

The target collaboration state. This is an enumerated type with values:

• LIVE
• EXPIRED
• DELETED
• ENDED

string

products

A list of products associated with the target collaboration.

Array<object>

object

id

The product identifier.

string

title

The product name.

string

main_image_url

The product image URL in the TikTok Shop.

string

commission

The commission rate and estimated commission amount for the product in this target collaboration.

object

rate

The commission rate for the target collaboration in hundredths of a percent. For example, 3587 is a commission rate of 35.87%.

integer format: int64

amount

The estimated commission amount calculated from the product’s minimum price, in the currency specified by currency.

string

currency

The currency code.

string

Example

{
  "code": 0,
  "data": {
    "total_count": 100,
    "next_page_token": "b2Zmc2V0PTIw",
    "target_collaborations": [
      {
        "id": "789078671231123124",
        "name": "target_collaboration",
        "status": "LIVE",
        "products": [
          {
            "id": "1729432087292775344",
            "title": "Blue t-shirt",
            "main_image_url": "https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/fa0387fa5a204dcfa44d5be75877a163~tplv-o3syd03w52-origin-webp.webp?from=3478900499",
            "commission": {
              "rate": 1000,
              "amount": "121.23",
              "currency": "USD"
            }
          }
        ]
      }
    ]
  },
  "message": "Success",
  "request_id": "202203070749000101890810281E8C70B7"
}