Skip to main content

POST Check Product Listing

Check Product Listing Shop Required scope: seller.product.basicor serller.product.optimize Identify any issues with your product properties in advance to ensure your product is ready for listing. Every product must meet TikTok Shop requirements before it can be listed. Before listing, you can submit all relevant product information to this API to check whether a listing meets these requirements. You'll receive a list of issues to resolve before listing. This process helps reduce the risk of failure when creating products. Note:

  • The language used in the product content must align with the target market's language (e.g. don't use Chinese), otherwise the listing will fail or be rejected. Version 202309

POST/product/202309/products/listing_check

Request

Header

PropertiesTypeDescription
content-type RequiredstringAllowed type: application/json
x-tts-access-token RequiredstringThe seller access_token value from Get Access Token, when user_type = 0. Follow this guide to get seller access_token.

Query

PropertiesTypeDescription
app_key RequiredstringEvery single app will have a unique key. Please use the specific key assigned to your app.
sign RequiredstringSignature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders.
timestamp RequiredintUnix timestamp GMT (UTC+00:00). This timestamp is used across all API requests. Developers can use this convert to local time.
is_diagnosis_requiredbool(Deprecated: This field is deprecated and will be removed in a future API version. Use Diagnose and Optimize Product API instead to get listing quality related information.)A flag to indicate whether to return the listing quality information (US only) and optimization diagnosis results for the product. If this is set to false, the response body will exclude the listing_quality and diagnoses objects.Default: true
shop_cipher RequiredstringUse this property to pass shop information in requesting the API. Failure in passing the correct value when requesting the API for cross-border shops will return incorrect response. Get by API Get Authorization Shop

Body

PropertiesTypeDescription
description RequiredstringThe product description in HTML format.Note:- The content must conform to the HTML syntax. All HTML tags are accepted but to optimize display on the TikTok Shop product detail page, the system will automatically convert certain tags into alternative formats, such as rendering tags as images.- Max length: 10,000 characters.- Image guidelines: You must use TikTok Shop image URLs. Max 30 tags, each under 4000px with src, width, and height attributes.Recommendations: - If you are syncing a pre-existing description from another platform, include the full HTML source description here.- Provide a detailed description, ideally over 300 characters.- Include 3-5 key selling points, each under 250 characters, with supporting images.- Use 1600x1600 px for the image dimensions.
category_id RequiredstringThe ID of the category of this product. It must be a leaf category that corresponds to the category tree type specified in the category_version property. Use the Get Categories API to obtain the available categories. Note:- Refer to TikTok Shop Academy for information on product category restrictions.- For the US market, if you are creating products in INVITE_ONLY categories, you must submit a separate application through the Qualification Center on TikTok Shop Seller Center to gain access. Otherwise, even if the product audit is passed, the product will not be listed and made available to buyers. (The product status will be PENDING and the audit status will be PRE_APPROVED)- For the Indonesia market, to list a product on both TikTok Shop and Tokopedia, you must use only categories that are available on both platforms.
brand_idstringThe ID of the brand of this product. Use the Get Brands API to get the list of available brands for a shop.Note: Unauthorized brands won't be displayed on TikTok Shop.
main_images Required[]objectA list of images to display in the product image gallery.- Max count: 9- Arrange your image URIs in the sequence that they should appear on TikTok Shop.- Image dimensions: [300x300 px, 4000x4000 px]Recommendations:- Use a minimum of 5 images.- The first image should have a white background. Use the Optimize Images API to change the background to white.
skus Required[]objectA list of Stock Keeping Units (SKUs) used to identify distinct variants of the product.Note:- Max SKUs for BR, EU, JP, MX, UK, US: 300- Max SKUs for other regions: 100Recommendations: Place the most important variant at the beginning of the array.
title RequiredstringThe product title. Title length:- DE, ES, FR, IE, IT, JP, UK, US: [1, 255] - BR, MX: [1, 300] - Other regions: [25, 255]
is_cod_allowedboolA flag indicating whether to show the Cash On Delivery (COD) payment option during checkout. Use the Get Category Rules API to check if COD is supported for your product category.Applicable only for the following markets:- Global sellers: MY, PH, SA, TH, VN- Local sellers: ID, MY, PH, SA, TH, VNNote: If COD is not supported, the listing will fail if you set this to true.
certifications[]objectThe list of certifications for your product.Max count: 10As per TikTok Shop guidelines, certifications are required for certain restricted product categories. Retrieve the certification requirements for your product from the Get Category Rules API. Refer to TikTok Shop Restricted Products Policy for information on product category restrictions.
package_weightobjectThe weight of the product package.Note:- All the products package weight is mandatory by default, except for products under Virtual Products categories. Get Categories API e.g Digital Games.- Provide the weight measured after packing the product.- This value impacts the shipping cost, so it is important to ensure that dimensions are accurate. Any discrepancies in measurements may lead to additional shipping fees.- The package weight will take precedence over package dimensions in fee calculation if the fee based on weight is higher.
product_attributes[]objectA list of general attributes (e.g. manufacturer, country of origin, materials used) that describe the product as a whole, regardless of variant. Important: The attributes available for use are determined by the system based on the product's assigned category, with some being mandatory. You must provide the product attributes marked as is_required in the response of the Get Attributes API to avoid listing failure.
size_chartobjectThe measurement details of the product to help buyers find the right size.Note: - For certain product categories, size charts may be required or not supported. Use the Get Category Rules API to check the requirements.- If size charts are not supported, even if you provide a size chart here, the size chart will not be saved.- Provide either a TikTok Shop size chart template ID or a size chart image; if both are provided, the ID takes priority.
package_dimensionsobjectThe dimensions of the product package.Note:- Provide the dimensions measured after packing the product.- These values impact the shipping cost, so it is important to ensure that dimensions are accurate. Any discrepancies in measurements may lead to additional shipping fees.- Optional for ID, TH, VN regions.
external_product_idstringAn external identifier used in an external ecommerce platform. This is used to associate the product between TikTok Shop and the external ecommerce platform. Max length: 999 characters
delivery_option_ids[]stringThis field is returned for seller accounts in the following regions only:- ID- MX- MY- PH- SG- TH- VNFor all other regions, this field is NOT used and will NOT be processed if passed for create, edit, or partial edit operations. The custom delivery option IDs to apply to this product if you want to override the default warehouse delivery options. To retrieve the available option IDs, call Get Warehouse Delivery Options with scope=PRODUCT.Note: Leave this field blank to inherit the default delivery options configured for the warehouse.
videoobjectA product introduction or promotion video to display for your product.Recommendations:- Aspect ratio: 1:1 - Resolution: HD 720p or higher- Duration: 20 - 60 seconds
primary_combined_product_idstringIf this product is associated with a virtual bundle, this value is the ID of the primary product in the bundle.Note: Required only for virtual bundle products.
manufacturer_ids[]stringA comma-delimited list of manufacturer IDs. Retrieve the IDs from the Search Manufacturers API.Note: Applicable only for the EU market in certain categories. Use the Get Category Rules API to check the requirements.
responsible_person_ids[]stringA comma-delimited list of responsible person IDs. Retrieve the IDs from the Search Responsible Persons API.Note: Applicable only for the EU market in certain categories. Use the Get Category Rules API to check the requirements.
listing_platforms[]stringThe platforms for listing the product.Possible values:- TOKOPEDIA- TIKTOK_SHOPDefault: TIKTOK_SHOPApplicable only for sellers that migrated from Tokopedia.
shipping_insurance_requirementstringThe shipping insurance purchase requirement imposed on buyers for the product.Possible values:- REQUIRED: Shipping insurance is mandatory and buyers can't opt out.- OPTIONAL: Buyers can choose to purchase shipping insurance through the platform.- NOT_SUPPORTED: Shipping insurance is not supported for the product.Default: OPTIONALApplicable only if the listing platforms include TOKOPEDIA.
is_pre_ownedboolA flag to indicate if the product is pre-owned.Applicable only if TOKOPEDIA is the sole listing platform.Note: To list pre-owned products on the TikTok Shop platform, please specify the ID of one of the designated pre-owned product categories (e.g. pre-owned luxury bags, luggage, and accessories) in category_id.
minimum_order_quantityintThe minimum order quantity for the product.Valid range: [1, 20]Applicable only for the Indonesia market and selected sellers in other SEA markets. Contact your account manager for more information about gaining access to this field.
shipping_template_idstringIdentifier of the shipping template that will be bound to the product
optionobjectoption
scheduled_saleobjectScheduled listing configuration for the product, including whether scheduled listing is enabled and the scheduled listing time.
search_terms[]stringSearch terms (ST words). ST words will not be displayed to consumers; they are only used in search engines to increase your search weight and gain more traffic. Please ensure that ST words are consistent with the product description, with a maximum of 15 terms and a total of no more than 250 characters.
key_product_features[]stringKey Product Features. They will be displayed in the Product highlight module on the product detail page and will be used by search engines to increase your search weight for more traffic. The total number of items should not exceed 5, and the total character count should not exceed 1500.
product_tag_operations[]objectproduct tag to identity special type producteg. "AUCTION"
localestringThe BCP-47 locale codes for displaying category information.Default: The default locale of your shop.Possible values:- cs-CZ- de-AT- de-BE- de-DE- el-GR- en-GB- en-IE- en-US- es-ES- es-MX- fr-FR- fr-BE- hu-HU- id-ID- it-IT- ja-JP- ms-MY- nl-NL- nl-BE- pl-PL- pt-BR- pt-PT- th-TH- vi-VN- zh-CN

Example

CurlGoNode.jsJavaEnable word wrap

Response Parameters

PropertiesTypeDescription
codeintThe success or failure status code returned in API response.
messagestringThe success or failure messages returned in API response. Reasons of failure will be described in the message.
request_idstringRequest log
dataobjectSpecific return information

Example

JSONEnable word wrap

Error Code

View common error codes

| Code | Message | | --- | --- | | 12001000 | product api internal error | | 12019006 | product description is invalid | | 12019011 | product package weight is invalid | | 12019095 | pre_sale.fulfillment_type is missing or empty. | | 12019097 | pre_sale.fulfillment_type.release_date must be set to a non-zero value. | | 12019098 | pre_sale.fulfillment_type.handling_duration_days must be set to a non-zero value. | | 12019099 | The specified pre_sale.type is not supported in your region. Refer to the API documentation for details. | | 12019121 | calculate price error | | 12052003 | Incorrect parcel height format | | 12052004 | Incorrect parcel width format | | 12052005 | Incorrect parcel length format | | 12052023 | Category does not exist | | 12052024 | Category is not final category | | 12052084 | The provided currency is not available for this shop/region. | | 12052220 | This category is prohibited or unsupported on TikTok Shop. Select another category. | | 12052223 | This category is restricted. To sell in this category, apply through the Qualification Center in Seller Center. | | 12052226 | This category is restricted. To sell in this category, apply through the Qualification Center in Seller Center. | | 12052300 | product main image uri illegal | | 12052356 | The number of 'supplementary_sku_images' for the sales attribute value exceeds the maximum limit. | | 12052357 | 'supplementary_sku_images' is only allowed when 'sku_img' is specified. Add an image to 'sku_img' and try again. | | 12052446 | Category is not open in this market | | 12052520 | product sale property image uri illegal | | 12052650 | product qualification image uri illegal | | 12052670 | The size chart image URI is invalid. Note: API users must use the URI generated by the Upload Product Image API. | | 12052700 | The seller is inactive. | | 12052722 | The image URI does not exist in TikTok Shop. | | 12052881 | identity internal error | | 36009003 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. | | 12052910 | Invalid input parameters. Refer to the API documentation for details. | | 12052915 | package weight unit and dimension unit miss match. | | 12052916 | The package unit is not supported in the current region. | | 12052931 | The title must follow these formatting rules: it cannot contain HTML escape characters (e.g.,  ), emojis, or ASCII control characters (e.g., \u007F). It also cannot consist solely of symbols (e.g., //// or !@#$$$&), nor can it have more than 9 consecutive repeated characters (e.g., aaaaaaaaa or 111111111). | | 12052932 | The description must follow these formatting rules: it cannot contain HTML escape characters (e.g.,  ), emojis, or ASCII control characters (e.g., \u007F). It also cannot consist solely of symbols (e.g., //// or !@#$$$&), nor can it have more than 9 consecutive repeated characters (e.g., aaaaaaaaa or 111111111). | | 12052933 | Sales attribute names must follow these formatting rules: it cannot contain HTML escape characters (e.g.,  ), emojis, or ASCII control characters (e.g., \u007F). It also cannot consist solely of symbols (e.g., //// or !@#$$$&), nor can it have more than 9 consecutive repeated characters (e.g., aaaaaaaaa or 111111111). | | 12052934 | Sales attribute value names must follow these formatting rules: it cannot contain HTML escape characters (e.g.,  ), emojis, or ASCII control characters (e.g., \u007F). It also cannot consist solely of symbols (e.g., //// or !@#$$$&), nor can it have more than 9 consecutive repeated characters (e.g., aaaaaaaaa or 111111111). | | 12052935 | Product attribute value names must follow these formatting rules: it cannot contain HTML escape characters (e.g.,  ), emojis, or ASCII control characters (e.g., \u007F). It also cannot consist solely of symbols (e.g., //// or !@#$$$&), nor can it have more than 9 consecutive repeated characters (e.g., aaaaaaaaa or 111111111). |

Is this content helpful?Helpful

Not Helpful

PreviousNext