Skip to main content

PUT Partial Edit Global Product

Partial Edit Global Product Seller Required scope: seller.product.basic Description of [POST]/product/:version/Partial_Edit_Global_Product Version 202509

PUT/product/202509/global_products/{global_product_id}/partial_edit

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
titlestringThe product title. Title length:- DE, ES, FR, IE, IT, JP, UK, US: [1, 255] - MX:[1,300] - Other regions: [25, 255]
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.
category_idstringThe 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[]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 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_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 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_versionstringThe category tree version to assign this product to.Possible values based on region:- US: v2, represents the 7-level category tree. Important: If the seller account contains an active US shop, 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 | | --- | --- | | Empty. No business logic error codes. |

Is this content helpful?Helpful

Not Helpful

PreviousNext