Skip to main content

PUT Edit Global Product

Edit Global Product Seller Required scope: seller.global_product.write Edit all properties (e.g. description, brand, images, attributes) of a global product. IMPORTANT: For published products, the changes will be automatically retranslated and synced to all markets where the product is published. If you have already edited the product information or translations of the associated local products, they will be overwritten by the information in this API. For example, if you have customized the local prices such as the local pre-tax price or the local display price, they will be overwritten each time this API is called. Note:

  • 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.
  • All inputs, including blanks, in the request payload will overwrite existing values. To retain an existing value, make sure to include it in your request. Therefore, it is strongly recommended to retrieve the latest product data using Get Global Product

and submit the complete data when editing. This ensures accuracy and helps avoid errors or unintentional data loss due to missing fields.

  • 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

PUT/product/202309/global_products/{global_product_id}

Request

Path

PropertiesTypeDescription
global_product_id RequiredstringThe global product ID generated by 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.

Body

PropertiesTypeDescription
title RequiredstringThe product title. Title length:- DE, ES, FR, IE, IT, JP, UK, US: [1, 255] - MX:[1,300] - Other regions: [25, 255]
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. - It must be a main category (categories.permission_statuses=AVAILABLE in Get Global Categories API).Note: Refer to TikTok Shop Academy for information on product category restrictions.
brand_idstringThe ID of the brand of this product.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 global Stock Keeping Units (SKUs) used to identify distinct variants of the product.Note:- Max SKUs for EU, JP, UK, US: 300- Max SKUs for other regions: 100Recommendations: Place the most important variant at the beginning of the array.
package_weight RequiredobjectThe 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 the measurements are accurate. Any discrepancies 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.
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 Global Category Rules API. Refer to TikTok Shop Restricted Products Policy for information on product category restrictions.
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 may lead to additional shipping fees.
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 Global Attributes API.
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 Global 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.
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
manufacturerobject(Deprecated: This field is deprecated and will be removed in a future API version. Use manufacturer_ids instead.)The product manufacturer's details.
manufacturer_ids[]stringA comma-delimited list of manufacturer IDs. Retrieve the IDs from the Search Manufacturers API.Default: The IDs provided when the global product was created.Note: Applicable only for the EU market in certain categories. Use the Get Global 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.Default: The IDs provided when the global product was created.Note: Applicable only for the EU market in certain categories. Use the Get Global Category Rules API to check the requirements.
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
external_global_product_idstringAn external identifier used in an external ecommerce platform. This is used to associate the global product between TikTok Shop and the external ecommerce platform. Max length: 999 characters

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 | | --- | --- | | 36009003 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. | | 12019010 | product price is invalid | | 12019011 | product package weight is invalid | | 12019013 | brand id is invalid | | 12019016 | Unable to publish or sync products to target markets due to missing or invalid warehouse details. | | 12019064 | No matching categories. Provide the full name of your product, edit its product properties, and try again. | | 12019113 | product status is invalid | | 12019114 | Seller has no permission | | 12019117 | Missing variations (sales attributes). When there are multiple SKUs in a product, each SKU must include variation (sales attribute) details that explain how it is different from other SKUs in the product. | | 12019121 | calculate price error | | 12019150 | The product ID does not exist. | | 12052012 | Incorrect price format | | 12052013 | The product description cannot exceed maximum characters | | 12052015 | The product description is required | | 12052016 | The parcel weight is required | | 12052023 | Category does not exist | | 12052024 | Category is not final category | | 12052026 | Brand does not exist | | 12052028 | Main product image is required | | 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. | | 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 | | 12052116 | product package size is invalid | | 12052142 | no permission of multi global warehouse | | 12052143 | sku warehouse must equal | | 12052145 | activity warehouse not allowed to be deleted | | 12052146 | The specified inventory quantity is too low. It must be greater than the locked quantity (e.g. for committed orders, campaigns, creators) to ensure a non-negative available stock. | | 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. | | 12052217 | All region shops must use V2 categories. Check the documentation for further details. | | 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 | | 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 | | 12052230 | Category version and categoryID are not matched. | | 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. | | 12052254 | Duplicate attribute id | | 12052260 | The product ID does not exist | | 12052261 | product name is empty | | 12052262 | Chinese characters are not supported in product name | | 12052266 | The product name contains non-English characters. | | 12052282 | Product manufacturer is required. | | 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}}. | | 12052290 | Responsible person ID {{rp_id}} is not associated with the seller | | 12052296 | Duplicate responsible person IDs associated with the same product | | 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. | | 12052303 | The algo prediction for category v2 of this product failed | | 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. | | 12052351 | The product description contains non-English characters. | | 12052360 | The video id is not exist. | | 12052379 | the cover region of share warehouse can not cover the the product region | | 12052401 | package weight exceed limit. | | 12052447 | You still have stock reserved for campaigns in your Chinese warehouse(s), so you cannot add an overseas warehouse yet. If you have an overseas warehouse, you must use it to fulfill orders for your {{country}} shop. | | 12052448 | Local fulfillment is required for {{country}} shop. You must have at least one {{country}} overseas warehouse for it. | | 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. | | 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. | | 12052550 | SKU property must contain all properties | | 12052554 | sku name contain Chinese characters | | 12052570 | product price exceed limit | | 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 | | 12052594 | The identifier code type 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 | | 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. | | 12052701 | do not support cross-boarder seller create local product directly | | 12052702 | seller does not support pre-order | | 12052703 | Invalid seller tax number | | 12052704 | seller id not exist | | 12052901 | The product in its current status is not available for this operation. Change the product status and try again. | | 12052910 | Invalid input parameters. Refer to the API documentation for details. | | 12052912 | No matching category found within your account's main category. Check your main category in the seller profile on Seller Center and ensure your product falls within its scope. |

Is this content helpful?Helpful

Not Helpful

PreviousNext