stable本次发布有变化全部展示
来自 Shopee 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存,可追溯
- 官方原文可核对
资料正文
§1 v2.discount.update_discount_item
Use this api to update items of the discount promotion.
§2 Overview
Overview
| Field | Value |
|---|---|
| Module | Discount |
| API type | Shop |
| HTTP method | POST |
| Path | /api/v2/discount/update_discount_item |
| Production URL | https://partner.shopeemobile.com/api/v2/discount/update_discount_item |
| Sandbox URL | https://partner.test-stable.shopeemobile.com/api/v2/discount/update_discount_item |
| Rate limit | [0, 0, 0] |
| Permission | ERP System; Seller In House System; Marketing; Swam ERP |
§3 Request parameters
Request parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| discount_id | int64 | Yes | 1000029745 | Shopee's unique identifier for a discount activity. |
| item_list | object[] | Yes | The items selected to this discount. You can update at most 50 items per call. | |
| item_list.item_id | int64 | Yes | 1776783 | Shopee's unique identifier for an item. |
| item_list.item_promotion_price | float | No | 96.0 | The discount price of the item. |
| item_list.model_list | object[] | No | The models selected to this discount. | |
| item_list.model_list.model_id | int64 | Yes | 1776782 | Shopee's unique identifier for a variation of an item. If there is no variation of this item, you don't need to input this param. Dafault is 0. |
| item_list.model_list.model_promotion_price | float | Yes | 96.0 | The discount price of the item. |
| item_list.purchase_limit | int32 | No | 1 | The max number of this product in the promotion price. |
§4 Response parameters
Response parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| error | string | Indicate error type if hit error. Empty if no error happened. | ||
| message | string | Indicate error details if hit error. Empty if no error happened. | ||
| warning | string | Indicate warning message you should take care. | ||
| request_id | string | da6b348a4a5e4162b885ecc73c85297f | The identifier of the API request for error tracking | |
| response | object | Detail informations you are querying. | ||
| response.discount_id | int64 | 1000029745 | Shopee's unique identifier for a discount activity. | |
| response.count | int32 | 1 | The number of items that modify successfully. | |
| response.error_list | object[] | Error list of this discount. | ||
| response.error_list.item_id | int64 | 1776783 | The items which have something error. | |
| response.error_list.model_id | int64 | 1776782 | The models which have something error. | |
| response.error_list.fail_message | string | time error | Indicate error details if one element hit error. | |
| response.error_list.fail_error | string | discount.error_time | Indicate error type if one element hit error. |
§5 Common parameters
Common parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| partner_id | int | 1 | Partner ID is assigned upon registration is successful. Required for all requests. | |
| timestamp | timestamp | 1610000000 | This is to indicate the timestamp of the request. Required for all requests. Expires in 5 minutes. | |
| access_token | string | c09222e3fc40ffb25fc947f738b1abf1 | The token for API access, using to identify your permission to the api. Valid for multiple use and expires in 4 hours. | |
| shop_id | int | 600000 | Shopee's unique identifier for a shop. Required param for most APIs. | |
| sign | string | e318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2 | Signature generated by partner_id, api path, timestamp, access_token, shop_id and partner_key via HMAC-SHA256 hashing algorithm. More details: https://open.shopee.com/documents?module=87&type=2&id=58&version=2 |
§6 Request samples
Request samples
§7 Payload
Payload
{
"discount_id": 1000029745,
"item_list": [{
"item_id": 1776783,
"purchase_limit": 2,
"model_list": [{
"model_id": 0,
"model_promotion_price": 96
}]
}, {
"item_id": 1778783,
"purchase_limit": 2,
"item_promotion_price": 11
}]
}
§8 Response sample
Response sample
§9 JSON
JSON
{
"error": "",
"message": "",
"request_id": "da6b348a4a5e4162b885ecc73c85297f",
"warning": "",
"response": {
"discount_id": 1000029745,
"count": 1,
"error_list": [{
"item_id": 1776783,
"model_id": 1776782,
"fail_message": "time error",
"fail_error": "discount.error_time"
}]
}
}
§10 Error example
Error example
§11 JSON
JSON
{
"message": "The information you queried is not found.",
"request_id": "2394b8ecb48982647e05c2efab62b9f6",
"response": {},
"error": "common.error_not_found"
}
§12 Errors
Errors
| Error | Description | Solution |
|---|---|---|
| discount.error_assigned_promo_stock | The reserved stock of added products or disabled products can't be edited | |
| discount.error_item_abnormal | The item is abnormal | |
| discount.item_status_abnormal | The item status is abnormal | |
| discount.error_item_under_block_categories | This product is under a category that is prohibited from promotions due to regulations in your country | |
| discount.fail_model_price_check | The difference between the maximum price and the minimum price in one item is too large. | |
| discount.get_model_orgin_price_error | There are something wrong when get the original price of model, please try again. | |
| discount.discount_is_end | The end discount cannot be updated or deleted. | |
| discount.error_b2c_item_not_allowed | This product is a B2C product that is prohibited from promotions in FBS shops | |
| discount.item_in_promotion_too_many | A maximum of 1000 items can be uploaded in one promotion | |
| discount.item_in_promotion_too_many_whitelist | A maximum of 15,000 items can be uploaded in one promotion | |
| discount.item_purchase_limit_error | Purchase limit of this product must be greater than {number}. | |
| discount.item_need_model_id | Please input model id for the item with models. | |
| discount.item_not_in_promotion | Item is not found in this discount. | |
| discount.item_status_invalid | item status is invalid. | |
| discount.item_id_not_exist | The Item id you provided is not found, please check your item id. | |
| discount.item_id_repeated | The item id can't be upload due to it has duplicated. | |
| discount.model_in_promotion_too_many | A maximum of 50,000 models can be uploaded in one promotion | |
| discount.model_not_in_promotion | The model that you provided is not in this discount. | |
| discount.model_id_not_exist | The model id you provided is not found. Please check your model id. | |
| discount.model_id_repeated | The model id can't be upload due to it has duplicated. | |
| discount.promotion_price_for_vn | The discount price has exceeded 50% of original price. | |
| discount.promotoin_price_too_high | Discount price is greater than the maximum national amount. | |
| discount.promotion_price_too_low | Discount price is less than the minimum national amount. | |
| discount.item_exceed_discount_limit | The overall item level promotion limit has been reached. | |
| discount.error_update_admin_discount | The discount created by admin can't be edited | |
| discount.error_update_streaming_discount | The discount created by livestreaming can't be edited | |
| discount.exceed_discount_item_batch_size | You can only add up to 50 items at a time. | |
| error_network | Inner http call failed | |
| error_data | parse data failed | |
| error_data | data not exist | |
| error_param | parameter invalid | |
| error_param | The information you queried is not found. | |
| common.error_not_found | The information you queried is not found. | |
| error_param | Wrong parameters, detail: {msg}. | |
| error_server | Something wrong. Please try later. | |
| common.error_server | Something wrong. Please try later. | |
| error_shop | shopid is invalid | |
| common.error_shop | Shopid is invalid | |
| discount.discount_need_promotion_price | Please input the discount price. | |
| error_param | request not from gateway | |
| discount.promotion_price_higher_input_price | Discount price is greater than original price. |
§13 Common errors
Common errors
| Error | Description | Solution |
|---|---|---|
| error_auth | partner_id is invalid | |
| error_auth | The App is deleted, and you'll be unable to make any API call. | |
| error_auth | App developer’s permissions for authorizations have been restricted. If you’re a seller, contact the developer for more information. If you’re the developer, refer to the Open Platform Console for details. | |
| error_param | There is no partner_id in query. | |
| error_param | Invalid partner_id. | |
| error_param | no timestamp | |
| error_param | Invalid timestamp | |
| error_param | There is no sign in query. | |
| error_sign | Wrong sign. | |
| invalid_partner_id | Invalid partner_id, please have a check. | |
| error_auth | No permission to current api. | |
| error_api_call_restricted | The App permission for api call have been restricted. If you’re a seller, contact the developer for more information. If you’re the developer, refer to the Open Platform Console for details. | |
| api_suspended | The API is offline. Please call v2 API instead. | |
| error_limit | The total API call number made by your APP has reached the daily API call limit, please try again after 00: 00 (UTC+08:00) | |
| error_rate_limit | Too many requests. You have reached the rate limit. Please try again later. | |
| source_ip_undeclared | Request Source IP ({ip}) is undeclared. Please declare all your IP addresses in the Shopee Open Platform Console > App list > IP Address Whitelist | |
| error_param | Permission denied. This API is currently offline or the request path is incorrect. | |
| error_param | Partner_id is invalid, should be an integer between 0 and 4294967295. | |
| error_param | no timestamp. | |
| error_param | Timestamp is invalid, should be an integer between 0 and 4294967295. | |
| error_param | Timestamp is expired. | |
| error_partner_key_expired | Your API partner key has expired, please reset the Live API Partner Key in Console to get a new valid partner key to call open api. | |
| error_api_permission | This app type has no permission to this API. | |
| error_param | There is no access_token in query. | |
| error_auth | Invalid access_token. | |
| error_auth | Invalid partner_id or shopid. | |
| shop_no_linked | Partner and shop has no linked. | |
| shop_banned | The shop account has been banned. Permissions for shop authorization and API calls have been suspended until the shop account is restored. | |
| invalid_acceess_token | Invalid access_token, please have a check. | |
| partner_shop_no_link | Invalid partner_id or shop_id, please have a check. | |
| error_ashop_api_permission | The shop is Affiliate shop has no permission to call this API. | |
| error_kyc_auth | No permission. Please inform the seller to complete the Seller Registration on Shopee Seller Center first, then this shop can call for this API. | |
| error_auth | System error, please try again later. | |
| error_param | There is no shop_id in query. | |
| error_param | shop_id is invalid, should be an integer between 0 and 4294967295. |
§14 Update log
Update log
| Date | Change |
|---|---|
| 2022-07-27 | Add Error Example information |
| 2022-06-28 | Optimize the Sample information of Request Parameter and Response Parameter |
| 2021-09-06 | update the description of item_id_list |
