stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /promotion/202309/activities/{activity_id}/products
#§2 Method: [DELETE]
#§3 Function Description
Use this API to remove products or SKUs from the existing product discount or flash sale promotion activity.
§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 Path Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| activity_id | string | Y | 7402881377634567979 | The unique identifier of the promotion activity. |
§6 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. |
§7 Request Body Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| product_ids | []string | N | ["7493989962827597361"] | IDs of the products to remove. |
| Max count: 300. | ||||
| sku_ids | []string | N | ["7135657830438176513"] | IDs of the SKUs to remove. |
| Max count: 300. | ||||
| benefit_product_ids | []string | N | ["7493989962827597361"] | IDs of the BXGY benefit products to remove. |
| Max count: 100. | ||||
| exclude_product_ids | []string | N | ["7493989962827597361"] | IDs of the BXGY exclude products to remove. |
| Max count: 100. |
§8 Request Sample
Query
https://open-api.tiktokglobalshop.com/promotion/202309/activities/7402881377634567979/products?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY
Body
{"product_ids":["7493989962827597361"],"sku_ids":["7135657830438176513"],"benefit_product_ids":["7493989962827597361"],"exclude_product_ids":["7493989962827597361"]}
§9 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 | |
| ^activity_id | string | 7136104329798256386 | A unique ID that identifies activities. |
| ^status | string | ONGOING | Activity status. |
| Possible values: |
- DRAFT: Promotion activities with this status are not available to TikTok users.
- NOT_START: Promotion activities with this status are not available to TikTok users until the set activity start time.
- ONGOING: Promotion activities with this status are available to TikTok users.
- EXPIRED: Promotion activities with this status are not available to TikTok users because it has expired.
- DEACTIVATED: The activity has been deactivated by the seller and is not available to TikTok users.
- NOT_EFFECTIVE: The activity is terminated by the platform and is not available to TikTok users. | ^update_time |int |1661765135 |Activity update time, unix timestamp. |
§10 Response Sample
{"code":0,"data":{"activity_id":"7136104329798256386","status":"ONGOING","update_time":1661765135},"message":"Success","request_id":"202203070749000101890810281E8C70B7"}
§11 Error Code
For common error codes, refer to How to call TikTok Shop APIs - Common Error Code
| Code | Message |
|---|---|
| 17027802 | Internal error, promotion purchase limit deletion failed, please try again |
| 17029001 | Invalid parameters |
| 17029009 | Activity does not exist |
| 17029010 | Activity is deactivated |
| 17029011 | Not allowed to update the beginning time of activity |
| 17029012 | Not allowed to update expired activities |
| 17029016 | Invalid SKU ID. |
| 17029023 | Products Not In Promotion |
| 17029024 | SKU(s) not found in this promotion. |
| 17029028 | You are specifying activities not in your shop. |
| 17029036 | ActivityType is not supported. |
| 17029046 | Number of items per request exceeds the limit. |
| 17029047 | An ONGOING flash sale product cannot be updated. |
| 17029048 | An ONGOING flash sale SKU cannot be updated. |
| 17029052 | ProductType is not supported |
| 17029055 | Request Timeout |
| 17029069 | Access denied. This activity does not belong to this shop and therefore cannot be modified. |
| 17029074 | Eligible products and the gift products must not be the same product. |
| 17029079 | Product is already assigned in another conflicting promotion. |
| 17029102 | Product level and shop level are not interchangeable |
| 36009003 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. |