PUT Update Activity
Update Activity Shop Required scope: seller.promotion.write Change the title and the beginning and end time of the existing product discount or flash sale promotion activity. Version 202309
PUT/promotion/202309/activities/{activity_id}
Request
Path
| Properties | Type | Description |
|---|---|---|
| activity_id Required | string | Activity ID |
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. |
| 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 |
Body
| Properties | Type | Description |
|---|---|---|
| title Required | string | Activity name (50 characters max). The name must be unique. |
| duration_type | string | The effective time type of the current activity- NORMAL: begin_time and end_time must be filled- INDEFINITE: begin_time and end_time aren't required, and the promotion will be a long-term activity which runs indefinitely. 1. INDEFINITE is only valid when activity_type is SHIPPING_DISCOUNT,2. If duration_type is INDEFINITE, start_time and end_time should be 0Default: NORMAL |
| begin_time Required | int | Activity start time. UNIX timestamp. The value must be greater than the value of the current time. |
| end_time Required | int | Activity end time. UNIX timestamp. |
| product_level | string | Activity product dimension, values are:- PRODUCT: Promotion activity applies at the product (SPU) level. Any and all SKUs that are part of this product will be subject to the promotion.- VARIATION: Promotion activity only applies to specified SKUs.- SHOP: Promotion activity applies to all products in the shop. |
| participation_limit | []object | The number of times a buyer can participate in the promotion. |
| discount | object | Discount information. |
| target_user_info | object | The targeted user type of the promotion. |
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 | | --- | --- | | 17003203 | A storewide free shipping promotion activity is already active. Only one can be created at a time. | | 17029001 | Invalid parameters | | 17029002 | Title Length Too Long | | 17029003 | The activity title is empty. | | 17029004 | Duplicate activity title. | | 17029005 | Begin Time Earlier Than Now | | 17029006 | The activity period is too short. | | 17029007 | The activity period is too long. | | 17029008 | FlashSale Period Too Long | | 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 | | 17029022 | The product or SKU cannot be in two ONGOING or NOT_START activities at the same time. | | 17029026 | Invalid SellerID | | 17029028 | You are specifying activities not in your shop. | | 17029052 | ProductType is not supported | | 17029070 | Empty gift sku info. | | 17029071 | Gift sku id is invalid, not an integer. | | 17029072 | Gift sku repeated | | 17029073 | Price of the gift exceeds the upper limit | | 17029074 | Eligible products and the gift products must not be the same product. | | 17029075 | Number of gifts per tier does not meet the limit | | 17029076 | Gift sku is out of stock. | | 17029077 | Gifts across different tiers are repeated | | 17029078 | Number of gift tiers does not meet the requirement | | 17029082 | Specified time is outside of the defined range for this activity. Please check the time range for the activity and try again. | | 17029083 | The claim limit quantity of gift can not be decreased | | 17029084 | The threshold type of gift can not be modified | | 17029085 | The number of gift tiers can not be changed | | 17029102 | Product level and shop level are not interchangeable | | 17029103 | Partial of products have already been applied to another conflict promotion during the selected period. | | 17029104 | The product(s) selected have already been applied to another buy more save more promotion during the selected period. To proceed, edit the product list or change the promotion period. | | 17029105 | The threshold type and discount type can not be modified. | | 17029106 | Participation Limit info cannot change or modify. | | 17029107 | Due to overlapping with other activities, sellers cannot create shop-scope BMSM activity. | | 17029109 | The promotion exceeds the threshold. | | 17029110 | The discount value is below the minimum threshold. | | 17029111 | The threshold value is invalid. | | 17029112 | The discount value is invalid. | | 17029113 | The number of products will exceed the maximum number of the promotion. | | 17029114 | The promotion type is not supported. | | 36009003 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. |
Is this content helpful?Helpful
Not Helpful
PreviousNext