Developer resources

Get the available products in a Showcase — TikTok Business API

Get the available products in a Showcase · call it through Quantri360 with one API key for your own accounts / assets that you connected and authorized — 360 handles request signing and refreshing the authorization you granted.

Open in the API index TikTok Business platform page

Get the available products in a Showcase

GET/showcase/product/get/Via 360: GET https://partner.quantri360.com/v1/tiktok_business/showcase/product/get/

Description

Use this endpoint to get the Showcase products that can be used to target the specified country or region.

Request

Endpoint

GET https://partner.quantri360.com/v1/tiktok_business/showcase/product/get/

Authentication & shop

Name	In	Type	Sample	Description
Authorization	header	header	Bearer q360_live_ab12cd34_…	Khóa API của brand (tạo ở mục API key). Bắt buộc với mọi request. Brand suy từ key — không truyền mã brand.
platform_shop_id	query	string	7000000000000000001	Tài sản TikTok Business đã kết nối — "Mã tài sản" ở trang Nền tảng hoặc GET /v1/platforms (tài khoản quảng cáo cho Marketing API, tài khoản TikTok cho Organic / Messaging). Có thể bỏ khi chỉ kết nối một tài sản.

Request parameters

Name	In	Type	Required	Description
identity_id	query	string	Yes	The ID of the identity that is bound to a Showcase and the identity needs to have permission of the Showcase.
identity_type	query	string	Yes	Identity type. Enum values: - `TT_USER`: TikTok User. - `BC_AUTH_TT`: TikTok Account User in Business Center. See Identities to learn more about different identity types.
identity_authorized_bc_id	query	string	No	Required when `identity_type` is `BC_AUTH_TT`. ID of the Business Center that a TikTok Account User in Business Center identity is associated with.
region_codes	query	string[]	Yes	The list of country or region codes that you want to use products in the Showcase to target.
filtering	query	object	No	Filtering conditions.
page	query	number	No	Current page number. Default value: 1. Value range: ≥1.
page_size	query	number	No	Page size. Default value: 10. Value range: [1, 1000].

Request examples

curl -s "https://partner.quantri360.com/v1/tiktok_business/showcase/product/get/?identity_id=&identity_type=&region_codes=%5B%5D" \
  -H "Authorization: Bearer $KEY"

Python

import requests

KEY = "q360_live_..."  # khóa API của brand
r = requests.get(
    "https://partner.quantri360.com/v1/tiktok_business/showcase/product/get/",
    params={
        "identity_id": "",
        "identity_type": "",
        "region_codes": []
    },
    headers={"Authorization": f"Bearer {KEY}"},
    timeout=60,
)
print(r.status_code)
print(r.json())

Node.js

const KEY = 'q360_live_...'; // khóa API của brand
const url = new URL('https://partner.quantri360.com/v1/tiktok_business/showcase/product/get/');
for (const [k, v] of Object.entries({"identity_id":"","identity_type":"","region_codes":[]})) url.searchParams.set(k, typeof v === 'object' ? JSON.stringify(v) : String(v));
const r = await fetch(url, {
  method: 'GET',
  headers: { Authorization: `Bearer ${KEY}` },
});
console.log(r.status, await r.json());

PHP

<?php
$key = 'q360_live_...'; // khóa API của brand
$url = 'https://partner.quantri360.com/v1/tiktok_business/showcase/product/get/' . '?' . http_build_query(['identity_id' => '', 'identity_type' => '', 'region_codes' => '[]']);
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: Bearer ' . $key]);
$res = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
echo $status, "\n", $res;

Response

Response fields (as returned by TikTok Business)

Name	Type	Description
code	number	Response code. For the complete list of response codes and descriptions, see Appendix-Return Code.
message	string	Response message. For details, see Appendix - Return Codes.
request_id	string	The log ID of a request, which uniquely identifies the request.
data	object	Returned data.
showcase_products	object[]	The list of products in the Showcase that you can use to target the specified countries or regions.
item_group_id	string	SPU ID of the product.
title	string	The title of the product.
product_image_url	string	The URL of the product image.
min_price	string	The minimum price of the product. Note: If you specify one fixed price for the product, the values of `min_price` and `max_price` will be the same.
max_price	string	The maximum price of the product. Note: If you specify one fixed price for the product, the values of `min_price` and `max_price` will be the same.
currency	string	The code of the currency in which the prices (`min_price` and `max_price`) are specified. To learn about the currency that a currency code corresponds to, see Budget verification ratio and precision of each currency.
category	string	The category of the product.
status	string	The status of the product. Enum values: - `AVAILABLE`: The product is available for use in ads. - `NOT_AVAILABLE`: The product is not available for use in ads.
catalog_id	string	The ID of the catalog that the product (`item_group_id`) belongs to. Note: Starting June 30th, 2024, this field will no longer be returned.
store_id	string	The ID of the store that the product (`item_group_id`) belongs to. Note that the only supported store type is TikTok Shop.
page_info	object	Pagination information.
page	number	Current page number.
page_size	number	Paging size.
total_number	number	Total number of results.
total_page	number	Total pages of results.

Response sample

HTTPS/1.1 200 OK
{
    "code": 0,
    "message": "OK",
    "request_id": "{{request_id}}",
    "data": {
        "showcase_products": [
            {
                "category": "{{category}}",
                "title": "{{title}}",
                "status": "NOT_AVAILABLE",
                "item_group_id": "{{item_group_id}}",
                "store_id": "{{store_id}}",
                "catalog_id": "{{catalog_id}}",
                "currency": "IDR",
                "min_price": "1000",
                "product_image_url": "{{product_image_url}}",
                "max_price": "1000"
            }
        ],
        "page_info": {
            "total_page": 1,
            "page_size": 10,
            "total_number": 1,
            "page": 1
        }
    }
}

Get started

Sign up for Partner
Enable a data type of the Ads (Marketing API) group on the platform page
Create an API key (tick the TikTok Business channel)
Call it as in the examples above