快工助手跨境电商知识与商机助手

v2.discount.update_discount_item

Shopee 官方资料 · Shopee Open Platform 接口参考 · 适合开发者

stable本次发布有变化全部展示

来自 Shopee 官方资料快照 ·

打开官方原文 ↗
  1. 当前资料结构化阅读页
  2. 固定快照已留存,可追溯
  3. 官方原文可核对
查看技术与溯源信息
平台 / profile
Shopee / profile.shopee.api_reference
语言
en-US
发布版本
cn-20260909-2
标签
zhuge/sourceplatform/shopeeaudience/developercategory/api_doctopic/apitopic/developer

资料正文

§1 v2.discount.update_discount_item

Use this api to update items of the discount promotion.

#

§2 Overview

Overview

FieldValue
ModuleDiscount
API typeShop
HTTP methodPOST
Path/api/v2/discount/update_discount_item
Production URLhttps://partner.shopeemobile.com/api/v2/discount/update_discount_item
Sandbox URLhttps://partner.test-stable.shopeemobile.com/api/v2/discount/update_discount_item
Rate limit[0, 0, 0]
PermissionERP System; Seller In House System; Marketing; Swam ERP
#

§3 Request parameters

Request parameters

NameTypeRequiredSampleDescription
discount_idint64Yes1000029745Shopee's unique identifier for a discount activity.
item_listobject[]YesThe items selected to this discount. You can update at most 50 items per call.
item_list.item_idint64Yes1776783Shopee's unique identifier for an item.
item_list.item_promotion_pricefloatNo96.0The discount price of the item.
item_list.model_listobject[]NoThe models selected to this discount.
item_list.model_list.model_idint64Yes1776782Shopee'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_pricefloatYes96.0The discount price of the item.
item_list.purchase_limitint32No1The max number of this product in the promotion price.
#

§4 Response parameters

Response parameters

NameTypeRequiredSampleDescription
errorstringIndicate error type if hit error. Empty if no error happened.
messagestringIndicate error details if hit error. Empty if no error happened.
warningstringIndicate warning message you should take care.
request_idstringda6b348a4a5e4162b885ecc73c85297fThe identifier of the API request for error tracking
responseobjectDetail informations you are querying.
response.discount_idint641000029745Shopee's unique identifier for a discount activity.
response.countint321The number of items that modify successfully.
response.error_listobject[]Error list of this discount.
response.error_list.item_idint641776783The items which have something error.
response.error_list.model_idint641776782The models which have something error.
response.error_list.fail_messagestringtime errorIndicate error details if one element hit error.
response.error_list.fail_errorstringdiscount.error_timeIndicate error type if one element hit error.
#

§5 Common parameters

Common parameters

NameTypeRequiredSampleDescription
partner_idint1Partner ID is assigned upon registration is successful. Required for all requests.
timestamptimestamp1610000000This is to indicate the timestamp of the request. Required for all requests. Expires in 5 minutes.
access_tokenstringc09222e3fc40ffb25fc947f738b1abf1The token for API access, using to identify your permission to the api. Valid for multiple use and expires in 4 hours.
shop_idint600000Shopee's unique identifier for a shop. Required param for most APIs.
signstringe318d3e932719916a9f9ebb57e2011961bd47abfa54a36e040d050d8931596e2Signature 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

ErrorDescriptionSolution
discount.error_assigned_promo_stockThe reserved stock of added products or disabled products can't be edited
discount.error_item_abnormalThe item is abnormal
discount.item_status_abnormalThe item status is abnormal
discount.error_item_under_block_categoriesThis product is under a category that is prohibited from promotions due to regulations in your country
discount.fail_model_price_checkThe difference between the maximum price and the minimum price in one item is too large.
discount.get_model_orgin_price_errorThere are something wrong when get the original price of model, please try again.
discount.discount_is_endThe end discount cannot be updated or deleted.
discount.error_b2c_item_not_allowedThis product is a B2C product that is prohibited from promotions in FBS shops
discount.item_in_promotion_too_manyA maximum of 1000 items can be uploaded in one promotion
discount.item_in_promotion_too_many_whitelistA maximum of 15,000 items can be uploaded in one promotion
discount.item_purchase_limit_errorPurchase limit of this product must be greater than {number}.
discount.item_need_model_idPlease input model id for the item with models.
discount.item_not_in_promotionItem is not found in this discount.
discount.item_status_invaliditem status is invalid.
discount.item_id_not_existThe Item id you provided is not found, please check your item id.
discount.item_id_repeatedThe item id can't be upload due to it has duplicated.
discount.model_in_promotion_too_manyA maximum of 50,000 models can be uploaded in one promotion
discount.model_not_in_promotionThe model that you provided is not in this discount.
discount.model_id_not_existThe model id you provided is not found. Please check your model id.
discount.model_id_repeatedThe model id can't be upload due to it has duplicated.
discount.promotion_price_for_vnThe discount price has exceeded 50% of original price.
discount.promotoin_price_too_highDiscount price is greater than the maximum national amount.
discount.promotion_price_too_lowDiscount price is less than the minimum national amount.
discount.item_exceed_discount_limitThe overall item level promotion limit has been reached.
discount.error_update_admin_discountThe discount created by admin can't be edited
discount.error_update_streaming_discountThe discount created by livestreaming can't be edited
discount.exceed_discount_item_batch_sizeYou can only add up to 50 items at a time.
error_networkInner http call failed
error_dataparse data failed
error_datadata not exist
error_paramparameter invalid
error_paramThe information you queried is not found.
common.error_not_foundThe information you queried is not found.
error_paramWrong parameters, detail: {msg}.
error_serverSomething wrong. Please try later.
common.error_serverSomething wrong. Please try later.
error_shopshopid is invalid
common.error_shopShopid is invalid
discount.discount_need_promotion_pricePlease input the discount price.
error_paramrequest not from gateway
discount.promotion_price_higher_input_priceDiscount price is greater than original price.
#

§13 Common errors

Common errors

ErrorDescriptionSolution
error_authpartner_id is invalid
error_authThe App is deleted, and you'll be unable to make any API call.
error_authApp 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_paramThere is no partner_id in query.
error_paramInvalid partner_id.
error_paramno timestamp
error_paramInvalid timestamp
error_paramThere is no sign in query.
error_signWrong sign.
invalid_partner_idInvalid partner_id, please have a check.
error_authNo permission to current api.
error_api_call_restrictedThe 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_suspendedThe API is offline. Please call v2 API instead.
error_limitThe 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_limitToo many requests. You have reached the rate limit. Please try again later.
source_ip_undeclaredRequest Source IP ({ip}) is undeclared. Please declare all your IP addresses in the Shopee Open Platform Console > App list > IP Address Whitelist
error_paramPermission denied. This API is currently offline or the request path is incorrect.
error_paramPartner_id is invalid, should be an integer between 0 and 4294967295.
error_paramno timestamp.
error_paramTimestamp is invalid, should be an integer between 0 and 4294967295.
error_paramTimestamp is expired.
error_partner_key_expiredYour 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_permissionThis app type has no permission to this API.
error_paramThere is no access_token in query.
error_authInvalid access_token.
error_authInvalid partner_id or shopid.
shop_no_linkedPartner and shop has no linked.
shop_bannedThe shop account has been banned. Permissions for shop authorization and API calls have been suspended until the shop account is restored.
invalid_acceess_tokenInvalid access_token, please have a check.
partner_shop_no_linkInvalid partner_id or shop_id, please have a check.
error_ashop_api_permissionThe shop is Affiliate shop has no permission to call this API.
error_kyc_authNo permission. Please inform the seller to complete the Seller Registration on Shopee Seller Center first, then this shop can call for this API.
error_authSystem error, please try again later.
error_paramThere is no shop_id in query.
error_paramshop_id is invalid, should be an integer between 0 and 4294967295.
#

§14 Update log

Update log

DateChange
2022-07-27Add Error Example information
2022-06-28Optimize the Sample information of Request Parameter and Response Parameter
2021-09-06update the description of item_id_list
#