Skip to content
TikTok Shop Partner API

Get Affiliate Partner Campaign Product List

GET
/affiliate_partner/202405/campaigns/{campaign_id}/products

This API offers the ability to list products submitted by sellers in an Affiliate Partner campaign.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
campaign_id
required
string

The numeric ID of an existing Affiliate Partner campaign.

Query Parameters

Section titled “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

The number of results to return per page. The value must be between 1 and 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.

review_status
string

The product review status. This an enumerated type with values:

  • PENDING
  • APPROVED
  • REJECTED
  • PENDING_CLOSED
  • CLOSED
product_name
string

Filter the product list by product name. If value of product_name is contained in product.name, the product will be included in the response.

product_id
string

Filter the product list by product ID. The value must be a numeric string. A product is included when this value matches product.id.

shop_name
string

Filter the product list by shop name. If value of shop_name is contained in product.shop_name, the product will be included in the response.

category_id
string

Filter the product list by category ID. If value of category_id matches product.category.id, or the product falls into the leaf category of the specified category, the product will be included in the response.

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
products

The list of products.

Array<object>
object
id

The product identifier.

string
review_status

The product review status. This an enumerated type with values:

  • PENDING
  • APPROVED
  • REJECTED
  • PENDING_CLOSED
  • CLOSED
string
name

The product name.

string
main_image_url

The product image URL.

string
lowest_price

The lowest original price of all SKUs of this product.

object
currency

The currency in the sales region.

string
amount

The lowest price amount.

string
highest_price

The highest original price of all SKUs of this product.

object
currency

The currency code for the region in which the product is sold.

string
amount

The highest price amount.

string
inventory

The number of in-stock units of all SKUs for this product.

integer format: int64
shop_name

The TikTok Shop name.

string
total_commission_rate

The total commission rate in hundredths of a percent (0.01%) units.

integer format: int64
creator_commission_rate

The creator commission rate in hundredths of a percent (0.01%) units.

integer format: int64
partner_commission_rate

The partner commission rate in hundredths of a percent (0.01%) units.

integer format: int64
open_collaboration_commission_rate

The product open collaboration commission rate in hundredths of a percent (0.01%) units.

integer format: int64
is_available

Set to true if a product URL is available. Set to false if no product URL is available.

boolean
product_sales

The total number of units sold of this product for this campaign.

integer format: int64
category

The leaf category to which this product is associated.

object
id

The category identifier.

string
name

The category name.

string
sample_quota

The total amount of sample inventory available for allocation to creators by the seller.

integer format: int64
sku_information_list

A list of Stock Keeping Units (SKUs) used to identify distinct variants of the product.

Array<object>
object
sku_name

The name of the sku

string
sku_id

The id of the sku

string
inventory

SKU inventory details.

object
available_quantity

The total SKU quantity available in the warehouse.

string
base_price

The base price of the sku

object
region_code

The region code of the sku

string
currency

The currency of the SKU price. Possible values based on the region:

  • BRL: Brazil
  • EUR: France, Germany, Ireland, Italy, Spain
  • GBP: United Kingdom
  • IDR: Indonesia
  • JPY: Japan
  • MXN: Mexico
  • MYR: Malaysia
  • PHP: Philippines
  • SGD: Singapore
  • THB: Thailand
  • USD: United States
  • VND: Vietnam
string
Allowed values: BRL EUR GBP IDR JPY MXN MYR PHP SGD THB USD VND
list_price

The SKU’s list price information that has been verified to be legitimate by the audit team. This is equivalent to the manufacturer’s suggested retail price (MSRP), or the recommended retail price (RRP).

string
sale_price

The SKU’s selling price, inclusive of tax. Applicable only for cross-border sellers from China.

string
localized_dutiable_price

Localized dutiable price

string
region_prices

Region prices

Array<object>
object
region_code

The region code of the sku

string
currency

The currency of the SKU price. Possible values based on the region:

  • BRL: Brazil
  • EUR: France, Germany, Ireland, Italy, Spain
  • GBP: United Kingdom
  • IDR: Indonesia
  • JPY: Japan
  • MXN: Mexico
  • MYR: Malaysia
  • PHP: Philippines
  • SGD: Singapore
  • THB: Thailand
  • USD: United States
  • VND: Vietnam
string
Allowed values: BRL EUR GBP IDR JPY MXN MYR PHP SGD THB USD VND
list_price

The SKU’s list price information that has been verified to be legitimate by the audit team. This is equivalent to the manufacturer’s suggested retail price (MSRP), or the recommended retail price (RRP).

string
sale_price

The SKU’s selling price, inclusive of tax. Applicable only for cross-border sellers from China.

string
localized_dutiable_price

Localized dutiable price

string
properties

The properties of the sku

Array<object>
object
name

The name of the property

string
value_name

The name of the value

string
product_description

Return product description

string
next_page_token

An opaque token used to retrieve the next page of a paginated result set. When this value is non-empty, pass it as page_token in the next request and reuse the same campaign_id, category_asset_cipher, page_size, review_status, product_name, product_id, shop_name, and category_id values, including any omitted optional filters. An empty next_page_token means there are no more pages.

string
total_count

The total number of products in the list.

integer format: int64
Example
{
  "code": 0,
  "data": {
    "products": [
      {
        "id": "1729442777527587334",
        "review_status": "PENDING",
        "name": "test case number 4 test case number 4",
        "main_image_url": "https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/fa0387fa5a204dcfa44d5be75877a163~tplv-o3syd03w52-origin-webp.webp?from=3478900499",
        "lowest_price": {
          "currency": "USD",
          "amount": "1.1"
        },
        "highest_price": {
          "currency": "USD",
          "amount": "12.21"
        },
        "inventory": 89,
        "shop_name": "my_shop",
        "total_commission_rate": 6600,
        "creator_commission_rate": 1000,
        "partner_commission_rate": 5600,
        "open_collaboration_commission_rate": 1000,
        "is_available": true,
        "product_sales": 10,
        "category": {
          "id": "12222",
          "name": "COMPUTER"
        },
        "sample_quota": 12,
        "sku_information_list": [
          {
            "sku_name": "factory product",
            "sku_id": "1729666531097281876",
            "inventory": {
              "available_quantity": "80"
            },
            "base_price": {
              "region_code": "MY",
              "currency": "MYR",
              "list_price": "162.34",
              "sale_price": "162.34",
              "localized_dutiable_price": "141.58"
            },
            "region_prices": [
              {
                "region_code": "MY",
                "currency": "MYR",
                "list_price": "162.34",
                "sale_price": "162.34",
                "localized_dutiable_price": "141.58"
              }
            ],
            "properties": [
              {
                "name": "Spesifikasi",
                "value_name": "lalai"
              }
            ]
          }
        ],
        "product_description": "<p>This is an example product description.</p>"
      }
    ],
    "next_page_token": "cGFnZV9udW1iZXI9Mg==",
    "total_count": 1570
  },
  "message": "Success",
  "request_id": "202203070749000101890810281E8C70B7"
}
DocsSDKsAPI Reference

Start here

Getting StartedConceptsAuthorizationWebhooksErrors

SDKs

Choose an SDK

OpenAPI

The spec