Get Shop Products

GET

/affiliate_creator/202509/shop_products

Searches for products in the shop bound to the authenticated creator. Optionally use title_keyword to filter products by title. The creator must have a bound shop before calling this API.

Authorizations

• accessToken

Parameters

Query Parameters

title_keyword

string

The title keyword of the product you wish to search by.

sort_field

string

Allowed values: PRODUCT_ID PRICE SALE

Sort field. Possible values:

• PRODUCT_ID
• PRICE
• SALE

If omitted or empty, defaults to PRODUCT_ID. Any other value is rejected.

sort_order

string

Allowed values: DESC ASC

Sort order. Possible values:

• DESC
• ASC

If omitted or empty, defaults to DESC. Any other value is rejected.

page_size

required

integer format: int64

>= 1 <= 100

Pagination count determines how many products you’ll get after sending the request. 20 is a recommended number. Valid Range: [1-100]

page_token

string

An opaque token used to retrieve the next page. Leave this parameter empty for the first request. For subsequent requests, pass the next_page_token returned by the previous response and reuse the same title_keyword, sort_field, sort_order, and page_size values.

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

products

The searched product list. It will be empty when there are no search results.

Array<object>

object

id

TikTok product ID.

string

title

Product name.

string

price

Product price shown with two decimal places and currency.

object

amount

The SKU price in major units of the currency specified by currency, represented as a decimal string.

string

currency

The price currency code.

string

added_status

Showcase add status with possible values:

• ADDABLE
• ADDED
• REJECTED

string

Allowed values: ADDABLE ADDED REJECTED

brand_name

The brand name a seller has set for a product.

string

images

Images of a product.

Array<object>

object

url

URL of the image.

string

width

The width of image. Unit: px

integer format: int64

height

The height of image. Unit: px

integer format: int64

sales_count

The number of products that have been sold.

integer format: int64

total_count

The total number of products that meet the query conditions.

integer format: int64

next_page_token

An opaque token used to retrieve the next page. Pass it as page_token in the next request. It is empty when there are no more products to retrieve.

string

Example

{
  "code": 0,
  "data": {
    "products": [
      {
        "id": "1729592969712207012",
        "title": "testcase autotest Live Product",
        "price": {
          "amount": "56.00",
          "currency": "USD"
        },
        "added_status": "ADDABLE",
        "brand_name": "Apple",
        "images": [
          {
            "url": "https://p19-pu-sign-useast8.tiktokcdn-us.com/tos-useast5-avt-0068-tx/982dd6b4e46a6a24203b00611a474cca~c5_1080x1080.webp",
            "width": 200,
            "height": 200
          }
        ],
        "sales_count": 33
      }
    ],
    "total_count": 300,
    "next_page_token": "b2Zmc2V0PTIw"
  },
  "message": "Success",
  "request_id": "202203070749000101890810281E8C70B7"
}