Retrieve product details by product ID, including products in the FREEZE or DELETED status.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”The product ID in TikTok Shop.
Query Parameters
Section titled “Query Parameters”Identifies the shop. Obtain it from the Get Authorized Shops API.
A flag to indicate what product information to retrieve if a live product (ACTIVATE status) is edited and resent for TikTok Shop review.
- True: Retrieves the latest version of the product information that is currently under review.
- False: Retrieves a snapshot of the product information that is live and online (before the edit). Default: False
A flag to indicate what product information to retrieve if a product has a draft in TikTok Shop.
- True: Retrieves the draft version of the product information.
- False: Retrieves the latest product information. Default: False
Note:
- Applicable only if the product is in the
DRAFT,ACTIVATE,SELLER_DEACTIVATED, orPLATFORM_DEACTIVATEDstatus. - This field and
return_under_review_versionare mutually exclusive. Specify only one to receive results.
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
Responses
Section titled “Responses”Success
object
Status code; 0 means success.
Success or failure message.
Request log ID.
object
Product audit information. Note: Applicable only to products listed on TikTok Shop. Not applicable for products listed only on Tokopedia.
object
The reason why the product is pre-approved.
Applicable only if audit.status=PRE_APPROVED, otherwise returns an empty array.
Possible values:
- KYC_PENDING: The seller’s onboarding (KYC - Know Your Customer information) is incomplete or awaiting processing.
- RESTRICTED_CATEGORY_PENDING: The product is in a restricted category, and category approval is still pending. To request access, submit an application through the Qualification Center on TikTok Shop Seller Center. Applicable only for the US market.
The product audit status. Possible values:
- NONE: The product is not applicable for audit because it has not been submitted for listing on this platform, or it is in a draft, frozen, or deactivated state.
- AUDITING: The product is currently being audited.
- FAILED: The product failed the audit, or the audit was cancelled.
- PRE_APPROVED: The product has passed the audit but is not yet listed due to pending prerequisites. Refer to
pre_approved_reasonsfor the prerequisites. - APPROVED: The product passed the audit and has been listed on the platform.
The reasons why the product has not been submitted for TikTok Shop audit.
Applicable only when audit.status=NONE and the product cannot be submitted for audit because the shop has not met one or more listing prerequisites; otherwise, an empty array is returned.
Possible values:
- PAYMENT_ACCOUNT_NOT_LINKED: No payment account is linked to the shop.
- SHOP_INACTIVE: The shop is inactive.
- W8_NOT_CONFIGURED: The required W-8 tax information has not been provided for the shop. Applicable only to US shops.
TikTok Shop audit failure information.
object
The platform for listing the product. Possible values:
- TIKTOK_SHOP
- TOKOPEDIA
The audit failure reason name.
A brief reason for failing TikTok Shop audit.
A detailed explanation of the reason for failure.
Product brand information.
object
The ID of the brand of this product.
The brand name of this product.
Product category tree information.
object
The ID of the category of this product.
A flag to indicate if the category is a leaf category.
Note: You can only create or edit products that belong to a leaf category.
The category name in the requested locale.
The parent category ID.
For the root category, the parent ID is 0.
The list of certifications for your product.
object
The expiration date of this certification expressed in unix timestamp (seconds) UTC+0.
A list of certification related files.
object
The format of the certification file.
The ID of the certification file.
The name of the certification file.
The URLs to view the certification files.
The ID to identify the type of certification required for the product.
A list of certification related images.
object
The image height. Unit: px
The URLs to view the image thumbnails.
The URI of the image.
The URLs to view the images.
The image width. Unit: px
The title of the certification type.
The time when the product was created, expressed as a Unix timestamp in seconds.
The custom delivery options applied to this product, overriding the default warehouse delivery option.
Note: This field is not supported in post-live drafts, therefore the values here will always reflect those in the base version, even if you set return_draft_version=true.
object
The delivery option ID.
A flag indicating whether the delivery option is available for this product.
The delivery option name.
The product description in HTML format.
An external identifier used in an external ecommerce platform. This is used to associate the product between TikTok Shop and the external ecommerce platform.
The global product association established through global product publishing or manual binding.
Note:
- Applicable for global sellers and intra-EU sellers.
- Not applicable for EU sellers who synchronized products from other markets using the Global Product Replicate (GPR) tool. Refer to
global_listing_policyinstead to find the associated source products.
object
The global product ID in TikTok Shop.
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 global sales attribute value ID.
The local sales attribute ID.
The local sales attribute value ID.
A flag to indicate if the product has a draft.
- true: It has a draft.
- false: It does not have a draft.
The product ID generated by TikTok Shop.
The current status of the product on platforms that are natively integrated with TikTok Shop (e.g. TOKOPEDIA).
Note: For Indonesia sellers, if you did not set the listing platform as TOKOPEDIA when creating or editing a product, this will be omitted.
object
The integrated platform name. Possible values:
- TOKOPEDIA
The product status in the integrated platform. Possible values:
- UNKNOWN
- DRAFT
- PENDING
- FAILED
- ACTIVATE
- SELLER_DEACTIVATED
- PLATFORM_DEACTIVATED
- FREEZE
- DELETED
A flag indicating whether to show the Cash On Delivery (COD) payment option during checkout. Applicable only for the following markets:
- Global sellers: MY, PH, SA, TH, VN
- Local sellers: ID, MY, PH, SA, TH, VN
A flag indicating whether the product is not for sale and only available through Gift with Purchase (GWP) promotions. Such products won’t appear in searches or recommendations True: Not for sale False: For sale
A flag to indicate if the product is pre-owned. Applicable only if TOKOPEDIA is the sole listing platform.
Note: Pre-owned products on the TikTok Shop platform are identified by the category_id, which must belong to one of the designated pre-owned product categories (e.g. pre-owned luxury bags, luggage, and accessories).
A flag to indicate if the product contains a replica (created through local replication) in other local markets.
Key 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.
The current quality tier of this product listing. The quality tier of a product listing depends on the quality of the content in its product fields such as the title, image, attributes etc.
Possible values:
- POOR
- FAIR
- GOOD
- EXCELLENT
Note: Available only for the US market.
A list of images to display in the product image gallery.
object
The image height. Unit: px
The URLs to view the image thumbnails.
The URI of the image.
The URLs to view the images.
The image width. Unit: px
The list of manufacturer IDs.
Pass this value to the manufacturer_id field in the Search Manufacturers API to obtain more information about a manufacturer.
Note: Applicable only for the EU market in certain categories
The minimum order quantity for the product. Valid range: [1, 20]
Applicable only for the Indonesia market and selected sellers in other SEA markets. Contact your account manager for more information about gaining access to this field.
The dimensions of the product package
object
The package height.
The package length.
The unit for the package dimensions.
The package width.
The weight of the product package.
object
The unit for the package weight. Possible values:
KILOGRAMPOUND
The package weight.
POD customization configuration for an MTO product. This object contains consumer-customizable templates, surfaces, and customization areas for Print-On-Demand products.
object
A list of POD customization templates. Each template represents one customization plan and can be associated with one or more SKUs.
object
The unique identifier of the POD customization template.
Optional notes or instructions for this customization template. These notes may be used to remind consumers about customization requirements on the customization page.
A list of product SKU IDs associated with this customization template. The same SKU cannot be associated with more than one template.
A list of customizable product surfaces under this template, such as the front side, back side, collar, or sleeve. A template can contain up to 10 surfaces.
object
The background image of the customizable surface. It is usually the base product image on which customization areas are configured.
object
The height of the background image, in pixels.
A list of thumbnail URLs for the background image.
The URI of the background image.
Obtain this URI by uploading the images through the Upload Product Image API with use_case=CUSTOMIZATION_IMAGE.
A list of URLs for the background image.
The width of the background image, in pixels.
A list of customizable areas on this surface. The order of the elements represents the layer order to be used when rendering the final customization preview. A surface can contain up to 10 customization areas.
object
The name of the customizable area.
The position, size, and rotation information of the customizable area on the surface.
object
The height of the customizable area. Supports two decimal places.
The rotation angle of the customizable area, in degrees. Supports two decimal places.
The width of the customizable area. Supports two decimal places.
The X-coordinate of the customizable area’s starting point on the surface. Supports two decimal places.
The Y-coordinate of the customizable area’s starting point on the surface. Supports two decimal places.
The type of the customizable area. Enum values: TEXT, IMAGE.
The seller-defined external identifier of the customizable area, used for mapping with the seller’s own system.
Configuration for an image-type customization area. This field is returned when area_type is IMAGE.
object
Optional default image displayed in this area. If the consumer does not upload a custom image, the default image may be used.
object
The height of the default image, in pixels.
A list of thumbnail URLs for the default image.
The URI of the default image.
Obtain this URI by uploading the images through the Upload Product Image API with use_case=CUSTOMIZATION_IMAGE.
A list of URLs for the default image.
The width of the default image, in pixels.
The minimum required height, in pixels, for an image uploaded by the consumer.
The minimum required width, in pixels, for an image uploaded by the consumer.
Specifies whether the consumer must provide customization content for this area. If set to false, the default content or base product version may be used.
Configuration for a text-type customization area. This field is returned when area_type is TEXT.
object
The text alignment type. Enum values: LEFT, CENTER, RIGHT.
A list of text colors available for consumers to choose from, using hexadecimal color values such as #FFFFFF.
Optional default text displayed in this area. If the consumer does not customize this area, the default text may be used.
A list of font keys available for consumers to choose from, based on the platform-supported font library.
The maximum number of characters allowed for consumer text input.
The seller-defined external identifier of the customizable surface, used for mapping with the seller’s own system.
An optional mask image placed above the customization areas to support irregular or cut-out effects.
object
The height of the mask image, in pixels.
A list of thumbnail URLs for the mask image.
The URI of the mask image.
Obtain this URI by uploading the images through the Upload Product Image API with use_case=CUSTOMIZATION_IMAGE.
A list of URLs for the mask image.
The width of the mask image, in pixels.
The name of the customizable surface, for example, Front Side or Back Side.
The name of the customization template, used by the seller for internal management.
Prescription related information for the product. Note: Applicable only for Tokopedia. This object is returned for all pharmacy products, and omitted for non-pharmacy products.
object
A flag to indicate whether a prescription is required to purchase this pharmacy product.
If the product is a virtual bundle, this value is the ID of the primary product in the bundle. The value is omitted if the product is not a virtual bundle.
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 product attribute value ID.
The product attribute value name.
Defines the measurement template information used to describe the measurement standards and metric values configured for the product.
object
The unique ID of the measurement template. Use this ID to identify which measurement standard template applies to the product.
The list of metric value entries under the measurement template. Each object represents the value submitted by the seller for a specific metric in the template.
object
The unique ID of a metric item within the measurement template. This ID identifies which metric the submitted value belongs to.
The seller-provided value for the specified metric item in the measurement template.
Metric value module unit id.
Metric value module unit name.
Metric value suffix.
Metric value prefix.
The live product family that this product belongs to. A product family is a virtual group of products that share common characteristics (such as flavor, version, or size), allowing them to appear as selectable variations on the product page. Note:
- Applicable only for US local sellers.
- Omitted if this product does not belong to any product family.
object
The product family ID.
A list of products that belong to the family.
object
The product ID.
The product status in TikTok Shop unrelated to its audit status. Possible values:
- INITIAL
- DRAFT
- ACTIVATE
- SELLER_DEACTIVATED
- PLATFORM_DEACTIVATED
- FREEZE
- DELETED
Note: For Indonesia sellers, if you did not set the listing platform as TIKTOK_SHOP when creating or editing a product, this will be omitted.
Product tag to identity special type product Possible values: AUCTION
The product type. Possible values:
- COMBINED_PRODUCT: Indicates this is a virtual bundle product.
- IN_COMBINED_PRODUCT: Indicates this product is part of a virtual bundle.
- GPR_TARGET_PRODUCT: Indicates this product is synchronized to global listings. Applicable only for the EU market.
Recommended categories for the product based on the product title, description, and images.
object
The ID of the recommended category.
The recommended category name in the requested locale.
The list of responsible person IDs.
Pass this value to the responsible_person_id field in the Search Responsible Persons API to obtain more information about a responsible person.
Note: Applicable only for the EU market in certain categories
Scheduled listing configuration for the product, including whether scheduled listing is enabled and the scheduled listing time.
object
Whether scheduled listing is enabled for this product.
The stored scheduled listing time, expressed as a Unix timestamp in milliseconds.
Search 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.
The shipping insurance purchase requirement imposed on buyers for the product.
Possible values:
- REQUIRED: Shipping insurance is mandatory and buyers can’t opt out.
- OPTIONAL: Buyers can choose to purchase shipping insurance through the platform.
- NOT_SUPPORTED: Shipping insurance is not supported for the product. Default: OPTIONAL
Applicable only if the listing platforms include TOKOPEDIA.
Identifier of the shipping template that was bound to the product
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 URLs to view the image thumbnails.
The URI of the image.
The URLs to view the images.
The image width. Unit: px
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.
A list of Stock Keeping Units (SKUs) used to identify distinct variants of the product.
object
If this SKU belongs to a virtual bundle, this object contains the list of individual SKUs that form the bundle (e.g. gift basket, starter pack).
object
Brand information of the source product included in the virtual bundle.
object
The ID of the brand of this product.
The brand name of this product.
The category tree information of the source product included in the virtual bundle.
object
The ID of the category of the source product included in the virtual bundle.
A flag to indicate if the category is a leaf category.
The source product category name in the requested locale.
The parent category ID of the source product included in the virtual bundle.
The reasons linked to the source product included in the virtual bundle that are keeping the virtual bundle status from being live. Possible values:
- SUB_PRODUCT_DEACTIVATE: Indicate the source product has been deactivated.
- SUB_PRODUCT_DELETE: Indicate the source product has been deleted.
- SUB_PRODUCT_FROZEN: Indicate the source product has been frozen.
- SUB_SKU_DELETE: Indicate the source SKU has been deleted.
- SUB_PRODUCT_CATEGORY_FIRST_LEVEL_ERROR: Indicate the level one category of the virtual bundle does not match that of the source product.
- SUB_PRODUCT_CATEGORY_OVER_RESTRICTION: Indicate the level one category of the source product is not in the set of restricted categories.
Source SKU inventory details.
object
The total quantity available in the warehouse of the source SKU.
The ID of the warehouse where the source SKU is stored. Retrieve details of the warehouse from the Get Warehouse List API.
Source SKU pricing information.
object
The currency. Possible values based on the region:
- BRL: Brazil
- CZK: Czech Republic
- EUR: France, Germany, Ireland, Italy, Spain, Netherlands, Belgium, Austria, Greece, Portugal
- GBP: United Kingdom
- HUF: Hungary
- IDR: Indonesia
- JPY: Japan
- MXN: Mexico
- MYR: Malaysia
- PHP: Philippines
- PLN: Poland
- SGD: Singapore
- THB: Thailand
- USD: United States
- VND: Vietnam
All sellers The source SKU’s local display price shown on the product page before any discounts.
Global sellers The source SKU’s local pre-tax price. This excludes any applicable charges such as cross-border shipping costs, taxes, and other fees, and therefore does not appear on the product page.
Note: Tax-exclusive pricing does not apply to JP and US shops using China warehouses, therefore this value is the same as sale_price.
The ID of the source product included in the virtual bundle.
The main image of the source product included in the virtual bundle.
object
The image height. Unit: px
The URLs to view the image thumbnails.
The URI of the image.
The URLs to view the images.
The image width. Unit: px
A list of attributes (e.g. size, color, length) that define the source SKU.
object
The sales attribute ID.
The sales attribute name.
The default/main image for each value (e.g. red) of the primary sales attribute (e.g. color) of the source product. This appears in the product options gallery on TikTok Shop.
object
The image height. Unit: px
The URLs to view the image thumbnails.
The URI of the image.
The URLs to view the images.
The image width. Unit: px
A list of supplementary images for each value (e.g. red) of the primary sales attribute (e.g. color) to provide multiple views or details of the source product for that attribute value. These appear in the product options gallery on TikTok Shop.
Applicable only for the US market.
object
The image height. Unit: px
The URLs to view the image thumbnails.
The URI of the image.
The URLs to view the images.
The image width. Unit: px
The sales attribute value ID.
The sales attribute value name.
An internal code/name for managing the source SKU, not visible to buyers.
The quantity of the source SKU included in the virtual bundle.
The ID of the source SKU included in the virtual bundle.
The title of the source product included in the virtual bundle.
The SKU list price (e.g. MSRP, RRP) or original price information on external ecommerce platforms. Applicable only for selected sellers in the US market.
Note: This value may appear as the strikethrough price on the product page. However, whether the strikethrough price is shown and the amount shown are subject to the audit team’s review and decision based on various pricing information.
object
The price amount.
The currency. Possible values: USD
The external ecommerce platform from which the price is sourced. Possible values:
- SHOPIFY_COMPARE_AT_PRICE: The compare_at_price in Shopify.
An external identifier used in an external ecommerce platform. This is used to associate the SKU between TikTok Shop and the external ecommerce platform.
A list of URLs for third-party product listing pages where consumers can place orders.
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.
The fees required for this product based on TikTok Shop policies. Fees are required only for certain product categories, retrieve the requirements from the Get Category Rules API.
object
Possible values for Pfand:
- SINGLE_USE
- REUSABLE
- NOT_APPLICABLE
The fee amount. Valid range:
- PFAND: [0.00 - 6300.00]
The type of fee. Possible values: PFAND
Global Product Replicate (GPR) related information if the product is a target for synchronization. Applicable only for the EU market.
object
The type of inventory to synchronize. Possible values:
- SHARED: Inventory Area Sharing
- EXCLUSIVE: Inventory Exclusive
A flag indicating whether the product price is synchronized.
The source global listing product to synchronize from.
object
The ID of the source product.
The shop ID of the source product.
The SKU ID of the source product.
The SKU ID generated by TikTok 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
SKU inventory details.
Note: This field is not supported in post-live drafts. Therefore, the values here will always reflect those in the base version, even if you set return_draft_version=true.
object
The backorder_quantity will automatically be converted to quantity once in-stock inventory is sold out. The fulfillment of this inventory follows the handling_time specified below.
Note: Made-to-order (MTO), pre-order, and custom products cannot be backordered, and thus are incompatible with backorder_quantity.
The estimated number of working days needed for a backorder to be shipped. Currently, different warehouses for the same SKU are not allowed to have different handling_time
The total SKU quantity available in the warehouse. Valid range: [1, 99,999]
Note: This quantity specifically refers to the in-stock inventory that can be shipped immediately.
The ID of the warehouse where the SKU is stored. Retrieve details of the warehouse from the Get Warehouse List API.
The SKU’s list price information that has been verified to be legitimate by the audit team. This is equivalent to the manufacturer’s suggested retail price (MSRP), or the recommended retail price (RRP). Applicable only for the US market.
Note:
- This field will be empty or display the last verified price if the submitted price fails verification.
- This value may appear as the strikethrough price on the product page. However, whether the strikethrough price is shown and the amount shown are subject to the audit team’s review and decision based on various pricing information.
object
The price amount.
The currency. Possible values: USD
SKU presale information, used to tag a product as a presale product based on its presale type.
If this is not returned, it indicates that the product is a regular non-presale item.
object
Information about the type of pre-sale order fulfillment and the corresponding timeframe.
handling_duration_daysis for fulfillment with an extended duration.release_dateis for starting fulfillment on a fixed date.
object
The desired duration for handling a pre-sale order and handing it over to a shipping carrier.
Applicable only for the following regions and pre-sale type: US
MADE_TO_ORDER: Business days, from 3 to 14 days.CUSTOM: Business days, from 3 to 30 days.
UK, EU, SEA, JP, and LATAM
PRE_ORDER: Calendar days, from 3 to 30 days.
The date on which the product gets converted into a regular product and becomes available for general purchase. On this date, order handling will also start, changing the status of the order to AWAITING_SHIPMENT.
Applicable only for PRE_ORDER in the US.
Note:
- Valid range: The date must fall within 3 - 60 days from the current date.
- This date is a unix timestamp (seconds) based on the seller-selected timezone in Seller Center.
- This date cannot be modified once the product goes live.
The type of pre-sale. Possible values based on the region: US
PRE_ORDER: The product is not yet available or released. Fulfillment can be extended by specifying a release date.MADE_TO_ORDER: The product is produced only after the order is received. Fulfillment can be extended by specifying a duration.CUSTOM: The product requires a fulfillment timeline that exceeds the standard due to other factors. Fulfillment can be extended by specifying a duration.
UK, EU, SEA, JP, and LATAM
PRE_ORDER: The product is not yet available or released. Fulfillment can be extended by specifying a duration.
SKU pricing information.
object
The currency. Possible values based on the region:
- BRL: Brazil
- CZK: Czech Republic
- EUR: France, Germany, Ireland, Italy, Spain, Netherlands, Belgium, Austria, Greece, Portugal
- GBP: United Kingdom
- HUF: Hungary
- IDR: Indonesia
- JPY: Japan
- MXN: Mexico
- MYR: Malaysia
- PHP: Philippines
- PLN: Poland
- SGD: Singapore
- THB: Thailand
- USD: United States
- VND: Vietnam
All sellers The SKU’s local display price shown on the product page before any discounts.
Starting bid price for auction product
Global sellers The SKU’s local pre-tax price. This excludes any applicable charges such as cross-border shipping costs, taxes, and other fees, and therefore does not appear on the product page.
Note: Tax-exclusive pricing does not apply to JP and US shops using China warehouses, therefore this value is the same as sale_price.
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)
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 default/main image for each value (e.g. red) of the primary sales attribute (e.g. color) of the source product. This appears in the product options gallery on TikTok Shop.
object
The image height. Unit: px
The URLs to view the image thumbnails.
The URI of the image.
The URLs to view the images.
The image width. Unit: px
A list of supplementary images for each value (e.g. red) of the primary sales attribute (e.g. color) to provide multiple views or details of the source product for that attribute value. These appear in the product options gallery on TikTok Shop.
Applicable only for the US market.
object
The image height. Unit: px
The URLs to view the image thumbnails.
The URI of the image.
The URLs to view the images.
The image width. Unit: px
The sales attribute value ID.
The sales attribute value name.
An internal code/name for managing SKUs, not visible to buyers.
The dimensions of the sku.
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.
object
The package height. A positive whole number. Note: For the BR market, decimal values using . or , as separators are also accepted but will be rounded to the nearest whole number.
The package length. A positive whole number. Note: For the BR market, decimal values using . or , as separators are also accepted but will be rounded to the nearest whole number.
The unit for the SKU dimensions. Possible values based on region:
- US: CENTIMETER, INCH
- Other regions: CENTIMETER
Note: Use the same measurement system for sku_weight and sku_dimensions. For example, use KILOGRAM with CENTIMETER.
The package width. A positive whole number. Note: For the BR market, decimal values using . or , as separators are also accepted but will be rounded to the nearest whole number.
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 Attributes API.
The packaged weight of the SKU. The returned value and unit use the same measurement system as sku_dimensions; for example, KILOGRAM is used with CENTIMETER. This weight can affect shipping fees, and it takes precedence over package dimensions when the fee calculated from weight is higher.
object
The unit for the package weight. Possible values based on region:
- US: KILOGRAM, POUND
- BR, JP, MX: KILOGRAM, GRAM
- Other countries: KILOGRAM
Note: You must use the same system of measurement (metric system or imperial system) for package_weight and package_dimensions. In other words, if you are using KILOGRAM for the weight, you must use CENTIMETER for the dimensions.
The package weight, which must be a positive number. The number format varies based on the unit:
- GRAM: integer
- KILOGRAM: up to 3 decimal places
- POUND: up to 2 decimal places
Status information of the SKU.
object
The deactivation source of the SKU with DEACTIVATED status.
Possible values:
- SELLER: Indicates that the seller deactivated the SKU
- PLATFORM: Indicates that the platform de-activated the SKU due to violation reasons
- COMBO_RELATION: Indicates that the platform de-activated the bundle-SKU due to the deactivation of sub-SKU.
The SKU status in TikTok Shop. Possible values:
- NORMAL
- DEACTIVATED
The customer purchase limits for this SKU. maximum_order_quantity is the maximum quantity the customer can purchase in one order, and cumulative_order_quantity is the maximum quantity the customer can purchase across all orders while the limit is active.
object
The maximum purchase quantity per order for each product variation (SKU). For example: If you set a maximum limit of 2 for a product with 5 variations (SKUs), the customer can purchase up to 2 of each SKU, for a total of 10 items per order.
· The total quantity a customer can buy of a product’s variations (SKUs) across all orders, while the limit is active. Clearing the limit will reset their past purchases, allowing them to buy again up to the new limit, or without restriction if no limit is set. • For example, if you set a total limit of 2 for a product with 5 variations (SKUs), the customer can buy up to 2 of each SKU, for a total of 10 items across multiple purchases. After that, they can’t buy more unless you clear the limits.The total limit must be more than or equal to the maximum limit.
The product status in TikTok Shop. This status incorporates both the product status and the audit status. Possible values:
- DRAFT
- PENDING
- FAILED
- ACTIVATE
- SELLER_DEACTIVATED
- PLATFORM_DEACTIVATED
- FREEZE
- DELETED
- SCHEDULED
Note: For Indonesia sellers, if you did not set the listing platform as TIKTOK_SHOP when creating or editing a product, this will be omitted.
All the Save and Subscribe promotion info associated with the given product.
object
All of the Save and Subscribe discount details.
object
An enum that communicated the type of discount:
- REGULAR
- FIRST_ORDER
- RETENTION
The value of the discount. A value of 10, would indicate a 10% discount.
A subscription configuration specific to the seller. It outlines the different types of promotions and associated constraints that are available for use.
object
An enum that communicated the type of discount:
- REGULAR
- FIRST_ORDER
- RETENTION
The discount options available to the seller for the given discount level.
The maximum discount a seller can set for the associated discount level.
The minimum discount a seller can set for the associated discount level.
An enum outlining whether the given product has an active Subscribe and Save promotion:
- ENABLED
- NOT_ENABLED
A flag outlining whether the seller and given product support Subscribe and Save promotions.
The product title.
The time when the product was last updated, expressed as a Unix timestamp in seconds.
Product video information.
object
The URL to view the video cover image.
The video format.
The video height. Unit: px
The video ID.
The video’s original file size. Unit: MB
The URL to view the video.
The video width. Unit: px
The product’s sale format. Possible values: FIXED_PRICE, LIVE_AUCTION, FIXED_PRICE_AND_LIVE_AUCTION.
Whether the product is a blind box of lucky bag. For example: PopMart
Example
{ "code": 0, "data": { "audit": { "pre_approved_reasons": [ "KYC_PENDING" ], "status": "AUDITING", "not_submitted_reasons": [ "SHOP_INACTIVE" ] }, "audit_failed_reasons": [ { "listing_platform": "TIKTOK_SHOP", "position": "product", "reasons": [ "violate listing rules" ], "suggestions": [ "The product violates TikTok Shopping listing rules, please check and resubmit." ] } ], "brand": { "id": "7082427311584347905", "name": "brand xxx aaa" }, "category_chains": [ { "id": "853000", "is_leaf": true, "local_name": "Botol & Stoples Penyimpanan", "parent_id": "851848" } ], "certifications": [ { "expiration_date": 1741235456, "files": [ { "format": "PDF", "id": "v09ea0g40000cj91373c77u3mid3g1s0", "name": "CERT_X2.PDF", "urls": [ "https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/6c8519a3663a4d728c4e3c131dc914b4~tplv-o3syd03w52-resize-jpeg:300:300.jpeg?from=522366036" ] } ], "id": "602362", "images": [ { "height": 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" ], "width": 600 } ], "title": "SNI Certificate" } ], "create_time": 1234567890, "delivery_options": [ { "id": "1729592969712203232", "is_available": true, "name": "SEND_BY_SELLER" } ], "description": "<p>Please compare above detailed size with your measurement before purchase.</p>\n<ul> \n <li>M-Size</li>\n <li>XL-Size</li>\n</ul> \n<img src=\"https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/181595ea7d26489284b5667488d708c1~tplv-o3syd03w52-origin-jpeg.jpeg?from=1432613627\" />\n", "external_product_id": "172959296971220002", "global_product_association": { "global_product_id": "1729592969712207920", "sku_mappings": [ { "global_sku_id": "1729592969712207234", "local_sku_id": "1729592969712207230", "sales_attribute_mappings": [ { "global_attribute_id": "100000", "global_value_id": "1001064", "local_attribute_id": "100000", "local_value_id": "1001064" } ] } ] }, "has_draft": true, "id": "1729592969712207008", "integrated_platform_statuses": [ { "platform": "TOKOPEDIA", "status": "PLATFORM_DEACTIVATED" } ], "is_cod_allowed": true, "is_not_for_sale": true, "is_pre_owned": false, "is_replicated": false, "key_product_features": [ "Breathable mesh upper", "Cushioned foam midsole" ], "listing_quality_tier": "POOR", "main_images": [ { "height": 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" ], "width": 600 } ], "manufacturer_ids": [ "172959296971220002" ], "minimum_order_quantity": 1, "package_dimensions": { "height": "10", "length": "10", "unit": "CENTIMETER", "width": "10" }, "package_weight": { "unit": "KILOGRAM", "value": "1.32" }, "pod_info": { "pod_templates": [ { "pod_template_id": "172959296971220002", "remark": "Front side customization template for basic tee", "sku_ids": [ "172959296971220002" ], "surfaces": [ { "background_image": { "height": 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" ], "width": 600 }, "custom_areas": [ { "area_name": "logo area", "area_placement": { "height": "200", "rotate_degree": "0", "width": "200", "x_coordinate": "0", "y_coordinate": "0" }, "area_type": "TEXT", "external_area_id": "172959296971220002", "image_area": { "default_image": { "height": 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" ], "width": 600 }, "min_height": 300, "min_width": 300 }, "is_required": false, "text_area": { "align_type": "CENTER", "colors": [ "#FFFFFF" ], "default_text": "Hello World", "fonts": [ "Roboto" ], "max_text_length": 20 } } ], "external_surface_id": "172959296971220002", "mask_image": { "height": 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" ], "width": 600 }, "surface_name": "Front Side" } ], "template_name": "T-Shirt Front Print" } ] }, "prescription_requirement": { "needs_prescription": false }, "primary_combined_product_id": "1729592969712207008", "product_attributes": [ { "id": "100392", "name": "Occasion", "values": [ { "id": "1001533", "name": "Birthday", "metric_standard_info": { "id": "7678592839487784712", "metric_value_module_infos": [ { "id": "7678592839487784712", "value": "2026", "unit_id": "7678592839484720903", "unit_name": "piece", "suffix": "and", "prefix": "daily" } ] } } ] } ], "product_families": [ { "id": "1000592969712207000", "products": [ { "id": "1729592969712207008" } ] } ], "product_status": "SELLER_DEACTIVATED", "product_tags": [ "AUCTION" ], "product_types": [ "COMBINED_PRODUCT" ], "recommended_categories": [ { "id": "850003", "local_name": "\t\nBotol & Stoples Penyimpanan" } ], "responsible_person_ids": [ "172959296971220003" ], "scheduled_sale": { "is_enabled_scheduled_sale": false, "schedule_sale_time": 1768899145000 }, "search_terms": [ "sneakers", "running shoes", "athletic" ], "shipping_insurance_requirement": "OPTIONAL", "shipping_template_id": "7552764259994699538", "size_chart": { "image": { "height": 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" ], "width": 600 }, "template": { "id": "7267563252536723205" } }, "skus": [ { "combined_skus": [ { "brand": { "id": "7082427311584347905", "name": "brand xxx aaa" }, "categories": [ { "id": "853000", "is_leaf": true, "local_name": "Botol & Stoples Penyimpanan", "parent_id": "851848" } ], "combined_listing_not_live_reasons": [ "SUB_PRODUCT_DELETE" ], "inventory": [ { "quantity": 999, "warehouse_id": "6966568648651605766" } ], "price": { "currency": "USD", "sale_price": "117.5", "tax_exclusive_price": "110" }, "product_id": "1729582718312380123", "product_main_image": { "height": 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" ], "width": 600 }, "sales_attributes": [ { "id": "100000", "name": "Color", "sku_img": { "height": 100, "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" ], "width": 100 }, "supplementary_sku_images": [ { "height": 100, "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" ], "width": 100 } ], "value_id": "100000", "value_name": "Red" } ], "seller_sku": "sku_name", "sku_count": 1, "sku_id": "1729582718312380123", "title": "Short Boat Invisible Socks" } ], "external_list_prices": [ { "amount": "1", "currency": "USD", "source": "SHOPIFY_COMPARE_AT_PRICE" } ], "external_sku_id": "1729592969712207234", "external_urls": [ "https://example.com/path1", "https://example.com/path2" ], "extra_identifier_codes": [ "00012345678905", "9780596520687" ], "fees": [ { "additional_attribute": "SINGLE_USE", "amount": "1.01", "type": "PFAND" } ], "global_listing_policy": { "inventory_type": "SHARED", "price_sync": true, "replicate_source": { "product_id": "1729592969712203232", "shop_id": "7295929697122032321", "sku_id": "1729592969712203232" } }, "id": "10001", "identifier_code": { "code": "10000000000010", "type": "GTIN" }, "inventory": [ { "backorder_quantity": 888, "handling_time": 5, "quantity": 999, "warehouse_id": "6966568648651605766" } ], "list_price": { "amount": "1", "currency": "USD" }, "pre_sale": { "fulfillment_type": { "handling_duration_days": 3, "release_date": 1619611761 }, "type": "PRE_ORDER" }, "price": { "currency": "USD", "sale_price": "117.5", "starting_bid_price": "2", "tax_exclusive_price": "110", "unit_price": "1" }, "sales_attributes": [ { "id": "100000", "name": "Color", "sku_img": { "height": 100, "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" ], "width": 100 }, "supplementary_sku_images": [ { "height": 100, "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" ], "width": 100 } ], "value_id": "100000", "value_name": "Red" } ], "seller_sku": "sku name", "sku_dimensions": { "height": "10", "length": "10", "unit": "CENTIMETER", "width": "10" }, "sku_unit_count": "1.00", "sku_weight": { "unit": "KILOGRAM", "value": "1.32" }, "status_info": { "deactivation_source": "PLATFORM", "status": "DEACTIVATED" }, "purchase_order_quantity_limit": { "maximum_order_quantity": 2, "cumulative_order_quantity": 20 } } ], "status": "SELLER_DEACTIVATED", "subscribe_info": { "subscribe_discount_details": [ { "discount_level": "REGULAR", "discount_value": 10 } ], "subscribe_promotion_config": [ { "discount_level": "REGULAR", "discount_options": [ 5, 10, 15, 20 ], "max_discount": 90, "min_discount": 5 } ], "subscribe_status": "ENABLED", "support_subscribe": false }, "title": "Short Boat Invisible Socks", "update_time": 1234567899, "video": { "cover_url": "https://p16-oec-va.ibyteimg.com/tos-maliva-i-o3syd03w52-us/6c8519a3663a4d728c4e3c131dc914b4~tplv-o3syd03w52-resize-jpeg:300:300.jpeg?from=522366036", "format": "MP4", "height": 480, "id": "v09ea0g40000cj91373c77u3mid3g1s0", "size": 1000, "url": "https://v16m-default.akamaized.net/bbae7099581b26cd340beaa7821b2d8c/64de6020/video/tos/alisg/tos-alisg-v-f466fc-sg/oMne9QuzIBN3fIDN7bFCCMbBKuGigg12ghDC8k/?a=0&ch=0&cr=0&dr=0&er=0&lr=default&cd=0%7C0%7C0%7C0&br=2212&bt=1106&cs=0&ds=3&ft=dl9~j-Inz7TKnfsfiyq8Z&mime_type=video_mp4&qs=13&rc=anR4Ojk6ZmYzbTMzODRmNEBpanR4Ojk6ZmYzbTMzODRmNEBsYWFwcjRva2NgLS1kLy1zYSNsYWFwcjRva2NgLS1kLy1zcw%3D%3D&l=202308171159498F7B108584E58B010932&btag=e00048000", "width": 1280 }, "selling_format": "FIXED_PRICE", "is_blind_box": false }, "message": "Success", "request_id": "202203070749000101890810281E8C70B7"}