Skip to main content

POST Partial Edit Product

Partial Edit Product Shop Required scope: seller.product.write Edit some properties (e.g. description, images, attributes) of a product that is not in the FREEZE or DELETED state. After editing the product, the latest product content (referred to as v2) will be resent for audit review. If the audit passes, v2 is published to the shop, otherwise, the existing product stays live and remains unchanged (keeping v1). However, edits to the price or inventory fields do not require a reaudit and will be immediately published on the platform. Use the Product status change

webhook to keep track of the review status. Note:

  • This API is applicable for all sellers.
  • There may be a limit to the number of products you can relist per day. We recommend prioritizing key products first to ensure they get published. You can find your listing limit on the Seller Center homepage.
  • If a draft or audit-review version exists, unedited fields will retain their values over those of the base (live) version.
  • Updates are handled per top-level property, so all non-empty fields within an updated object must be supplied to prevent overwriting with blanks. For top-level properties (e.g. description, brand_id) that are not nested in an object, you can update them individually. Omitting these properties in the request will leave them unchanged. If you need to edit any nested property within an object, you must provide values for all nested properties of that object. Any omitted nested properties will be overwritten with blanks.
  • If new mandatory product attributes were added by TikTok Shop after the creation of your product, ensure that you provide these attributes too. For global sellers: If you're using the local replication listing method, note the following sync rules: Sales attribute changes (in sales attribute id/name) must be synced to other markets. Therefore, you must provide the seller_sku and complete replicated_products data. The API call will fail if you don't provide these details. *New SKUs (new sales attribute value id/name) are optional to sync to other markets. To sync, please provide the seller_sku and complete replicated_products data. General changes are optional to sync to other markets. To sync, you only need to provide replicated_products.region. For Tokopedia sellers: Note that a product can have only one active version across all platforms at any time. If a product is live on both platforms, audit results for the latest version are handled as follows:
  • Mixed audit results: If the product passes audit on one platform but fails on another, on the successful platform, the product will stay live and be updated with content from the latest version (v2), while on the failed platform, the product will be deactivated and hidden entirely.
  • Audit failure on all platforms: If the product fails audit on all platforms, the existing product stays live and remains unchanged (keeping v1). Version 202509

POST/product/202509/products/{product_id}/partial_edit

Request

Path

PropertiesTypeDescription
product_id RequiredstringThe product ID in TikTok Shop.

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.
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
save_modestringIndicates 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: LISTINGNote: - Saving as draft is not supported in the following cases: - The product status is DELETED. - The product status is PENDING or FREEZE on any listing platform.- If you are saving a post-live draft with save_mode=AS_DRAFT, inventory and delivery_option_ids fields are not supported and will not be saved.
descriptionstringThe 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.
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[]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[]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.
titlestringThe 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:- 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.
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
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
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_SHOPApplicable only for sellers that migrated from Tokopedia.IMPORTANT: This field controls the product's visibility on the listing platforms.- If the product is live on both platforms but the request contains only 1 platform, the product will be deactivated and hidden from the omitted platform.- If the product is live on 1 platform but the request contains a different platform, the product will be deactivated and hidden from the omitted platform.- If you want to deactivate the product on both platforms, use the Deactivate Product API.
replicated_products[]objectThe list of local market replicas to which updates should be synced. As this is a partial edit endpoint, only updated fields will be synced.Compulsory sync- Sales attribute changes (in sales attribute id/name) must be synced to other markets. Therefore, you must provide the seller_sku above and complete the details in this object. The API call will fail if you don't provide these details.Optional sync- *New SKUs (new sales attribute value id/name) are optional to sync to other markets. To sync, please provide the seller_sku above and complete the details in this object.- General changes are optional to sync to other markets. To sync, you only need to provide replicated_products.region.
subscribe_info_editobjectAll of the Save and Subscribe discount details.
scheduled_saleobjectScheduled listing configuration for the product, including whether scheduled listing is enabled and the scheduled listing time.
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
auto_translate_enabledboolThe field works only if products need to list with more than one languages in determined country, otherwise it does not need to fill in.
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.
inventory_modestringDefines the inventory mode for the duplicated source product. This parameter supports two modes: SHARED and EXCLUSIVE. - SHARED: In this mode, the inventory of all interconnected (shared) products must be strictly consistent; otherwise, an error will be returned.- EXCLUSIVE: In this mode, the inventory for each product can be set independently without affecting others. Applicability:This feature is applicable ONLY for the EU market. Default Value:If left empty, the system defaults to the EXCLUSIVE mode.
category_versionstringFilter categories by the category tree version.Possible values based on region:- US, EU and SEA: v2, represents the 7-level category tree. Important: For US, EU and SEA shops, you must pass v2 when using this API.- Other regions: v1, represents the 3-level category tree.Default: v1

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 | | --- | --- | | 12019011 | product package weight is invalid | | 12019022 | SKU must contain a valid warehouse. | | 12019060 | package_dimension_unit field is for America market(US) only. | | 12019094 | Conflicting presale fields. Remove pre_sale.fulfillment_type if you want to set pre_sale.type to NONE. | | 12019096 | The value for pre_sale.type is missing. | | 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. | | 12019100 | All SKUs of a product must have the same pre_sale.type. Do not assign different values. | | 12052003 | Incorrect parcel height format | | 12052004 | Incorrect parcel width format | | 12052005 | Incorrect parcel length 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 | | 12052031 | Invalid product ID(s) found | | 12052032 | The product does not exist | | 12052038 | Product price locked due to ongoing promotion. | | 12052048 | You cannot edit the specified product(s) as it isn't listed in your account or shop. | | 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 inventory quantity for the warehouse must be within allowed limits. | | 12052056 | The num of image in description cannot exceed max limit | | 12052073 | The product price is invalid | | 12052084 | The provided currency is not available for this shop/region. | | 12052092 | product sale price is invalid | | 12052094 | No multiple warehouse permission | | 12052096 | Unable to update the price for SKUs with no warehouse. Assign a warehouse and try again. | | 12052104 | property is required | | 12052105 | required qualification miss | | 12052115 | seller has no warehouse | | 12052116 | product package size is invalid | | 12052128 | Size chart not found | | 12052144 | platform warehouse not support to edit | | 12052151 | product property value contain restricted words | | 12052152 | sale property name contains restricted words | | 12052153 | sale property value contains restricted words | | 12052157 | One or more of the product attributes cannot be edited by cross-border sellers | | 12052159 | unique item total quantity must be one | | 12052160 | sku count must be one and disable variables | | 12052163 | The gift product are not allowed to be edited | | 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 | You are not authorized to sell this brand in this category. To do so, apply through the Qualification Center in Seller Center. | | 12052208 | A brand authorization is required to publish this listing. | | 12052216 | manufacturer info is invalid | | 12052220 | This category is prohibited or unsupported on TikTok Shop. Select another category. | | 12052221 | Only whitelisted sellers are permitted to trade under current category | | 12052222 | category do not support cod | | 12052223 | This category is restricted. To sell in this category, apply through the Qualification Center in Seller Center. | | 12052225 | You are not authorized to sell in this category because it does not fall under your shop's main category. Contact your account manager for help or select another category. | | 12052226 | This category is restricted. To sell in this category, apply through the Qualification Center in Seller Center. | | 12052227 | the category is unauthorized or unavailable | | 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 {{property_type}} not support multi selected, attribute id is :{{property_id}}. | | 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 | Duplicated attribute values found for an attribute. Remove or modify the duplicated value. | | 12052253 | Duplicate attribute value id | | 12052254 | Duplicate attribute id | | 12052256 | The {{property_name}} value need to be positive integers or positive decimals . | | 12052260 | The product ID does 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 | | 12052273 | After the pre-sale product has been onlive product, the pre-sale info cannot be modified. | | 12052282 | Product manufacturer is required. | | 12052283 | The number of manufacturers cannot exceed the allowed limits. | | 12052284 | Manufacturer ID {{manufacturer_id}} is not found | | 12052285 | Manufacturer ID {{manufacturer_id}} is not associated with the seller | | 12052287 | Product responsible person is required | | 12052288 | The number of responsible person ids cannot exceed {{max_limit}}, and cannot less {{min_limit}}. | | 12052289 | Responsible person ID {{rp_id}} is not found | | 12052290 | Responsible person ID {{rp_id}} is not associated with the seller | | 12052292 | The number of extra identification codes cannot exceed the allowed limits. | | 12052294 | The format of the extra identification code is incorrect. | | 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 | | 12052307 | skus in the lottery cannot be deleted | | 12052308 | There's an ongoing appeal. If you wish to edit product details, please revoke the appeal first. | | 12052314 | Standard product cannot be converted to MTO product | | 12052315 | Standard product cannot be converted to preorder product | | 12052316 | product second hand not applicable in this sale platform | | 12052324 | Product description image file format is not supported | | 12052329 | A pre-order product can't be changed to a regular product | | 12052330 | product is not supported to list in designated sale platform | | 12052332 | The seller center is locked during shop integration, only editing stock and price is allowed | | 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. | | 12052359 | save subscribe not support | | 12052360 | The video id is not exist. | | 12052361 | This base unit value count is not supported. The supported base unit values can be obtained from the Get Attribute API. | | 12052362 | SKU unit count is required. | | 12052365 | The manufacturer lacks language version information for this market. | | 12052366 | The responsible person lacks language version information for this market. | | 12052371 | Auction product is bidding when it is not supported to change product info | | 12052375 | product list price is invalid | | 12052376 | list price not support | | 12052382 | Can't edit Dilayani Tokopedia warehouse quantity | | 12052383 | product list price exceed limit | | 12052385 | Please enter valid certificate expiration date | | 12052393 | Product locked for Promotion and stock can't be updated below current stock | | 12052402 | seller shipping template is empty | | 12052403 | The warehouse does not support fulfillment for the current shop. | | 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 | You can add images to only 1 product variation, which will serve as the primary variation for display in the product options gallery. | | 12052529 | The property value id not exist. | | 12052530 | The warehouse ' {{warehouse ID}} ' does not belong to this shop/seller. | | 12052531 | The warehouse is disabled. | | 12052532 | the warehouse not delivery warehouse | | 12052533 | Removal, addition, and change of warehouses are not permitted. Please specify the original warehouses for the SKUs. | | 12052534 | warehouse unable to delete | | 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 | | 12052557 | The SKU ID does not belong to the product. | | 12052558 | Number of product skus exceed limit. | | 12052559 | The product with duplicate default sku. | | 12052560 | The SKU contains duplicate sales attribute. | | 12052570 | product price exceed limit | | 12052571 | Missing price for SKU(s) | | 12052572 | the sale price is invalid | | 12052574 | unit price config is invalid | | 12052591 | Invalid number of digits of identifier code | | 12052592 | Identifier code already entered, cannot enter the same code twice | | 12052593 | The identifier code cannot be changed once be submitted | | 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. | | 12052670 | The size chart image URI is invalid. Note: API users must use the URI generated by the Upload Product Image API. | | 12052673 | Product sizechart image is required | | 12052700 | The seller is inactive. | | 12052702 | seller does not support pre-order | | 12052703 | Invalid seller tax number | | 12052704 | seller id not exist | | 12052706 | The minimum sales quantity should not be exceed limit | | 12052712 | sku's pre_order is invalid | | 12052722 | The image URI does not exist in TikTok Shop. | | 12052805 | Bundle does not support adding this product type | | 12052842 | The combo does not include the main sub-product | | 12052846 | combo does not support adding this product type | | 12052847 | The combo sku relationship cannot be changed | | 12052849 | You don't have the permission to operate combo. | | 12052863 | All SKU of a combined product need to be the combined SKU. | | 12052864 | Unable to add deactivated SKUs to the combined product. | | 12052881 | identity internal error | | 36009003 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. | | 12052901 | The product in its current status is not available for this operation. Change the product status and try again. | | 12052902 | The SKU list is empty. Either omit the list entirely, or provide all required details. | | 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. | | 12052921 | Couldn't edit the inventory quantity because this product shares the inventory with the source shop | | 12052922 | edit fields limit | | 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). | | 12052994 | seller is not toko seller | | 12052995 | seller has not finished onboarding to tts |

Is this content helpful?Helpful

Not Helpful

PreviousNext