Get Open Collaboration Product List By Product Ids

POST

/affiliate_creator/202509/open_collaborations/products

Retrieves open collaboration product information for the specified product IDs.

Authorizations

• accessToken

Parameters

Query Parameters

product_ids

Array<string>

A comma-separated list of numeric product IDs. Maximum: 50 IDs per request.

Request Body

Media typeapplication/json

object

Example

{}

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

Products found for the requested product IDs. The response may contain fewer products than requested.

Array<object>

object

shop

The product’s shop information.

object

name

The name of the shop to which the product belongs.

string

id

Product’s unique id.

string

has_inventory

Whether this product has inventory.

boolean

units_sold

The total number of units sold for this product.

integer format: int64

title

Product’s name.

string

sale_region

The region represents the areas where the product can be sold.

string

main_image_url

The product image url.

string

detail_link

Product’s detail link which is used to get product details on mobile clients.

string

original_price

The product’s original price

object

currency

The currency in the sale region.

string

minimum_amount

The minimum original price of all skus of this product.

string

maximum_amount

The maximum original price of all skus of this product.

string

category_chains

The categories of this product. Return to the top three categories at most

Array<object>

object

id

The current category id of this product.

string

local_name

The current level category name of this product.

string

is_leaf

Indicate whether current node is leaf node

boolean

parent_id

The category id of its parent category

string

commission

The commission of this product.

object

rate

• The commission rate for this product is set by merchants for creators public promotion.
• The range of this value is [100, 8000].
• This value equals actual commission rate multi 10000. For example: 3000 means the actual commission rate is 30.00%, and 3555 means 35.55%

integer format: int64

currency

Currency code for the commission amount.

string

amount

The commission amount calculated from the product’s promotional price and commission rate. When both minimum and maximum promotional prices are available, the value is formatted as <minimum commission> - <maximum commission>; otherwise, it contains the available commission amount. If neither price is available, the value is 0. The currency is specified by commission.currency.

string

sales_price

Sales price information of the product

object

currency

Currency code for the promotional price.

string

minimum_amount

The minimum promotion price of all skus of this product.

string

maximum_amount

The maximum promotion price of all skus of this product.

string

shop_ads_commission

The ads commission rate applies only to orders generated from ads. If a creator’s video is used as an ad without this rate being set, the resulting orders will instead earn either:

• The Shop Ads commission you configured in open collaboration, or
• The standard commission defined in this invitation.

object

rate

The Shop Ads commission rate for this product, multiplied by 10,000. The range is 100 to 8,000. For example, 3,000 represents 30.00% and 3,555 represents 35.55%.

integer format: int64

Example

{
  "code": 0,
  "data": {
    "products": [
      {
        "shop": {
          "name": "Test shop"
        },
        "id": "1729432087292775344",
        "has_inventory": false,
        "units_sold": 12,
        "title": "Blue t-shirt",
        "sale_region": "ID",
        "main_image_url": "https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/fa0387fa5a204dcfa44d5be75877a163~tplv-o3syd03w52-origin-webp.webp?from=3478900499",
        "detail_link": "https://shop.tiktok.com/view/product/1729624807198591373?region=ID&local=en",
        "original_price": {
          "currency": "USD",
          "minimum_amount": "12.21",
          "maximum_amount": "100.00"
        },
        "category_chains": [
          {
            "id": "3435545",
            "local_name": "COMPUTER",
            "is_leaf": false,
            "parent_id": "12345"
          }
        ],
        "commission": {
          "rate": 100,
          "currency": "USD",
          "amount": "0"
        },
        "sales_price": {
          "currency": "USD",
          "minimum_amount": "34.3",
          "maximum_amount": "55.7"
        },
        "shop_ads_commission": {
          "rate": 100
        }
      }
    ]
  },
  "message": "Success",
  "request_id": "202203070749000101890810281E8C70B7"
}