stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存，可追溯
- 官方原文可核对
资料正文
§1 Path: /promotion/202309/activities/{activity_id}/deactivate
#§2 Method: [POST]
#§3 Function Description
Deactivate an ongoing or upcoming 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 | 7136104329798256386 | A unique ID that identifies different activities. |
§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 Sample
Query
https://open-api.tiktokglobalshop.com/promotion/202309/activities/7136104329798256386/deactivate?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&shop_cipher=ROW_RHkDDABBAAB8tKAVoAqsMTjsQZFLyNfY
Body
{}
§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 | |
| ^activity_id | string | 7136104329798256386 | A unique ID that identifies different activities. |
| ^title | string | FlashSale 20230707 | Activity name (50 characters max.) The name must be unique. |
| ^status | string | ONGOING | Activity status. |
| 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 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 not in effect and is not available to TikTok users. | ^update_time |int |1661756811 |Activity update time, unix timestamp. |
§9 Response Sample
{"code":0,"data":{"activity_id":"7136104329798256386","title":"FlashSale 20230707","status":"ONGOING","update_time":1661756811},"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 |
|---|---|
| 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 |
| 17029028 | You are specifying activities not in your shop. |
| 17029036 | ActivityType is not supported. |
| 17029052 | ProductType is not supported |
| 17029055 | Request Timeout |
| 36009003 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. |