PUT Update Activity Product
Update Activity Product Shop Required scope: seller.promotion.write Use this API to add the products or SKUs to the list of a product discount activity or a flash deal activity. You can also change the discounts on existing products or SKUs. To remove the products or SKUs from the list, use Remove Activity Product
. Version 202309
PUT/promotion/202309/activities/{activity_id}/products
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 |
|---|---|---|
| products | []object | The items to add to the list or the existing items in the list of promotion activity to edit. The length must not exceed 300. |
| activity_id Required | string | A unique ID that identifies activities.You cannot update the products in DEACTIVATED or EXPIRED activities. |
| benefit_product_ids | []string | TikTokShop product ID list. |
| exclude_product_ids | []string | IDs of the BXGY exclude products to remove.Max count: 100. |
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 | | --- | --- | | 17011102 | Promotion title cannot be a duplicate. | | 17027107 | Internal system error, please try again later. | | 17029001 | Invalid parameters | | 17029009 | Activity does not exist | | 17029010 | Activity is deactivated | | 17029012 | Not allowed to update expired activities | | 17029013 | sku must be [] for activities of which product_level==PRODUCT. | | 17029014 | The value of quantity_per_user is out of range. | | 17029015 | When product_level==VARIATION, the value of quantity_limit must be -1. | | 17029016 | Invalid SKU ID. | | 17029017 | You are specifying products not in your shop. | | 17029018 | The provided SKU quantity is greater than the available stock. | | 17029019 | The provided product quantity is greater than the available stock. | | 17029020 | Product discount exceeds limit. The limit varies based on products and regions. | | 17029021 | SKU discount exceeds limit. The limit varies based on products and regions. | | 17029022 | The product or SKU cannot be in two ONGOING or NOT_START activities at the same time. | | 17029025 | The quantity of the products or the SKUs included in the activity exceeds 10000. | | 17029026 | Invalid SellerID | | 17029028 | You are specifying activities not in your shop. | | 17029029 | You are incorrectly specifying activity_price_amount instead of discount when activity_type==DIRECT_DISCOUNT and product_level==PRODUCT. | | 17029030 | You are incorrectly specifying discount instead of activity_price_amount when activity_type==FIXED_PRICE / FLASHSALE and product_level==PRODUCT. | | 17029031 | You are incorrectly specifying activity_price_amount instead of discount when activity_type==DIRECT_DISCOUNT and product_level==VARIATION. | | 17029032 | You are incorrectly specifying discount instead of activity_price_amount when activity_type==FIXED_PRICE / FLASHSALE and product_level==VARIATION. | | 17029033 | products is empty. | | 17029034 | activity_price_amount is invalid. | | 17029037 | skus is empty when product_level==VARIATION. | | 17029038 | When product_level==VARIATION, you must not specify product.activity_price_amount and product.discount. | | 17029039 | Duplicate product ID. | | 17029040 | Duplicate SKU ID. | | 17029041 | You must specify product.discount when activity_type==DIRECT_DISCOUNT and product_level==PRODUCT. | | 17029042 | You must specify product.activity_price_amount when activity_type==FIXED_PRICE / FLASHSALE and product_level==PRODUCT. | | 17029043 | You must specify sku.discount when activity_type==DIRECT_DISCOUNT and product_level==VARIATION. | | 17029044 | You must specify sku.activity_price_amount when activity_type==FIXED_PRICE / FLASHSALE and product_level==VARIATION. | | 17029045 | Duplicated RequestSerialNo. | | 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. | | 17029049 | ActivityVersion is not supported. | | 17029050 | The value of quantity_limit and quantity_per_user must be -1 or in the range of [1, 99]. | | 17029051 | Product ID not found. | | 17029053 | The SKU ID does not match the product ID. | | 17029054 | Please limit the request frequency. | | 17029055 | Request Timeout | | 17029056 | Invalid product status. | | 17029058 | Unable to decrease buyer/num PurchaseLimit. | | 17029060 | The Categories of products is invalid | | 17029062 | Discount is below the limit, please confirm. | | 17029063 | SKU discount is below the limit, please confirm. | | 17029064 | Product is non-sellable. | | 17029065 | Target quota is less than the initial quota. | | 17029066 | Limit info cannot be changed or modified. | | 17029067 | Auction products are not eligible for promotions. | | 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. | | 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. | | 17029113 | The number of products will exceed the maximum number of the promotion. | | 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