v2.add_on_deal.update_add_on_deal_sub_item

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

来自 Shopee 官方资料快照 · 2026-09-06 12:10:23

打开官方原文 ↗

当前资料结构化阅读页
固定快照已留存，可追溯
官方原文可核对

查看技术与溯源信息

平台 / profile: Shopee / profile.shopee.api_reference
语言: en-US
发布版本: cn-20260909-2
标签: zhuge/sourceplatform/shopeeaudience/developercategory/api_doctopic/apitopic/developer

资料正文

§1 v2.add_on_deal.update_add_on_deal_sub_item

Update Add-on Deal Sub Item

§2 Overview

Overview

Field	Value
Module	Add-On Deal
API type	Shop
HTTP method	POST
Path	/api/v2/add_on_deal/update_add_on_deal_sub_item
Production URL	https://partner.shopeemobile.com/api/v2/add_on_deal/update_add_on_deal_sub_item
Sandbox URL	https://partner.test-stable.shopeemobile.com/api/v2/add_on_deal/update_add_on_deal_sub_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
add_on_deal_id	int	Yes	12069	Shopee's unique identifier for add on deal activity.
sub_item_list	object[]	Yes		The sub items added in this add on deal promotion.
sub_item_list.item_id	int	No	100760424	Shopee's unique identifier for an item.
sub_item_list.model_id	int	No	20760424	Shopee's unique identifier for a model.
sub_item_list.status	int	No	1	The status of add on deal item：enable = 1；disable =2
sub_item_list.sub_item_input_price	float	No	390.0	Add-on discount price before tax
sub_item_list.sub_item_limit	int	No	12	The purchase limit of sub item.The purchase limit of each sub item. Only the add on discount can be set and the default limit of gift with mini.spend is 1

§4 Response parameters

Response parameters

Name	Type	Sample	Description
error	string		Error code
message	string		The description of error code
request_id	string	0ec1535f87985a5e96a329fc7b51caf9	The identifier of the API request for error tracking
response	object
response.sub_item_list	object[]		The sub items added in this add on deal promotion.
response.sub_item_list.item_id	int	100760424	Shopee's unique identifier for an item.
response.sub_item_list.status	int	1	The status of add on deal item：enable = 1；disable =2
response.sub_item_list.model_id	int	20760424	Shopee's unique identifier for a model.
response.sub_item_list.fail_error	string	add_on.add_on_deal_error_unknown
response.sub_item_list.fail_message	string	The add on deal created by admin can't be edited
response.sub_item_list.sub_item_input_price	float	390.0	The discounted price of sub item
response.sub_item_list.sub_item_limit	int	12	The purchase limit of sub item.The purchase limit of each sub item. Only the add on discount can be set and the default limit of gift with mini.spend is 1
add_on_deal_id	int	12069	Shopee's unique identifier for add on deal activity.

§5 Common parameters

Common parameters

Name	Type	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

{
    "add_on_deal_id": 12069,
    "sub_item_list": [
        {
            "status": 1,
            "item_id": 100760424,
            "sub_item_input_price": 390,
            "sub_item_limit": 12
        }
    ]
}

§8 Response sample

Response sample

§9 JSON

JSON

{
    "message": "",
    "request_id": "0ec1535f87985a5e96a329fc7b51caf9",
    "response": {
        "add_on_deal_id": 12069,
        "sub_item_list": [
            {
                "status": 1,
                "item_id": 100760424,
                "sub_item_limit": 12,
                "sub_item_input_price": 390
            }
        ]
    },
    "error": ""
}

§10 Error example

Error example

§11 JSON

JSON

{
    "message": "",
    "request_id": "2dd4bff6393c32bbeb676f2620871d3b",
    "response": {
        "add_on_deal_id": 12209,
        "sub_item_list": [
            {
                "item_id": 1007604251,
                "model_id": 0,
                "fail_message": "The item does not existed",
                "fail_error": "add_on.add_on_item_error"
            }
        ]
    },
    "error": ""
}

§12 Errors

Errors

Error	Description	Solution
add_on.add_on_deal_error_unknown	The add on deal created by admin can't be edited
ADD_ON_DEAL_DTS_ERROR	The Days to ship is longer than that of main item
add_on.add_on_item_exceed_discount_limit_error	The overall item level promotion limit has been reached.
add_on.add_on_item_overlap	This product is already in add on deal main item list
add_on.add_on_item_overlap	This product is already in add on deal sub item list
add_on.add_on_shipping_channel_error	This product does not share a common shipping channel with the first enabled product.
add_on.add_on_item_overlap	This product is already in other add on deal main item list
add_on.add_on_item_overlap	This product is already in other bundle deal
add_on.add_on_deal_item_under_btoc	There are B2C items that can't be added into your promotion
add_on.add_on_deal_expired	The expired add on deal can't be edited
add_on.add_on_delete_error	Only upcoming add on deal can be deleted
add_on.add_on_item_invalid	The status of this product is abnormal
add_on.add_on_item_no_stock	The product is no stock
add_on.add_on_no_item	This item doesn't existed
add_on.add_on_deal_not_exists	The add on deal not existed
add_on.add_on_purchase_limit_error	The purchase limit of this product should exceeded the minimum purchase quantity
add_on.add_on_duplicate_item	The item is already existed in sub item
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.
error_param	Wrong parameters, detail: {msg}.
error_server	Something wrong. Please try later.
error_shop	shopid is invalid
error_param	request not from gateway

§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-26	Add Error Example information
2022-06-30	Optimize the Sample information of Request Parameter and Response Parameter
2021-05-17	New API

这条内容对你有帮助吗？