GET Get Product
Get Product Shop Required scope: seller.product.basic Retrieve all properties of a product, except those in the FREEZE or DELETED status. Version 202309
GET/product/202309/products/{product_id}
Request
Path
| Properties | Type | Description |
|---|---|---|
| product_id Required | string | The product ID in TikTok Shop. |
Header
| Properties | Type | Description |
|---|---|---|
| content-type Required | string | Allowed type: application/json |
| x-tts-access-token Required | string | The seller access_token value from Get Access Token, when user_type = 0. Follow this guide to get seller access_token. |
Query
| Properties | Type | Description |
|---|---|---|
| app_key Required | string | Every single app will have a unique key. Please use the specific key assigned to your app. |
| sign Required | string | Signature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders. |
| timestamp Required | int | Unix timestamp GMT (UTC+00:00). This timestamp is used across all API requests. Developers can use this convert to local time. |
| return_under_review_version | bool | 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 |
| return_draft_version | bool | 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: FalseNote: - Applicable only if the product is in the DRAFT, ACTIVATE, SELLER_DEACTIVATED, or PLATFORM_DEACTIVATED status.- This field and return_under_review_version are mutually exclusive. Specify only one to receive results. |
| locale | string | 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 |
| shop_cipher Required | string | Use this property to pass shop information in requesting the API. Failure in passing the correct value when requesting the API for cross-border shops will return incorrect response. Get by API Get Authorization Shop |
Example
CurlGoNode.jsJavaEnable word wrap
Response Parameters
| Properties | Type | Description |
|---|---|---|
| code | int | The success or failure status code returned in API response. |
| message | string | The success or failure messages returned in API response. Reasons of failure will be described in the message. |
| request_id | string | Request log |
| data | object | Specific return information |
Example
JSONEnable word wrap
Error Code
View common error codes
| Code | Message | | --- | --- | | 12019150 | The product ID does not exist. | | 12052032 | The product does not exist | | 12052048 | You cannot edit the specified product(s) as it isn't listed in your account or shop. | | 12052260 | The product ID does not exist | | 12052547 | There is no version of this product that is under review. Please obtain the online version. | | 12052704 | seller id not exist | | 36009003 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. | | 12052901 | The product in its current status is not available for this operation. Change the product status and try again. |
Is this content helpful?Helpful
Not Helpful
PreviousNext