新
Properties | Type | Description |
---|---|---|
content-type Required | string | Allowed type: application/json |
x-tts-access-token Required | string | The seller access_token value from Get Access Token, when user_type = 0. Follow this guide to get seller access_token. |
Properties | Type | Description |
---|---|---|
shop_cipher Required | string | Use 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. |
Properties | Type | Description |
---|---|---|
save_mode | string | Indicates how the product should be saved. Possible values: - AS_DRAFT: Save the product as a draft for future editing. - LISTING: Immediately list the product in the shop. Default: LISTING |
description Required | string | The 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 <table> tags as images. - Max length: 10,000 characters. - Images must use TikTok Shop image URLs, not exceed 4000px, and include 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 Required | string | The 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 find out if a category is a leaf category in a particular category_version. Note: - For the US market, refer to TikTok Shop Restricted Products Policy for information on product category restrictions. - 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_id | string | The ID of the brand of this product. Note: Unauthorized brands won't be displayed on TikTok Shop. |
main_images Required | []object | A list of images to display in the product image gallery. Use the Upload Product Image API to upload the images first and obtain the corresponding image URI. Note: - Max number of image URIs: 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 | []object | A list of Stock Keeping Units (SKUs) used to identify distinct variants of the product. Note: - Max SKUs for the US and MX: 300 - Max SKUs for other regions: 100 Recommendations: Place the most important variant at the beginning of the array. |
title Required | string | The product title. Title length: - For the US, UK, ES, and IE: [1, 255] - For MX: [1, 300] - For other regions: [25, 255] |
is_cod_allowed | bool | A flag indicating whether to show the Cash On Delivery (COD) payment option during checkout. Note: If COD is not supported, the listing will fail if you set this to true. |
certifications | []object | The list of certifications for your product. As 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_dimensions | object | The 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. |
product_attributes | []object | A list of general attributes (e.g. manufacturer, country of origin, materials used) that describe the product as a whole, regardless of variant. Note: The attributes available for use are determined by the system based on the product's assigned category, with some being mandatory. Retrieve the product attributes by using the Get Attributes API. |
package_weight Required | object | The weight of the product package. Note: - Provide the weight measured after packing the product. - This value impact 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. |
video | object | A product introduction or promotion video to display for your product. Recommendations: - Aspect ratio: 1:1 - Resolution: HD 720p or higher - Duration: 20 - 60 seconds |
external_product_id | string | An 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 | []string | The ID of the delivery options available for your product, delimited by commas. |
size_chart | object | The 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. |
primary_combined_product_id | string | If this is a combined listing product, this is the ID of the primary product. Note: - All products in a combined listing must belong to the same category as the primary product. - Required only for combined listing products. |
is_not_for_sale | bool | A flag indicating whether the product is not for sale and only available through Gift with Purchase (GWP) promotions. Such products won't appear in searches or recommendations True: Not for sale False: For sale |
category_version | string | The category tree version to assign this product to. Possible values based on region: - US: v2, represents the 7-level category tree. Important: For US shops, you must pass v2 when using this API. - Other regions: v1, represents the 3-level category tree. Default: v1 |
manufacturer_ids | []string | Note: Required for the EU market. |
responsible_person_ids | []string | A comma-delimited list of responsible person IDs. Retrieve the IDs from the Search Responsible Persons API. Note: Required and applicable only for the EU market. |
listing_platforms | []string | The platforms for listing the product. Possible values: - TOKOPEDIA - TIKTOK_SHOP Default: TIKTOK_SHOP Applicable only for sellers that migrated from Tokopedia. |
shipping_insurance_requirement | string | The 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: OPTIONAL Applicable only if the listing platforms include TOKOPEDIA. |
minimum_order_quantity | int | The 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. |
is_pre_owned | bool | A 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. |
Properties | Type | Description |
---|---|---|
code | int | The success or failure status code returned in API response. |
message | string | The success or failure messages returned in API response. Reasons of failure will be described in the message. |
request_id | string | Request log |
data | object | Specific return information |
Code | Message |
---|---|
12001000 | product api internal error |
12019006 | product description is invalid |
12019011 | product package weight is invalid |
12019012 | product package size is invalid |
12019013 | brand id is invalid |
12052002 | Incorrect category format |
12052006 | Incorrect parcel weight format |
12052013 | The product description cannot exceed maximum characters |
12052015 | The product description is required |
12052023 | Category does not exist |
12052024 | Category is not final category |
12052025 | The category is invalid |
12052026 | Brand does not exist |
12052028 | Main product image is required |
12052048 | You can't edit other sellers' products. |
12052050 | A single product cannot have more than 100 different SKUs |
12052051 | The product name exceed max limit characters |
12052054 | The seller SKU text length cannot exceed max limit characters |
12052055 | The SKU stock exceed limit. |
12052056 | The num of image in description cannot exceed max limit |
12052073 | The product price is invalid |
12052084 | region to currency does not exist |
12052092 | product sale price is invalid |
12052093 | seller create product over limit |
12052094 | No multiple warehouse permission |
12052096 | The warehouse is required |
12052097 | The warehouse does not exist |
12052104 | property is required |
12052105 | required qualification miss |
12052115 | seller has no warehouse |
12052116 | product package size is invalid |
12052128 | Size chart not found |
12052151 | product property value contain restricted words |
12052152 | sale property name contains restricted words |
12052153 | sale property value contains restricted words |
12052159 | unique item total quantity must be one |
12052162 | unique item sku count must be one and disable varialbes |
12052181 | The package weight of the product can not be zero. |
12052182 | The '{{sub_property_name}}' field is required as you've selected '{{parent_property_value}}' for '{{parent_property_name}}'. |
12052183 | The '{{sub_property_name}}' field should be left empty as you've selected '{{parent_property_value}}' for '{{parent_property_name}}'. |
12052200 | brand is expired |
12052201 | brand does not comply with nice classification |
12052208 | A brand authorization is required to publish this listing. |
12052219 | instant product not support not for sale |
12052220 | The category status is unavailable. |
12052221 | Only whitelisted sellers are permitted to trade under current category |
12052222 | category do not support cod |
12052223 | the category is unauthorized. |
12052225 | This category status is not available because this category is not within the main category of the store. You do not have permission to use it for this purpose. Please contact AM to apply or re-select the category of the available status. |
12052226 | the category is unauthorized. |
12052227 | the category is unauthorized or unavailable |
12052228 | combo product not support not for sale |
12052229 | pre order product not support not for sale |
12052230 | category version and categoryID are not matched |
12052238 | The length of the url is greater than 200 |
12052240 | Do not support custom property. |
12052241 | attribute name or attribute id is empty. |
12052242 | The attribute name characters cannot exceed max_limit |
12052243 | The product attribute or sale attribute name characters contain Chinese. |
12052244 | The attribute name duplicate. |
12052245 | The product attributes contained invalid characters. Please modify and re-submit. |
12052246 | The attribute not support multi selected. |
12052247 | Do not support custom product attribute. |
12052248 | The {{property_type}} value name or attribute value id is empty. |
12052249 | The {{property_type}} value name characters cannot exceed {{max_limit}}, attribute value name is :{{property_value_name}}. |
12052250 | The {{property_type}} value name characters contain Chinese. |
12052251 | The attribute value name duplicate. |
12052253 | Duplicate attribute value id |
12052254 | Duplicate attribute id |
12052256 | The {{property_name}} value need to be positive integers or positive decimals . |
12052260 | product id not exist |
12052261 | product name is empty |
12052262 | Chinese characters are not supported in product name |
12052263 | product name prefix illegal |
12052269 | The selected time is outside the limit |
12052282 | Product manufacturer is required. |
12052287 | Product responsible person is required |
12052300 | product main image uri illegal |
12052301 | Width and length of main image must be at least {{min_limit}}, check uri {{uri}} |
12052302 | The main images size exceed limit. |
12052304 | Main product image format not support. |
12052305 | The main images aspect ratio cannot exceed max limit. |
12052306 | main product images count exceed limit |
12052324 | Product description image file format is not supported |
12052340 | product description image uri illegal |
12052341 | The description images size cannot exceed limit. |
12052342 | The description images space cannot exceed limit. |
12052343 | Product description image format not support. |
12052344 | The product description html syntax with error |
12052345 | The product description html tag not support. |
12052346 | The product description has Chinese characters |
12052348 | The product description html tag required attribute is miss. |
12052349 | The product description html tag not support nest. |
12052350 | The product description html tag contain illegal attribute. |
12052352 | The product description nest exceeding limit |
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. |
12052360 | The video id is not exist. |
12052402 | seller shipping template is empty |
12052403 | logistics service unreachable |
12052404 | multi-warehouse not support customize logistics service |
12052405 | The warehouse has not opened the subscribed logistics service |
12052420 | warehouse didn't set logistics service |
12052520 | product sale property image uri illegal |
12052521 | The sale property images size over limit. |
12052522 | Product sale property image is required |
12052523 | Product sale property image format not support. |
12052524 | The sale property image aspect ratio invalid |
12052525 | The attribute max num cannot exceed 3. |
12052526 | The attribute value max num over limit. |
12052527 | The sale attribute id not exist. |
12052528 | Just allow one sale property contain image. |
12052529 | The property value id not exist. |
12052530 | warehouse id not belong seller |
12052531 | warehouse status invalid |
12052532 | the warehouse not delivery warehouse |
12052535 | Couldn't publish this product as you haven't set the return warehouse for your shop. Add the return warehouse information on TikTok Shop Seller Center first and try again. |
12052550 | SKU property must contain all properties |
12052554 | sku name contain Chinese characters |
12052560 | The SKU contains duplicate sales attribute. |
12052570 | product price exceed limit |
12052591 | Invalid number of digits of identifier code |
12052592 | Identifier code already entered, cannot enter the same code twice |
12052598 | Only the last digit supports input X |
12052600 | The identifier code type must be selected |
12052650 | product qualification image uri illegal |
12052655 | qualification id not exist |
12052656 | qualification id duplicate |
12052657 | qualification image and pdf file is out of limit. |
12052658 | product qualification file uri illegal |
12052670 | product sizechart image uri illegal |
12052671 | The sizechart images size over limit. |
12052673 | Product sizechart image is required |
12052700 | seller is inactived |
12052701 | do not support cross-boarder seller create local product directly |
12052703 | Invalid seller tax number |
12052704 | seller id not exist |
12052831 | The number of sub-skus contained in each combo sku cannot exceed {{max_limit}}. |
12052832 | The sub-SKU coefficient associated with each combo SKU cannot exceed {{max_limit}}, and cannot less {{min_limit}}. |
12052834 | The number of combo sku associated with a sku cannot exceed limit. |
12052835 | Sub product ID not exist |
12052836 | The category of the combo is inconsistent with the category of the main sub-product. |
12052838 | The first-level categories of the sub-products in the combo are inconsistent |
12052841 | The sub-sku relationship corresponding to different combo sku cannot be duplicated. |
12052842 | The combo does not include the main sub-product |
12052844 | The sub-sku is not in the sub-product |
12052845 | Failed to create, does not support non-live status product |
12052846 | combo does not support adding this product type |
12052849 | You don't have the permission to operate combo. |
12052853 | The sale property of combo mismatch. |
12052854 | The sale property of combo is not unique. |
12052857 | Combined products and normal products cannot be converted to each other. |
12052859 | When the combined SKU is only associated with one sub-SKU, the coefficient of this sub-SKU cannot be less than 2. |
12052863 | All SKU of a combined product need to be the combined SKU. |
12052881 | identity internal error |
12052900 | System error, try again later |
12052910 | invalid params |
12052915 | package weight unit and dimension unit miss match. |
12052923 | contact info required |
12052990 | check failed |
12052992 | no permission to create gift product |