stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存,可追溯
- 官方原文可核对
资料正文
§1 Path: /product/202309/products/deactivate
#§2 Method: [POST]
#§3 Function Description
Deactivate products that are in the Activate status and hide them from buyers. The status changes to Seller_deactivated after deactivation.
In the event there's some issue with a product (e.g. out of stock), you can deactivate the product and hide it temporarily from buyers. When the issues are resolved, you can activate the product again by using the Activate Product API.
§4 Common Parameters
For common parameters, refer to How to call TikTok Shop APIs - Common Parameters
| Properties | Location | Type | Require | Sample | Properties description |
|---|---|---|---|---|---|
| shop_cipher | query | string | Y | GCP_XF90igAAAABh00qsWgtvOiGFNqyubMt3 | 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 | |||||
| content-type | header | string | Y | application/json | Allowed type: application/json |
§5 Request Query Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| app_key | string | Y | 38abcd | Every single app will have a unique key. Please use the specific key assigned to your app. |
| sign | string | Y | 5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c | Signature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders. |
| timestamp | int | Y | 1623812664 | Unix timestamp GMT (UTC+00:00). This timestamp is used across all API requests. Developers can use this convert to local time. |
§6 Request Body Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| product_ids | []string | Y | ["1729592969712207008"] | The product IDs to deactivate. |
| Max number of IDs: 20. | ||||
| listing_platforms | []string | N | ["TIKTOK_SHOP", "TOKOPEDIA"] | The listing platforms where the product will be deactivated. |
| Possible values: |
- TOKOPEDIA
- TIKTOK_SHOP Default: TIKTOK_SHOP
Applicable only for sellers that migrated from Tokopedia. |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/product/202309/products/deactivate?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY
Body
{"product_ids":["1729592969712207008"],"listing_platforms":["TIKTOK_SHOP","TOKOPEDIA"]}
§8 Response Parameters
| Properties | Type | Sample | Properties description |
|---|---|---|---|
| code | int | 0 | The success or failure status code returned in API response. |
| message | string | Success | The success or failure messages returned in API response. Reasons of failure will be described in the message. |
| request_id | string | 202203070749000101890810281E8C70B7 | Request log |
| data | object | Specific return information | |
| ^errors | []object | The list of errors that occurred. | |
| ^^code | int | 12052048 | The main error code. |
| ^^message | string | You can't edit other sellers' products | The main error message. |
| ^^detail | object | The details of the main error. | |
| ^^^product_id | string | 1729382588639839583 | The ID of the product that could not be deactivated. |
§9 Response Sample
{"code":0,"data":{"errors":[{"code":12052048,"message":"You can't edit other sellers' products","detail":{"product_id":"1729382588639839583"}}]},"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 |
|---|---|
| 12019120 | The number of provided product IDs exceeds the limit. |
| 12052032 | The product does not exist |
| 12052048 | You cannot edit the specified product(s) as it isn't listed in your account or shop. |
| 12052330 | product is not supported to list in designated sale platform |
| 12052332 | The seller center is locked during shop integration, only editing stock and price is allowed |
| 12052371 | Auction product is bidding when it is not supported to change product info |
| 12052700 | The seller is inactive. |
| 12052703 | Invalid seller tax number |
| 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. |
| 12052910 | Invalid input parameters. Refer to the API documentation for details. |
