快工助手跨境电商知识与商机助手

Get Global Product

TikTok Shop 官方资料 · TikTok Shop Partner Center 开发者文档 · 适合开发者

stable本次发布有变化全部展示

来自 TikTok Shop 官方资料快照 ·

打开官方原文 ↗
  1. 当前资料结构化阅读页
  2. 固定快照已留存,可追溯
  3. 官方原文可核对
查看技术与溯源信息
平台 / profile
TikTok Shop / profile.tiktok.docs_api
语言
en-US
发布版本
cn-20260909-2
标签
zhuge/sourceplatform/tiktok_shopaudience/developercategory/api_doctopic/compliancetopic/developer

资料正文

§1 Path: /product/202309/global_products/{global_product_id}

#

§2 Method: [GET]

#

§3 Function Description

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.


#

§4 Common Parameters

For common parameters, refer to How to call TikTok Shop APIs - Common Parameters

Properties Location Type Require Sample Properties description
content-typeheaderstringYapplication/jsonAllowed type: application/json
#

§5 Request Path Parameters

Properties Type Require Sample Properties description
global_product_idstringY1729592969712207008Global product ID
#

§6 Request Query Parameters

Properties Type Require Sample Properties description
app_keystringY38abcdEvery single app will have a unique key. Please use the specific key assigned to your app.
signstringY5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8cSignature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders.
timestampintY1623812664Unix timestamp GMT (UTC+00:00). This timestamp is used across all API requests. Developers can use this convert to local time.
#

§7 Request Sample

Query

https://open-api.tiktokglobalshop.com/product/202309/global_products/1729592969712207008?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c&timestamp=1625484268
#

§8 Response Parameters

Properties Type Sample Properties description
codeint0The success or failure status code returned in API response.
messagestringSuccessThe success or failure messages returned in API response. Reasons of failure will be described in the message.
request_idstring202203070749000101890810281E8C70B7Request log
dataobjectSpecific return information
^idstring1729592969712207008The global product ID in TikTok Shop.
^titlestringShort Boat Invisible SocksThe product title.
^main_images[]objectA list of images to display in the product image gallery.
^^heightint600The image height.
Unit: px
^^widthint600The image width.
Unit: px
^^uristringtos-maliva-i-o3syd03w52-us/c668cdf70b7f483c94dbeThe URI of the image.
^videoobjectProduct video information.
^^idstringv09ea0g40000cj91373c77u3mid3g1s0The video ID.
^descriptionstringThe product description in HTML format.
^package_dimensionsobjectThe dimensions of the product package.
^^lengthstring10The package length.
^^widthstring10The package width.
^^heightstring10The package height.
^^unitstringCENTIMETERThe unit for the package dimensions.
^package_weightobjectThe weight of the product package.
^^valuestring1.32The package weight.
^^unitstringKILOGRAMThe unit for the package weight.
^certifications[]objectThe list of certifications for your product.
^^idstring7267563252536723205The ID to identify the type of certification required for the product category.
^^titlestringSNI CertificateThe title of the certification type.
^^files[]objectA list of certification related files.
^^^idstringv09ea0g40000cj91373c77u3mid3g1s0The ID of the certification file.
^^^urls[]string["https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/6c8519a3663a4d728c4e3c131dc914b4~tplv-o3syd03w52-resize-jpeg:300:300.jpeg?from=522366036"]The URLs to view the certification files.
^^^namestringSNI.PDFThe name of the certification file
^^^formatstringPDFThe format of the certification file.
^^images[]objectA list of certification related images.
^^^heightint600The image height.
Unit: px
^^^widthint600The image width.
Unit: px
^^^uristringtos-maliva-i-o3syd03w52-us/c668cdf70b7f483c94dbeThe URI of the image.
^skus[]objectA list of global Stock Keeping Units (SKUs) used to identify distinct variants of the product.
^^idstring1729592969712207234The global SKU ID in TikTok Shop.
^^seller_skustringColor-Red-XM001An internal code/name for managing SKUs, not visible to buyers.
^^priceobjectThe 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. | ^^^amount |string |1.01 |The price amount. | ^^^currency |string |USD |The currency. Possible values:
  • USD: Applicable for global sellers
  • EUR: Applicable for intra-EU sellers | ^^^unit_price |string |1.00 |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) | ^^global_quantity |int |100 |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. | ^^identifier_code |object | |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. | ^^^code |string |10000000000010 |The identifier code. | ^^^type |string |GTIN |The type of identifier code. Possible values:

  • GTIN
  • EAN
  • UPC
  • ISBN
  • JAN | ^^sales_attributes |[]object | |A list of attributes (e.g. size, color, length) that define each variant of a product. | ^^^id |string |100000 |The sales attribute ID. | ^^^name |string |Color |The sales attribute name. | ^^^value_id |string |7267563252536723205 |The sales attribute value ID. | ^^^value_name |string |Red |The sales attribute value name. | ^^^sku_img |object | |An image to display for the SKU. | ^^^^height |int |600 |The image height. Unit: px | ^^^^width |int |600 |The image width. Unit: px | ^^^^thumb_urls |[]string |["https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/6c8519a3663a4d728c4e3c131dc914b4~tplv-o3syd03w52-resize-jpeg:300:300.jpeg?from=522366036"] |The URLs to view the image thumbnails. | ^^^^uri |string |tos-maliva-i-o3syd03w52-us/6c8519a3663a4d728c4e3c131dc914b4 |The URI of the image. | ^^^^urls |[]string |["https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/6c8519a3663a4d728c4e3c131dc914b4~tplv-o3syd03w52-resize-jpeg:300:300.jpeg?from=522366036"] |The URLs to view the images. | ^^inventory |[]object | |SKU inventory information per warehouse. | ^^^global_warehouse_id |string |6966568648651605766 |The ID of the global warehouse where the SKU is stored. | ^^^quantity |int |100 |The SKU quantity available in the warehouse. | ^^sku_unit_count |string |100.00 |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. | ^^extra_identifier_codes |[]string |["12345678901234"] |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. | ^^external_global_sku_id |string |1234567890 |An external identifier used in an external ecommerce platform. This is used to associate the SKU between TikTok Shop and the external ecommerce platform. | ^update_time |int |1694522875 |The time when the product is last updated. Unix timestamp. | ^create_time |int |1694522875 |The time when the product is created. Unix timestamp. | ^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. | ^^id |string |100392 |The ID of the product attribute. | ^^name |string |Occasion |The product attribute name. | ^^values |[]object | |A list of selectable values for the product attribute. | ^^^id |string |1001533 |The product attribute value ID. | ^^^name |string |Birthday |The product attribute value name. | ^size_chart |object | |The measurement details of the product to help buyers find the right size. | ^^image |object | |An image of the size chart. | ^^^height |int |600 |The image height. Unit: px | ^^^width |int |600 |The image width. Unit: px | ^^^uri |string |tos-maliva-i-o3syd03w52-us/c668cdf70b7f483c94dbe |The URI of the image. | ^^template |object | |A TikTok Shop size chart template generated by the size chart tool in Seller Center > Manage Products > Bulk action > Batch manage size charts. | ^^^id |string |7267563252536723205 |The size chart template ID. | ^products |[]object | |The local products associated through global product publishing or manual binding. | ^^region |string |GB |The market where the local product is listed. | ^^id |string |1729592969712207922 |The local product ID. | ^^sku_mappings |[]object | |The list of sku mappings between the global and local products. | ^^^global_sku_id |string |1729592969712207234 |The global SKU ID in TikTok Shop. | ^^^local_sku_id |string |1729592969712207230 |The local SKU ID in TikTok Shop. | ^^^sales_attribute_mappings |[]object | |The list of sales attribute mappings between the global and local SKUs. | ^^^^global_attribute_id |string |100000 |The global sales attribute ID. | ^^^^local_attribute_id |string |100000 |The local sales attribute ID. | ^^^^global_value_id |string |1001064 |The global sales attribute value ID. | ^^^^local_value_id |string |1001064 |The local sales attribute value ID. | ^global_seller_id |string |7494083603082020484 |The cross-border seller ID. | ^brand |object | |Product brand information. | ^^id |string |7082427311584347905 |The ID of the brand of this product. | ^category |object | |The category of the product. | ^^id |string |600002 |The category ID. | ^manufacturer |object | |(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. | ^^name |string |Sample Manufacturer Name |The name of the manufacturer. | ^^address |string |123W 106th St, New York, NY, USA, 10025 |The address of the manufacturer. | ^^phone_number |string |+1-2124108036 |The phone number of the manufacturer. | ^^email |string |samplemanufacturer101@outlook.com |The email address of the manufacturer. | ^responsible_person_ids |[]string |["67726293bf1eb1e92401a"] |A 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. | ^manufacturer_ids |[]string |["67726293bf1eb1e92401a"] |A comma-delimited list of manufacturer IDs. Retrieve the IDs from the Search Manufacturers API. Note: Applicable only for the EU market in certain categories. | ^source_locale |string |fr-FR |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 | ^external_global_product_id |string |123456789 |An external identifier used in an external ecommerce platform. This is used to associate the product between TikTok Shop and the external ecommerce platform. |
#

§9 Response Sample

{"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"}
#

§10 Error Code

For common error codes, refer to How to call TikTok Shop APIs - Common Error Code

Code Message
12052032The product does not exist
12052048You cannot edit the specified product(s) as it isn't listed in your account or shop.
12052260The product ID does not exist
36009003Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support.
12052901The product in its current status is not available for this operation. Change the product status and try again.
#