Get Affiliate Partner Campaign Detail

GET

/affiliate_partner/202405/campaigns/{campaign_id}

This API offers the ability to get affiliate campaign details.

Authorizations

• accessToken

Parameters

Path Parameters

campaign_id

required

string

The campaign ID in decimal integer format.

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.

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

id

The campaign identifier.

string

name

The campaign name. Maximum length: 50 characters.

string

<= 50 characters

description

The campaign description. Maximum length: 1000 characters.

string

<= 1000 characters

status

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

• READY
• UPCOMING
• ONGOING
• CLOSED

string

region

The region to which the campaign is associated.

string

registration_start_time

The scheduled start time for seller product registration as a Unix timestamp in seconds. This field can be updated only when the campaign status is READY or UPCOMING.

integer format: int64

registration_end_time

The scheduled end time for seller product registration as a Unix timestamp in seconds. This field is no longer editable when the campaign status is CLOSED.

integer format: int64

campaign_start_time

The scheduled campaign start time as a Unix timestamp in seconds. This field can be updated only when the campaign status is READY or UPCOMING.

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

commission_rate

The total commission rate in hundredths of a percent (0.01%) units proposed by the affiliate partner for display to sellers. Commission rate must be greater than 100 and less than 8000.

integer format: int64

contact_info

The campaign creator’s contact information.

object

whatsapp

The partner’s phone number registered in WhatsApp, in E.164 international format. Applicable if the target market is MY, SG, GB, ID, or US.

string

email

The partner’s email address.

string

phone

The partner’s phone number in E.164 international format.

string

zalo

The partner’s phone number registered in Zalo, in E.164 international format. Applicable if the target market is VN.

string

viber

The partner’s phone number registered in Viber, in E.164 international format. Applicable if the target market is PH.

string

line

The partner’s phone number registered in LINE, in E.164 international format. Applicable if the target market is TH.

string

target_shops

A list of TikTok Shop seller shop codes and names with permission to register for the campaign.

Array<object>

object

code

The seller shop code in available in TikTok Shop Seller Central by clicking on the Seller Profile icon in the top right of the user interface.

string

name

The TikTok Shop name.

string

target_seller_types

A list of seller types eligible to register for the campaign. Use this field to broadly target seller types instead of the specific shops listed in target_shops. Possible values:

• LOCAL
• CROSS_BORDER

Array<string>

Allowed values: LOCAL CROSS_BORDER

Example

{
  "code": 0,
  "data": {
    "id": "7356876895365105455",
    "name": "test_campaign",
    "description": "Campaign for api test.",
    "status": "READY",
    "region": "US",
    "registration_start_time": 1712941200,
    "registration_end_time": 1713891599,
    "campaign_start_time": 1712941200,
    "campaign_end_time": 1715878799,
    "commission_rate": 1000,
    "contact_info": {
      "whatsapp": "+14255550100",
      "email": "123456@gmail.com",
      "phone": "+14255550100",
      "zalo": "+14255550100",
      "viber": "+14255550100",
      "line": "+14255550100"
    },
    "target_shops": [
      {
        "code": "THCBELNL4Y",
        "name": "my_shop"
      }
    ],
    "target_seller_types": [
      "LOCAL"
    ]
  },
  "message": "Success",
  "request_id": "202203070749000101890810281E8C70B7"
}