Retrieve all properties of a global product that is in the “DRAFT”, “UNPUBLISHED”, or “PUBLISHED” status, and the corresponding local product IDs in the published markets.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Global product ID
Responses
Section titled “Responses”Success
object
Status code; 0 means success.
Success or failure message.
Request log ID.
object
The global product ID in TikTok Shop.
The product title.
A list of images to display in the product image gallery.
object
The image height. Unit: px
The image width. Unit: px
The URI of the image.
Product video information.
object
The video ID.
The product description in HTML format.
The dimensions of the product package.
object
The package length.
The package width.
The package height.
The unit for the package dimensions.
The weight of the product package.
object
The package weight.
The unit for the package weight.
The list of certifications for your product.
object
The ID to identify the type of certification required for the product category.
The title of the certification type.
A list of certification related files.
object
The ID of the certification file.
The URLs to view the certification files.
The name of the certification file
The format of the certification file.
A list of certification related images.
object
The image height. Unit: px
The image width. Unit: px
The URI of the image.
A list of global Stock Keeping Units (SKUs) used to identify distinct variants of the product.
object
The global SKU ID in TikTok Shop.
An internal code/name for managing SKUs, not visible to buyers.
The SKU’s global uniform pre-tax price that serves as the baseline for calculating the local prices across different markets.
Note:
- Upon publishing, this price will be automatically converted to the local pre-tax price and local display price based on market-specific exchange rates and applicable charges such as shipping costs, taxes, and other fees.
- The auto-conversion will exclude JP and US shops using China warehouses.
object
The price amount.
The currency. Possible values:
USD: Applicable for global sellersEUR: Applicable for intra-EU sellers
The unit price of the SKU. You can display the unit price to facilitate easier price comparisons across different products and packaging sizes. Applicable only for the EU market.
Note:
- This value is available only if you have defined the elements used to calculate this price when creating the product.
- Unit price = Selling price/(SKU unit count/base unit count)
The total SKU inventory quantity across all shops globally.
The inventory for each local shop is automatically calculated when a product is first published. After publishing, this global quantity cannot be manually changed. You can only modify the inventory quantity in each local shop.
A regulated identifier code assigned to a product based on international standardized regulations (e.g. GTIN) to ensure the product is universally identifiable across various platforms and systems.
object
The identifier code.
Format:
- GTIN: 14 digits
- EAN: 8, 13, or 14 digits
- UPC: 12 digits
- ISBN: 13 digits, or 9 digits ending in capital
X - JAN: 8 or 13 digits Note: The identifier code must be unique for each SKU, with no repetition allowed.
The type of identifier code. Possible values:
- GTIN
- EAN
- UPC
- ISBN
- JAN
A list of attributes (e.g. size, color, length) that define each variant of a product.
object
The sales attribute ID.
The sales attribute name.
The sales attribute value ID.
The sales attribute value name.
An image to display for the SKU.
object
The image height. Unit: px
The image width. Unit: px
The URLs to view the image thumbnails.
The URI of the image.
The URLs to view the images.
SKU inventory information per warehouse.
object
The ID of the global warehouse where the SKU is stored.
The SKU quantity available in the warehouse.
The total quantity/volume of the product represented by the SKU. For example, if the SKU represents 500ml of water, this value would be 500 if the unit type is defined as ml. Applicable only for the EU market.
Note:
- This is mainly used to calculate the unit price of the SKU, and is required only if you wish to display the unit price to facilitate easier price comparisons across different products and packaging sizes.
- Unit price = Selling price/(SKU unit count/base unit count). Therefore if you want to obtain the unit price, you would also need to define the “base unit count” and the “unit type” product attributes. Retrieve the relevant information for these product attributes by using the Get Global Attributes API.
A list of up to 10 additional identifier codes if the SKU belongs to a virtual bundle (containing multiple individual SKUs).
Note: Applicable only for the EU market.
An external identifier used in an external ecommerce platform. This is used to associate the SKU between TikTok Shop and the external ecommerce platform.
The time when the product is last updated. Unix timestamp in seconds.
The time when the product is created. Unix timestamp in seconds.
A list of general attributes (e.g. manufacturer, country of origin, materials used) that describe the product as a whole, regardless of variant.
object
The ID of the product attribute.
The product attribute name.
A list of selectable values for the product attribute.
object
The ID of the built-in attribute value.
The name of the built-in attribute value.
The measurement details of the product to help buyers find the right size.
object
An image of the size chart.
object
The image height. Unit: px
The image width. Unit: px
The URI of the image.
A TikTok Shop size chart template generated by the size chart tool in Seller Center > Manage Products > Bulk action > Batch manage size charts.
object
The size chart template ID.
The local products associated through global product publishing or manual binding.
object
The market where the local product is listed.
The local product ID.
The list of sku mappings between the global and local products.
object
The global SKU ID in TikTok Shop.
The local SKU ID in TikTok Shop.
The list of sales attribute mappings between the global and local SKUs.
object
The global sales attribute ID.
The local sales attribute ID.
The global sales attribute value ID.
The local sales attribute value ID.
The cross-border seller ID.
Product brand information.
object
The ID of the brand of this product.
The category of the product.
object
The category ID.
(Deprecated: This field is deprecated and will be removed in a future API version. Use manufacturer_ids instead.)
The product manufacturer’s details. If there are more than one manufacturer information, only the first-added manufacturer will be returned in this field.
object
The name of the manufacturer.
The address of the manufacturer.
The phone number of the manufacturer, prefixed by a plus + symbol.
There must be a space or hyphen between the country code and the local phone number.
The email address of the manufacturer.
A list of responsible person IDs. Retrieve the IDs from the Search Responsible Persons API. Note: Applicable only for the EU market in certain categories.
A list of manufacturer IDs. Retrieve the IDs from the Search Manufacturers API. Note: Applicable only for the EU market in certain categories.
The 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
An external identifier used in an external ecommerce platform. This is used to associate the product between TikTok Shop and the external ecommerce platform.
Example
{ "code": 0, "data": { "id": "1729592969712207008", "title": "Short Boat Invisible Socks", "main_images": [ { "height": 600, "width": 600, "uri": "tos-maliva-i-o3syd03w52-us/c668cdf70b7f483c94dbe" } ], "video": { "id": "v09ea0g40000cj91373c77u3mid3g1s0" }, "description": " ", "package_dimensions": { "length": "10", "width": "10", "height": "10", "unit": "CENTIMETER" }, "package_weight": { "value": "1.32", "unit": "KILOGRAM" }, "certifications": [ { "id": "7267563252536723205", "title": "SNI Certificate", "files": [ { "id": "v09ea0g40000cj91373c77u3mid3g1s0", "urls": [ "https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/6c8519a3663a4d728c4e3c131dc914b4~tplv-o3syd03w52-resize-jpeg:300:300.jpeg?from=522366036" ], "name": "SNI.PDF", "format": "PDF" } ], "images": [ { "height": 600, "width": 600, "uri": "tos-maliva-i-o3syd03w52-us/c668cdf70b7f483c94dbe" } ] } ], "skus": [ { "id": "1729592969712207234", "seller_sku": "Color-Red-XM001", "price": { "amount": "1.01", "currency": "USD", "unit_price": "1.00" }, "global_quantity": 100, "identifier_code": { "code": "10000000000010", "type": "GTIN" }, "sales_attributes": [ { "id": "100000", "name": "Color", "value_id": "7267563252536723205", "value_name": "Red\n", "sku_img": { "height": 600, "width": 600, "thumb_urls": [ "https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/6c8519a3663a4d728c4e3c131dc914b4~tplv-o3syd03w52-resize-jpeg:300:300.jpeg?from=522366036" ], "uri": "tos-maliva-i-o3syd03w52-us/6c8519a3663a4d728c4e3c131dc914b4", "urls": [ "https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/6c8519a3663a4d728c4e3c131dc914b4~tplv-o3syd03w52-resize-jpeg:300:300.jpeg?from=522366036" ] } } ], "inventory": [ { "global_warehouse_id": "6966568648651605766", "quantity": 100 } ], "sku_unit_count": "100.00", "extra_identifier_codes": [ "12345678901234" ], "external_global_sku_id": "1234567890" } ], "update_time": 1694522875, "create_time": 1694522875, "product_attributes": [ { "id": "100392", "name": "Occasion", "values": [ { "id": "1001533", "name": "Birthday" } ] } ], "size_chart": { "image": { "height": 600, "width": 600, "uri": "tos-maliva-i-o3syd03w52-us/c668cdf70b7f483c94dbe" }, "template": { "id": "7267563252536723205" } }, "products": [ { "region": "GB", "id": "1729592969712207922", "sku_mappings": [ { "global_sku_id": "1729592969712207234", "local_sku_id": "1729592969712207230", "sales_attribute_mappings": [ { "global_attribute_id": "100000", "local_attribute_id": "100000", "global_value_id": "1001064", "local_value_id": "1001064" } ] } ] } ], "global_seller_id": "7494083603082020484", "brand": { "id": "7082427311584347905" }, "category": { "id": "600002" }, "manufacturer": { "name": "Sample Manufacturer Name", "address": "123W 106th St, New York, NY, USA, 10025", "phone_number": "+1-2124108036", "email": "samplemanufacturer101@outlook.com\n" }, "responsible_person_ids": [ "67726293bf1eb1e92401a" ], "manufacturer_ids": [ "67726293bf1eb1e92401a" ], "source_locale": "fr-FR", "external_global_product_id": "123456789" }, "message": "Success", "request_id": "202203070749000101890810281E8C70B7"}