Get Affiliate Partner Campaign List

GET

/affiliate_partner/202405/campaigns

Lists campaigns for an affiliate partner, filtered by campaign category, participation state, and campaign status.

Authorizations

• accessToken

Parameters

Query Parameters

category_asset_cipher

required

string

The partner identifier used in API requests. Retrieve this value by using the Get Authorized Category Assets API.

page_size

required

integer format: int64

>= 1 <= 100

The number of campaigns to return per page. Valid range: 1-100.

page_token

string

An opaque token used to retrieve the next page of a paginated result set. Retrieve this value from the result of the next_page_token from a previous response. It is not needed for the first page. Maximum page size is 100 items.

status

string

This parameter is required. The campaign status. The status is an enumerated type with values:

• READY
• UPCOMING
• ONGOING
• CLOSED
• UNSPECIFIED

type

string

The campaign type. This is an enumerated type with values:

• MY_CAMPAIGNS
• GS_SELLING_CAMPAIGNS
• SELLER_CAMPAIGNS
• EXCLUSIVE_TIKTOK_SHOP
  Default value is MY_CAMPAIGNS.

query_type_filter

string

An additional filter whose valid values depend on type:

• SELLER_CAMPAIGNS: query_type_filter is required. Set it to MARKETPLACE to include campaigns that the partner has not joined, or JOINED to include only campaigns that the partner has joined. When using MARKETPLACE, set status to UNSPECIFIED.
• EXCLUSIVE_TIKTOK_SHOP: query_type_filter is required. Set it to AVAILABLE to include campaigns that the partner is permitted to join, or JOINED to include only campaigns that the partner has joined. For either value, set status to UNSPECIFIED.
• MY_CAMPAIGNS or GS_SELLING_CAMPAIGNS: omit query_type_filter or set it to DEFAULT.

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

campaigns

A list of campaigns.

Array<object>

object

id

The campaign identifier.

string

name

The campaign name.

string

status

The campaign status. The status is an enumerated type with values:

• READY
• UPCOMING
• ONGOING
• CLOSED

string

registration_start_time

The scheduled start time in Unix epoch format for seller product registration. Note that this field can be updated when the campaign status is set to READY or UPCOMING only.

integer format: int64

registration_end_time

The scheduled end time in Unix epoch time format for seller product registration. This field is no longer editable when the campaign status is set to CLOSED.

integer format: int64

campaign_start_time

The scheduled start time in Unix epoch time format for the campaign. Note that this field can be updated when the campaign status is set to READY or UPCOMING only.

integer format: int64

campaign_end_time

The scheduled end time in Unix epoch time format for the campaign. Note that the end time must be less than 360 days from the start date. This field is no longer editable when the campaign status is set to CLOSED.

integer format: int64

next_page_token

An opaque token used to retrieve the next page of a paginated result set. For the first request, omit page_token or pass an empty value. For each subsequent request, pass the previous response’s non-empty next_page_token as page_token, and keep the same category_asset_cipher, page_size, status, type, and query_type_filter values, including whether each optional parameter was omitted or provided. If next_page_token is empty, no more pages are available.

string

total_count

The total number of campaigns in the list.

integer format: int64

Example

{
  "code": 0,
  "data": {
    "campaigns": [
      {
        "id": "7360590375814268715",
        "name": "test",
        "status": "READY",
        "registration_start_time": 1712941200,
        "registration_end_time": 1713891599,
        "campaign_start_time": 1712941200,
        "campaign_end_time": 1715878799
      }
    ],
    "next_page_token": "cGFnZV9udW1iZXI9Mg==",
    "total_count": 1570
  },
  "message": "Success",
  "request_id": "202203070749000101890810281E8C70B7"
}