VI | EN
Message us on Messenger
Developer resources

Get products — TikTok Business API

Get products · 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.

Get products

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

Use this endpoint to get the list of products in your product catalog.

You can filter the products you want to get by specifying product IDs, SKU IDs, product set IDs or by using custom conditions (conditions). You can also order the results by product availability or custom conditions.

Request

Endpoint

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

Authentication & shop

NameInTypeSampleDescription
AuthorizationheaderheaderBearer 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_idquerystring7000000000000000001Tà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

NameInTypeRequiredSampleDescription
bc_idquerystringYesBusiness Center ID.
catalog_idquerystringYesCatalog ID.
pagequerynumberNoCurrent page number. Note: Only 10,000 results can be returned at most. You need to ensure that page multiplied by page_size is no more than 10,000.
page_sizequerynumberNoPage size. Default value: 10. Value range: within 500.
product_idsquerystring[]NoIDs of the products that you want to get. Max size: 1,000. Note: - product_ids and sku_ids cannot be specified at the same time. - For mini series catalogs, the only supported filter is product_ids.
sku_idsquerystring[]NoIDs of the SKUs that you want to get information for. Max size: 1000. Length limit: 100 characters for each SKU ID and cannot contain emojis. Note: - Duplicate SKU IDs are not supported. - product_ids and sku_ids cannot be specified at the same time.
series_idsquerystring[]NoIDs of the short drama series that you want to filter. Max size: 1,000. Length limit: 100 characters for each short drama series ID. Note: - Duplicate short drama series IDs are not supported. - product_ids and series_ids cannot be specified at the same time. - conditions and series_ids cannot be specified at the same time.
product_set_idsquerystring[]NoIDs of the product sets that you want to get. Max size: 100.
product_available_typequerystringNoValid only when an Ecommerce or online-to-offline catalog is specified through catalog_id. The type of products to retrieve. Enum values: - AVAILABLE: To retrieve products that are available for ad creation. - ALL: To retrieve all products. Default value: ALL.
orderqueryobjectNoOrdering settings. When product_ids or sku_ids is specified, this field will be ignored.
conditionsqueryobjectNoFiltering conditions. When you specify a filtering condition, all data fields in this object are required except case_senstive. When product_ids, sku_ids, or series_ids is specified, this field will be ignored.

Request examples

curl -s "https://partner.quantri360.com/v1/tiktok_business/catalog/product/get/?bc_id=&catalog_id=" \
  -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/catalog/product/get/",
    params={
        "bc_id": "",
        "catalog_id": ""
    },
    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/catalog/product/get/');
for (const [k, v] of Object.entries({"bc_id":"","catalog_id":""})) 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/catalog/product/get/' . '?' . http_build_query(['bc_id' => '', 'catalog_id' => '']);
$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)

NameTypeSampleDescription
codenumberResponse code. For the complete list of response codes and descriptions, see Appendix - Return Codes.
messagestringResponse message. For details, see Appendix - Return Codes.
request_idstringThe log ID of the request, which uniquely identifies a request.
dataobjectReturned data.
listobject[]Product list.
auditobjectAudit information.
audit_statusstringAd audit status. It indicates if the ad promoting the product can be deployed. Enum values: `approved`, `rejected`, `processing`.
rejected_infoobject[]Returned only when `audit_status` is `rejected`. List of rejection reasons.
reasonstringRejection reason.
suggestionstringSuggestions about how to revise to be approved.
affected_placementstring[]List of placements affected by the rejection.
affected_countrystring[]List of countries or regions affected by the rejection.
availablebooleanReturned only for E-commerce and online-to-offline products. Whether the product is available for ad creation. Supported values: `true`, `false`.
ad_creation_eligiblestringReturned only for E-commerce catalog products. Whether the E-commerce catalog product can be used to create ads. Enum values: `AVAILABLE`, `NOT_AVAILABLE`. The `ad_creation_eligible` of an E-commerce catalog product will be `AVAILABLE` only when the following conditions are met: - `audit_status` is `approved`. - `active_status` is `ACTIVATED`. - `availability` is `IN_STOCK`, `AVAILABLE_FOR_ORDER`, or `PREORDER`.
active_statusstringWhether the product is activated. Enum values: `ACTIVATED`, `DEACTIVATED`. This field represents the advertiser-controlled online or offline status of the product. However, it does not necessarily imply that the product can be used to create ads.
sku_idstringAdvertiser-defined product ID.
product_idstringProduct ID.
titlestringProduct title.
descriptionstringProduct description.
availabilitystringInventory status. - For E-commerce and online-to-offline catalog products, the enum values are: - `IN_STOCK`: in stock. - `AVAILABLE_FOR_ORDER`: available for order. - `PREORDER`: available for pre-order. - `OUT_OF_STOCK`: out of stock. - `DISCONTINUED`: discontinued. - For hotel catalog products, the enum values are: - `IN_STOCK`: available for booking. - `OUT_OF_STOCK`: unavailable for booking. - For entertainment catalog products, the enum values are: - `AVAILABLE` - `SUBSCRIBERS_ONLY` - `ON_DEMAND` - `NOT_AVAILABLE` - For Auto-Inventory catalog products, the enum values are: - `AVAILABLE`: available for order. - `NOT_AVAILABLE`: Not available for order. - For products or services in a generic catalog, the enum values are: - `IN_STOCK`: in stock. - `AVAILABLE`: available. - `PREORDER`: pre-order. - `OUT_OF_STOCK`: out of stock. - `DISCONTINUED`: discontinued. - `UNAVAILABLE`: unavailable.
image_urlstringThe URL for the product image.
video_urlstringAd video link.
brandstringBrand information.
additional_image_urlsstring[]Additional image URLs for the product.
item_group_idstringProduct SPU ID.
google_product_categorystringCategory information.
global_trade_item_numberstringThe Global Trade Item Number (GTIN) for the product.
manufacturer_part_numberstringThe Manufacturer Part Number (MPN) for the product.
hotel_idstringA unique ID for the hotel.
namestringThe name of the hotel.
hotel_categorystring[]The categories of the hotel. For enum values, see List of values for `hotel_category`.
hotel_retailer_idstringA unique ID for the hotel retailer.
addressobjectAddress information.
addressstringThe address of the hotel, destination, or the dealership.
streetstringThe street address where the product or service is located.
secondary_addressstringThe secondary street address of the hotel.
tertiary_addressstringThe tertiary street address of the hotel.
citystringThe city where the hotel, destination, or the dealership is located, or the city where the product or service is located.
regionstringThe region (state/province) where the hotel, destination, or the dealership is located, or the state, province, or administrative region where the product or service is located.
countrystringThe country where the hotel or destination is located.
postal_codestringThe postal code for the dealership's address, or postal or zip code of the product or service location.
neighborhoodstringThe neighborhood where the hotel or destination is located. Example: `Bangkok Old Town`.
postal_codestringThe postal code or zip code of the hotel.
latitudefloatThe latitude of the hotel, destination, or the dealership's location, or the product or service location. Example: 37.484100
longitudefloatThe longitude of the hotel, destination, or the dealership's location, or the product or service location. Example: -122.148252
series_idstringA unique self-defined ID for the short drama series.
series_namestringThe name of the short drama series.
target_configobjectDetails of the primary targeting region for the short drama series.
region_codestringThe region code of the primary targeting region for the short drama series. Example: `US`.
currencystringCurrency for the primary targeting region for the short drama series. For supported currencies, see the Code column in Budget verification ratio and precision of each currency. Example: `USD`.
rechargeobject[]Information about the recharge for the short drama series.
typestringRecharge type for the short drama series. Enum values: - `BY_TIERS`: Recharge by tiers. - `SUBSCRIPTION`: Recharge by subscription fee for a time period. - `BY_EPISODES`: Recharge by episodes.
purchase_unitstring[]Units for the recharge. When `recharge_type` is `BY_TIERS`, the enum values are: - `TIER 1`: tier 1. - `TIER_2`: tier 2. - `TIER 3`: tier 3. - `TIER 4`: tier 4. - `TIER 5`: tier 5.When `recharge_type` is `SUBSCRIPTION`, the enum values are: - `WEEKLY`: weekly. - `MONTHLY`: monthly. - `QUARTERLY`: quarterly. - `YEARLY`: yearly.When `recharge_type` is `BY_EPISODES`, specify one or more numeric strings that represent numbers no more than the total episode count.
costfloat[]The prices for the tiers, subscription periods, or episodes.
margin_levelstringThe percentage of the base price (`price`) for a hotel room that the hotel charges as deposit. For instance, a value of 10 means the hotel charges 10 percent of the base price for a hotel room as deposit.
loyalty_programstringThe loyalty program offered by the hotel. For enum values, see List of values for `loyalty_program`.
guest_ratingsobject[]Information about guest ratings for the hotel.
rating_systemstringThe rating system for the hotel.
max_scoreintegerThe highest score that the hotel has received.
scorefloatThe average score of the hotel.
number_of_reviewersintegerThe number of guests who have reviewed the hotel.
star_ratingfloatHotel star rating that is assigned by professional organizations or travel review agencies based on a set of criteria. The highest possible rating is usually 5 stars. Uploading it might help increase Page View Rate.
room_typestring[]The hotel room types. For enum values, see List of values for `room_type`.
priorityintegerThe priority of the hotel or flight. Value range: 0-5. A higher value indicates a higher priority.
flight_idstringA unique ID for the flight. The ID will be automatically generated by the system.
origin_airportstringThe origin airport of the flight, in the format of a three-letter IATA (International Air Transport Association) code. Example: `AAR`.
destination_airportstringThe destination airport of the flight, in the format of a three-letter IATA code. Example: `ABD`.
origin_citystringThe name of the origin city.
destination_citystringThe name of the destination city.
cabin_classstringThe cabin class of the flight. Enum values: - `FIRST_CLASS`: First Class. Premium service with luxurious amenities and private spaces. - `FIRST_CLASS_SUITE`: First Class Suite. Private suites offering luxury and exclusivity. - `BUSINESS_CLASS`: Business Class. Enhanced comfort and amenities for business and leisure travelers. - `BUSINESS_CLASS_SUITE`: Business Class Suite. Spacious and private cabins in business class. - `COMFORT_CLASS`: Comfort Class. Improved seating and service between premium and economy. - `ECONOMY_CLASS`: Economy Class. Standard travel option with basic amenities at an affordable price. - `BASIC_ECONOMY`: Basic Economy. Budget-friendly option with limited services and restrictions. - `STANDARD_ECONOMY`: Standard Economy. Typical economy service with basic features and pricing. - `PREMIUM_ECONOMY`: Premium Economy. Extra legroom and better in-flight services compared to standard economy. - `LIE_FLAT_SEAT`: Lie Flat Seat. Fully reclining seats for optimal comfort on long flights. - `CHARTER_CLASS`: Charter Class. Custom private aircraft hire for tailored travel experiences. - `ELITE_CLASS`: Elite Class. Top-tier service combining the best features of first and business classes. - `QUIET_CLASS`: Quiet Class. Noise-reduced area for a serene travel experience.
airline_companystringThe name of the airline company operating the flight. Enum values: - `AEROFLOT`: Aeroflot. - `AIR_FRANCE_KLM_GROUP`: Air France-KLM Group. - `ALASKA_AIRLINES`: Alaska Airlines. - `ANA`: ANA. - `AMERICAN_AIRLINES`: American Airlines. - `BRITISH_AIRWAYS`: British Airways. - `CATHAY_PACIFIC`: Cathay Pacific. - `CHINA_SOUTHERN_AIRLINES`: China Southern Airlines. - `CHINA_EASTERN_AIRLINES`: China Eastern Airlines. - `DELTA_AIR_LINES`: Delta Air Lines. - `EMIRATES`: Emirates. - `JAPAN_AIRLINES`: Japan Airlines. - `JETBLUE_AIRWAYS`: JetBlue Airways. - `KLM_ROYAL_DUTCH_AIRLINES`: KLM Royal Dutch Airlines. - `LUFTHANSA_GROUP`: Lufthansa Group. - `QANTAS_AIRWAYS`: Qantas Airways. - `QATAR_AIRWAYS`: Qatar Airways. - `SINGAPORE_AIRLINES`: Singapore Airlines. - `SOUTHWEST_AIRLINES`: Southwest Airlines. - `TURKISH_AIRLINES`: Turkish Airlines. - `UNITED_AIRLINES`: United Airlines. - `VIRGIN_ATLANTIC`: Virgin Atlantic.
destination_idstringA unique ID for the destination.
destination_namestringThe name of the destination.
postal_codestringPostal code or zip code for the destination.
typesstring[]The type or types of destination.
media_title_idstringA unique ID for the media title item. A media title item is a media product that is available for distribution or consumption, such as a movie, TV show, music, or sports game.
timelinestringThe timeline for the media title item. Enum values: - `COMING_SOON`: The media title item is not available now, but will be released soon. - `ONLINE`: The media title item is currently available for purchase or view. - `EXPIRE_SOON`: The media title item will no longer be available for purchase or view soon.
categorystringThe category of the media title item. Enum values: - `MOVIE`: movie. - `MUSIC`: music. - `TV_SHOW`: TV show. - `TV_SERIES`: TV series. - `SPORTS_GAME`: sports game. - `LIVE_EVENT`: live event.
genresstring[]The genres of the media title item. To find out the allowed values for this field, refer to the " List of values for `genres` " section below.
qidstringQID (or Q number), the unique identifier of the media title item on Wikidata, which consists of the letter "Q" followed by one or more digits.
vehicle_idstringA unique ID for the vehicle.
state_of_vehiclestringThe state of the vehicle. Enum values: - `NEW`: new. - `USED`: used. - `CPO`: CPO (certified pre-owned). CPO vehicles are used vehicles that have undergone thorough inspection and are typically newer, have lower mileage, and come with additional warranty coverage compared to regular used cars.Example: `USED`.
vehicle_typestringThe type of the vehicle. Enum values: - `BOAT`: boat. - `CAR_TRUCK`: car or truck. - `COMMERCIAL`: A vehicle used for commercial purposes, such as a delivery truck. - `MOTORCYCLE`: motorcycle. - `POWERSPORT`: powersport. Recreational vehicles that are designed for outdoor activities and adventure, such as a snowmobile. - `RV_CAMPER`: recreational vehicle or camper designed for travel and camping purposes. - `TRAILER`: trailer. - `OTHER`: Any other vehicle type not covered above.
makestringThe make (brand) of the vehicle.
modelstringThe model of the vehicle.
trimstringThe trim of the vehicle. The trim represents the distinctive specification package of the vehicle, tailored specifically to that model.
yearintegerThe year when the vehicle was launched, in the format of `YYYY`.
vinstringThe VIN (Vehicle Identification Number) of the vehicle.
mileageobjectThe mileage of the vehicle.
valueintegerMileage value.
unitstringMileage unit. Enum values: - `MILE`: mile. - `KILOMETER`: kilometer.
body_stylestringThe body style of the vehicle. Enum values: - `CONVERTIBLE`: convertible. - `COUPE`: coupe. - `CROSSOVER`: crossover. - `HATCHBACK`: hatchback. - `MINIVAN`: minivan. - `SMALL_CAR`: small car. - `SEDAN`: sedan. - `SUV`: SUV. - `TRUCK`: truck. - `VAN`: van. - `WAGON`: wagon. - `OTHER`: other.
exterior_colorstringThe exterior color of the vehicle.
interior_colorstringThe interior color of the vehicle.
transmissionstringThe transmission type of the vehicle. Enum values: - `AUTOMATIC`: automatic. - `MANUAL`: manual.
drivetrainstringThe drivetrain type of the vehicle. Enum values: - `4X2`: four-wheel drive vehicle with two wheel drive (2WD). The drivetrain delivers power to either the front wheels or the rear wheels. - `4X4`: four-wheel drive vehicle with four wheel drive. The drivetrain delivers power to all four wheels. - `AWD`: all-wheel drive. The drivetrain delivers power to all wheels continuously. - `FWD`: front-wheel drive. The drivetrain delivers power to the front wheels only. - `RWD`: rear-wheel drive. The drivetrain delivers power to the rear wheels only. - `OTHER`: any other drivetrain type not covered above, such as electric vehicles with unique drivetrain styles.
fuel_typestringThe fuel type of the vehicle. Enum values: - `DIESEL`: diesel. - `ELECTRIC`: electric. - `FLEX`: flex fuel, a blend of gasoline and ethanol. - `GASOLINE`: gasoline. - `HYBRID`: hybrid. - `OTHER`: other.
dealerobjectDetailed information about the dealership.
dealer_idstringA unique ID for the dealership.
dealer_namestringThe name of the dealership.
dealer_phonestringThe phone number of the dealership.
stock_numberstringThe stock number assigned to the vehicle by the dealership. The stock number is usually assigned when the vehicle physically arrives at the dealership's lot.
date_first_on_lotstringThe date when the vehicle physically arrives at the dealership's lot, in the format of `YYYY-MM-DD`.
days_on_lotintegerThe number of days the vehicle has been on the dealership's lot.
item_idstringA unique, self-defined ID for the product or service.
listing_idstringA unique ID for the listing.
professionobjectProduct other information.
age_groupstringAge group of products. Enum values:`NEW_BORN`, `INFANT`, `TODDLER`, `KIDS`, `ADULT`. Example: `ADULT`.
colorstringColor of products.
conditionstringCurrent status of products. - For E-commerce and online-to-offline catalog products, the enum values are `NEW`, `REFURBISHED`, and `USED`. - For entertainment catalog products, the enum values are `NEW` and `USED`. - For Auto-Inventory catalog products, the enum values are: - `EXCELLENT`: excellent. - `GOOD`: good. - `FAIR`: fair. - `POOR`: poor. - `OTHER`: other.
genderstringThe targeted gender for the product. The accuracy of this field is important to ensure products are delivered to the intended gender group. Enum values: `MALE`, `FEMALE`, `UNISEX`.
materialstringMaterials used in products, such as cotton, denim or leather.
patternstringPattern or graphic printing on a product.
product_categorystringThe category that the product belongs to. Only the first three levels are required.
shippingstringThe type of shipping for the product. Recommended format: `COUNTRY:STATE:SHIPPING_TYPE: PRICE`. Use ";" to separate different regions. Example: `US:CA:Ground:9.99 USD`.
shipping_weightstringThe shipping weight of the product. The allowed units are `lb`, `oz`, `g`, `kg`. Example: 1 oz, 1 kg.
sizestringSize of the item.
taxstringProduct tax.
offer_typestringThe type of offer.
term_lengthstringThe duration for which the offer applies.
offer_term_qualifierstringThe unit for term of the offer.
amount_pricestringThe amount of the offer.
amount_percentagestringThe percentage for the APR in a finance offer.
amount_qualifierstringThe qualifier for the `amount_price` or `amount_percentage`.
downpaymentstringThe downpayment at the time of purchase or lease.
downpayment_qualifierstringQualifier for the downpayment.
offer_disclaimerstringThe full text of the offer disclaimer to appear in the in-app pop-up.
offer_disclaimer_urlstringA URL that directs users to additional information related to the offer disclaimer, in the format of ` or `
emission_disclaimerstringThe text of the emission disclaimer to appear within the in-app pop-up.
emission_disclaimer_urlstringA URL that directs users to additional information related to the emission disclaimer, in the format of ` or `
emission_overlay_disclaimerstringThe short text of the disclaimer to appear on-screen in the disclaimer banner.
emission_image_linkstringThe link to an image showing the emission level, in the format of ` or `
company_typestringThe company type for the short drama series. Enum values: - `COPYRIGHT_HOLDER`: copyright holder. - `DISTRIBUTOR`: distributor.
copyright_holder_namestringThe name of the copyright holder company.
app_idstringThe App ID of the app to promote in your ads. To obtain a list of App IDs within your ad account, use /app/list/.
minis_idstringMini program ID.
total_episodesnumberThe number of episodes in the short drama series.
initial_paid_episodesnumberThe episode number at which viewers are required to pay to continue watching the short drama series.
per_episode_durationnumberThe average duration of each episode in minutes.
spoken_languagestringThe language that actors in the original short drama series speak. Enum values: - `ar`: Arabic. - `de`: German. - `cs`: Czech. - `en`: English. - `es`: Spanish. - `fr`: French. - `he`: Hebrew. - `hi`: Hindi. - `id`: Indonesian. - `it`: Italian. - `ja`: Japanese. - `ko`: Korean. - `ms`: Malay. - `pl`: Polish. - `pt`: Portuguese. - `ro`: Romanian. - `ru`: Russian. - `ta`: Tamil. - `th`: Thai. - `tr`: Turkish. - `vi`: Vietnamese. - `zh`: Simplified Chinese. - `zh-hant`: Traditional Chinese.
subtitle_languagestringThe language used for the subtitles in the short drama series. Enum values: - `ar`: Arabic. - `de`: German. - `cs`: Czech. - `en`: English. - `es`: Spanish. - `fr`: French. - `he`: Hebrew. - `hi`: Hindi. - `id`: Indonesian. - `it`: Italian. - `ja`: Japanese. - `ko`: Korean. - `ms`: Malay. - `pl`: Polish. - `pt`: Portuguese. - `ro`: Romanian. - `ru`: Russian. - `ta`: Tamil. - `th`: Thai. - `tr`: Turkish. - `vi`: Vietnamese. - `zh`: Simplified Chinese. - `zh-hant`: Traditional Chinese.
production_typestringProduction type, whether the short drama series is locally produced or translated for export. Enum values: - `LOCAL`: Local drama. The short drama features local actors, and the language for actors, narration, and subtitles is the local official language. - `TRANSLATION`: Translated drama. The short drama is packaged for international distribution with added subtitles, narration, and dubbing in another language.
target_audiencestringThe target audience for the short drama series. Enum values: - `MALE`: Male. The short drama is primarily targeted at male audiences, often centered around a male protagonist or narrated from a male perspective. Themes typically include the accumulation of power, wealth, and prestige, the enhancement of abilities, and strategic planning. - `FEMALE`: Female. The short drama is primarily targeted at female audiences, often centered around a female protagonist or narrated from a female perspective. These dramas usually contain elements of romance and love. - `NEUTRAL`: Neutral. The short drama doesn't have a specific gender target audience.
charactersstring[]The list of characters in the short drama series. For enum values, see List of values for `characters`.
genresstring[]The genres of the short drama series as indicated by the main storyline or plot. For enum values, see List of values for mini series `genres`.
historical_contextstring[]The historical background or setting of the short drama series. For enum values, see List of values for `historical_context`.
actorsstring[]The names of the actors in the short drama series.
ratingdoubleThe user rating for the product or service or the listing.
availability_typestringThe method used to define the geographic areas where the product can be sold or the service can be provided. This determines which availability field will take effect during ad delivery. Enum values: - `REGION`: Locations or regions. Set locations or regions where your product or service is available via `availability_region`. - `DMA`: DMAs. Set DMAs where your product or service is available via `availability_dma`. - `RADIUS`: Radius range. Set a custom radius around where your product or service is available via `availability_circle_radius` and `availability_circle_radius_unit`. - `POSTAL_CODE`: Postal code. Set specific postal codes or zip codes where your product or service is available via `availability_postal_codes`.
availability_regionstring[][]Returned when `availability_type` is `REGION`. A list of regions where the product can be sold or the service can be provided. This field is an array of string arrays, where each string array represents a specific location. Example: `[["Arizona","Maricopa","Peoria"],["Alabama","Jefferson","Birmingham"]]` is a valid array containing two location arrays, each with 3 strings under the 499-character limit.
availability_dmastring[]Returned when `availability_type` is `DMA`. A list of DMAs where the product can be sold or the service can be provided. Example: `["501","803"]` (New York and Los Angeles)
availability_circle_radiusstringReturned for an online-to-offline product or when `availability_type` is `RADIUS`. The circle radius of the product or service defining a circular availability area. Example: 20.
availability_circle_radius_unitstringReturned for an online-to-offline product or when `availability_type` is `RADIUS`. The unit for `availability_circle_radius`. Enum values: - `KM`: kilometer. - `MI`: mile.
availability_postal_codesstring[]Returned when `availability_type` is `POSTAL_CODE`. A list of postal codes representing the areas where the product can be sold or the service can be provided. Example: `["10001", "90001"]`.
custom_number_0doubleA custom numeric attribute for product management.
custom_number_1doubleA custom numeric attribute for product management.
custom_number_2doubleA custom numeric attribute for product management.
custom_number_3doubleA custom numeric attribute for product management.
custom_number_4doubleA custom numeric attribute for product management.
priceobjectPrice information.
pricefloatThe base price. For destination catalog products, this field represents the average or lowest price for the destination. The `description` field may provide information on whether this is the average price or the lowest price. For generic catalogs, this field represents the price of a single product or service unit.
currencystringUnit of currency that must match the unit of currency of catalog's target country. If you do not provide it, we will use the default unit of currency of the catalog's target country.
sale_pricefloatThe discounted price.
sale_price_effective_datestring[]Start and end date and time of sale.
landing_pageobjectLanding page information.
landing_page_urlstringURL of the landing page where you can view or purchase the product.
ios_urlstringCustom scheme for iOS apps as URL. For iOS, provide both iPhone & iPad app information if they are different from the regular iOS app.
ios_app_store_idstringApp Store ID for the iOS app.
ios_app_namestringThe iOS App name to display.
iphone_app_store_idstringApp Store ID for the iPhone app.
iphone_app_namestringThe iphone App name to display.
ipad_app_store_idstringApp Store ID for the iPad app.
ipad_app_namestringThe iPad App name to display.
android_urlstringCustom scheme for Android apps as URL.
android_packagestringThe Android package name.
android_app_namestringThe Android App name to display.
extra_infoobjectAdditional information.
custom_label_0stringAdditional information about the products you want to include.
custom_label_1stringAdditional information about the products you want to include.
custom_label_2stringAdditional information about the products you want to include.
custom_label_3stringAdditional information about the products you want to include.
custom_label_4stringAdditional information about the products you want to include.
custom_label_5stringAdditional information about the products you want to include.
custom_label_6stringAdditional information about the products you want to include.
internal_label_0stringAn internal label assigned to the hotel or flight. You can use internal labels to filter items while creating product sets. These labels are exclusively visible to you. Length Limit: 100 characters. If you are using custom labels (`custom_label_0` to `custom_label_4`) for filtering items during product set creation, consider switching to internal labels. Unlike custom labels, internal labels can be added or modified as needed without the need for submitting items for review each time, avoiding potential interruptions in ad delivery.
internal_label_1stringAn internal label assigned to the hotel or flight. You can use internal labels to filter items while creating product sets. These labels are exclusively visible to you. Length Limit: 100 characters. If you are using custom labels (`custom_label_0` to `custom_label_4`) for filtering items during product set creation, consider switching to internal labels. Unlike custom labels, internal labels can be added or modified as needed without the need for submitting items for review each time, avoiding potential interruptions in ad delivery.
image_statusstringStorage status of the product image. Enum values: - `PROCESSING`: The image is being stored. - `SUCCESS`: The image is stored successfully. - `FAIL`: The image is not stored successfully. - `FILTERED`: The image was stored successfully but cannot be used because it does not meet the size requirements (must be equal to or larger than 500 px). For such images, the product audit status (`audit_status`) will stay at `processing` until you upload a new image. - `NOT_SUPPORTED`: The image format is not supported. - `NO_FOUND`: Cannot find the resource via the URL. Please ensure the URL is valid, and the file is publicly accessible.
additional_product_listobject[]Returned when you have configured additional targeting regions for the short drama series. A list of additional targeting region settings for the short drama series of the same `series_id`.
auditobjectAudit information.
audit_statusstringAd audit status. It indicates if the ad promoting the product can be deployed. Enum values: `approved`, `rejected`, `processing`.
rejected_infoobject[]Returned only when `audit_status` is `rejected`. List of rejection reasons.
reasonstringRejection reason.
suggestionstringSuggestions about how to revise to be approved.
affected_placementstring[]List of placements affected by the rejection.
affected_countrystring[]List of countries or regions affected by the rejection.
active_statusstringWhether the product is activated. Enum values: `ACTIVATED`, `DEACTIVATED`. This field represents the advertiser-controlled online or offline status of the product. However, it does not necessarily imply that the product can be used to create ads.
image_statusstringStorage status of the product image. Enum values: - `PROCESSING`: The image is being stored. - `SUCCESS`: The image is stored successfully. - `FAIL`: The image is not stored successfully. - `FILTERED`: The image was stored successfully but cannot be used because it does not meet the size requirements (must be equal to or larger than 500 px). For such images, the product audit status (`audit_status`) will stay at `processing` until you upload a new image. - `NOT_SUPPORTED`: The image format is not supported. - `NO_FOUND`: Cannot find the resource via the URL. Please ensure the URL is valid, and the file is publicly accessible.
product_idstringProduct ID.
series_idstringA unique self-defined ID for the short drama series.
series_namestringThe name of the short drama series.
target_configobjectDetails of the additional targeting region for the short drama series.
region_codestringThe region code of the additional targeting region for the short drama series. Example: `US`.
currencystringCurrency for the additional targeting region for the short drama series. For supported currencies, see the Code column in Budget verification ratio and precision of each currency. Example: `USD`.
image_urlstringThe URL for the short drama series poster image.
rechargeobject[]Information about the recharge for the short drama series.
typestringRecharge type for the short drama series. Enum values: - `BY_TIERS`: Recharge by tiers. - `SUBSCRIPTION`: Recharge by subscription fee for a time period. - `BY_EPISODES`: Recharge by episodes.
purchase_unitstring[]Units for the recharge. When `recharge_type` is `BY_TIERS`, the enum values are: - `TIER 1`: tier 1. - `TIER_2`: tier 2. - `TIER 3`: tier 3. - `TIER 4`: tier 4. - `TIER 5`: tier 5.When `recharge_type` is `SUBSCRIPTION`, the enum values are: - `WEEKLY`: weekly. - `MONTHLY`: monthly. - `QUARTERLY`: quarterly. - `YEARLY`: yearly.When `recharge_type` is `BY_EPISODES`, specify one or more numeric strings that represent numbers no more than the total episode count.
costfloat[]The prices for the tiers, subscription periods, or episodes.
professionobjectProduct other information.
company_typestringThe company type for the short drama series. Enum values: - `COPYRIGHT_HOLDER`: copyright holder. - `DISTRIBUTOR`: distributor.
copyright_holder_namestringThe name of the copyright holder company.
app_idstringThe App ID of the app to promote in your ads. To obtain a list of App IDs within your ad account, use /app/list/.
minis_idstringMini program ID.
total_episodesnumberThe number of episodes in the short drama series.
initial_paid_episodesnumberThe episode number at which viewers are required to pay to continue watching the short drama series.
per_episode_durationnumberThe average duration of each episode in minutes.
spoken_languagestringThe language that actors in the original short drama series speak. Enum values: - `ar`: Arabic. - `de`: German. - `cs`: Czech. - `en`: English. - `es`: Spanish. - `fr`: French. - `he`: Hebrew. - `hi`: Hindi. - `id`: Indonesian. - `it`: Italian. - `ja`: Japanese. - `ko`: Korean. - `ms`: Malay. - `pl`: Polish. - `pt`: Portuguese. - `ro`: Romanian. - `ru`: Russian. - `ta`: Tamil. - `th`: Thai. - `tr`: Turkish. - `vi`: Vietnamese. - `zh`: Simplified Chinese. - `zh-hant`: Traditional Chinese.
subtitle_languagestringThe language used for the subtitles in the short drama series. Enum values: - `ar`: Arabic. - `de`: German. - `cs`: Czech. - `en`: English. - `es`: Spanish. - `fr`: French. - `he`: Hebrew. - `hi`: Hindi. - `id`: Indonesian. - `it`: Italian. - `ja`: Japanese. - `ko`: Korean. - `ms`: Malay. - `pl`: Polish. - `pt`: Portuguese. - `ro`: Romanian. - `ru`: Russian. - `ta`: Tamil. - `th`: Thai. - `tr`: Turkish. - `vi`: Vietnamese. - `zh`: Simplified Chinese. - `zh-hant`: Traditional Chinese.
production_typestringProduction type, whether the short drama series is locally produced or translated for export. Enum values: - `LOCAL`: Local drama. The short drama features local actors, and the language for actors, narration, and subtitles is the local official language. - `TRANSLATION`: Translated drama. The short drama is packaged for international distribution with added subtitles, narration, and dubbing in another language.
target_audiencestringThe target audience for the short drama series. Enum values: - `MALE`: Male. The short drama is primarily targeted at male audiences, often centered around a male protagonist or narrated from a male perspective. Themes typically include the accumulation of power, wealth, and prestige, the enhancement of abilities, and strategic planning. - `FEMALE`: Female. The short drama is primarily targeted at female audiences, often centered around a female protagonist or narrated from a female perspective. These dramas usually contain elements of romance and love. - `NEUTRAL`: Neutral. The short drama doesn't have a specific gender target audience.
charactersstring[]The list of characters in the short drama series. For enum values, see List of values for `characters`.
genresstring[]The genres of the short drama series as indicated by the main storyline or plot. For enum values, see List of values for mini series `genres`.
historical_contextstring[]The historical background or setting of the short drama series. For enum values, see List of values for `historical_context`.
actorsstring[]The names of the actors in the short drama series.
video_urlstringAd video link.
additional_image_urlsstring[]Additional image URLs for the product. Note: The value of this field will be null.
global_trade_item_numberstringThe Global Trade Item Number (GTIN) for the product. Note: The value of this field will be null.
manufacturer_part_numberstringThe Manufacturer Part Number (MPN) for the product. Note: The value of this field will be null.
landing_pageobjectLanding page information. Note: The value of this field will be null.
landing_page_urlstringURL of the landing page where you can view or purchase the product.
extra_infoobjectAdditional information. Note: The value of this field will be null.
custom_label_0stringAdditional information about the products you want to include.
custom_label_1stringAdditional information about the products you want to include.
custom_label_2stringAdditional information about the products you want to include.
custom_label_3stringAdditional information about the products you want to include.
custom_label_4stringAdditional information about the products you want to include.
page_infoobjectPagination information.
pagenumberCurrent page number.
page_sizenumberPage size.
total_numbernumberTotal number of results.
total_pagenumberTotal pages of results.

Response sample

HTTPS/1.1 200 OK
{
"message": "OK",
"code": 0,
"data": {
    "page_info": {
        "total_number": 2,
        "page": 1,
        "page_size": 100,
        "total_page": 1
    },
    "list": [
        {
            "audit": {
                    "audit_status": "rejected",
                    "rejected_info": [
                        {
                            "reason": "The product/service promoted on the ad/landing page belongs to a prohibited industry in your ad targeting location(s) as taking our own business evaluation, users' experience and value of advertisement impact, etc into consideration.",
                            "suggestion": "Please change the promoted product/service in your ad or change the targeting location in your ad group settings according to our policy. https://ads.tiktok.com/help/article?aid=6685586866860720134 Learn More.",
                            "affected_placement": [
                                "PLACEMENT_TIKTOK",
                                "PLACEMENT_PANGLE"
                            ],
                            "affected_country": [
                                "US"
                            ]
                        }
                    ]
                },
            "sku_id": "tiktok_item_12423",
            "product_id": "6872175464299923205",
            "title": "qgs test product",
            "manufacturer_part_number": "",
            "profession": {
                "product_category": "Apparel & Accessories > Clothing > Shirts",
                "color": "red",
                "pattern": "stripes1",
                "material": "cotton",
                "tax": "xxx",
                "shipping_weight": "1 kg",
                "shipping": "US:CA:Ground:9.99 USD",
                "condition": "USED",
                "size": "L"
            },
            "brand": "xiaoru",
            "landing_page": {
                "ios_app_store_id": "https://ios_app_store.com",
                "iphone_app_name": "iphone_app_name",
                "android_package": "a.b.com",
                "iphone_app_store_id": "https://iphone_app_store.com",
                "ios_app_name": "ios_app_name",
                "ipad_app_name": "ipad_app_name",
                "landing_page_url": "https://ads.tiktok.com",
                "android_app_name": "android_app_name",
                "android_url": "https://www.android.com",
                "ios_url": "https://www.ios.com",
                "ipad_app_store_id": "https://ipad_app_store.com"
            },
            "image_url": "http://p1.ipstatp.com/origin/ad-site-i18n/201912265d0d606810c7e88e46248eef",
            "additional_image_urls": [
                "http://p1.ipstatp.com/origin/ad-site-i18n/201912265d0d606810c7e88e46248eef",
                "http://p1.ipstatp.com/origin/ad-site-i18n/201912265d0d606810c7e88e46248eef"
            ],
            "extra_info": {
                "custom_label_1": "b",
                "custom_label_0": "a",
                "custom_label_4": "e"
            },
            "global_trade_item_number": "",
            "video_url": "ad-site-i18n/201911045d0db9f0eb2f8cc14bb4ae1a",
            "google_product_category": "2.22",
            "price": {
                "sale_price_effective_date": [
                    "2017-12-11 04:36",
                    "2017-12-31 12:06"
                ],
                "currency": "USD",
                "price": 100.0,
                "sale_price": 30.0
            },
            "availability": "AVAILABLE_FOR_ORDER",
            "item_group_id": "1.11",
            "description": "qgs test product description"
        },
        {
            "audit": {
                    "audit_status": "processing"
                },
            "sku_id": "tiktok_item_12424",
            "product_id": "6872175464299939589",
            "title": "qgs test product",
            "manufacturer_part_number": "4.44",
            "product_detail": {
                "color": "red",
                "material": "cotton",
                "tax": "xxx",
                "shipping": "US:CA:Ground:9.99 USD",
                "condition": "USED",
                "size": "L"
            },
            "brand": "xiaoru",
            "landing_page": {
                "ios_app_store_id": "https://ios_app_store.com",
                "iphone_app_name": "iphone_app_name",
                "android_package": "a.b.com",
                "iphone_app_store_id": "https://iphone_app_store.com",
                "ios_app_name": "ios_app_name",
                "ipad_app_name": "ipad_app_name",
                "landing_page_url": "https://ads.tiktok.com",
                "android_app_name": "android_app_name",
                "android_url": "https://www.android.com",
                "ios_url": "https://www.ios.com",
                "ipad_app_store_id": "https://ipad_app_store.com"
            },
            "image_url": "http://p1.ipstatp.com/origin/ad-site-i18n/201912265d0d606810c7e88e46248eef",
            "additional_image_urls": [],
            "extra_info": {},
            "global_trade_item_number": "3.33",
            "video_url": "ad-site-i18n/201911045d0db9f0eb2f8cc14bb4ae1a",
            "google_product_category": "2.22",
            "price_info": {
                "sale_price_effective_date": [],
                "currency": "USD",
                "price": 100.0,
                "sale_price": 0.0
            },
            "availability": "AVAILABLE_FOR_ORDER",
            "item_group_id": "1.11",
            "description": "qgs test product description"
        }
    ]
},
"request_id": "2020091405213901023125321411850"
}

Get started

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