v2.add_on_deal.get_add_on_deal_list

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

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

打开官方原文 ↗

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

查看技术与溯源信息

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

资料正文

§1 v2.add_on_deal.get_add_on_deal_list

Get Add-on Deal List

§2 Overview

Overview

Field	Value
Module	Add-On Deal
API type	Shop
HTTP method	GET
Path	/api/v2/add_on_deal/get_add_on_deal_list
Production URL	https://partner.shopeemobile.com/api/v2/add_on_deal/get_add_on_deal_list
Sandbox URL	https://partner.test-stable.shopeemobile.com/api/v2/add_on_deal/get_add_on_deal_list
Rate limit	[0, 0, 0]
Permission	ERP System; Seller In House System; Marketing; Customized APP; Swam ERP

§3 Request parameters

Request parameters

Name	Type	Required	Sample	Description
promotion_status	string	Yes	all	The Status of add on deal，default status is all
page_no	int	No	1	The default page number is 1
page_size	int	No	100	The default page size is 100

§4 Response parameters

Response parameters

Name	Type	Sample	Description
error	string		Error code
message	string		The description of error code
request_id	string	dc46d78810be446693995d31d03312c0	The identifier of the API request for error tracking
response	object
response.add_on_deal_list	object[]		The list of add on deal id
response.add_on_deal_list.start_time	int	1617105600	The time when add on deal activity start.
response.add_on_deal_list.end_time	int	1617195600	The time when add on deal activity end
response.add_on_deal_list.promotion_type	int	0	The type of add on deal：add on discount =0；gift with mini spend=1
response.add_on_deal_list.purchase_min_spend	float	3.0	The minimum purchase amount that needs to be met to buy the gift with min.Spend
response.add_on_deal_list.add_on_deal_id	int	20183	Shopee's unique identifier for an add on deal activity.
response.add_on_deal_list.per_gift_num	int	1	Number of gifts that buyers can get
response.add_on_deal_list.promotion_purchase_limit	int	12	Max. number of add-on products that a customer can purchase per order.
response.add_on_deal_list.add_on_deal_name	string	Bundle deal name test	Title of the add on deal
response.add_on_deal_list.source	int	1	The create source of bundle deal：Seller=1，shopee admin=0
response.add_on_deal_list.sub_item_prioriry	int[]	[100862950,100863523]	The display sequence of sub item in buyer side
response.more	boolean	true	This is to indicate whether the promotion list is more than one page. If this value is true, you may want to continue to check next page to retrieve the rest of promotions.

§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 Java

Java

{
    "promotion_status": "all",
    "page_no": 1,
    "page_size": 100
}

§8 Response sample

Response sample

§9 JSON

JSON

{
    "message": "",
    "request_id": "dc46d78810be446693995d31d03312c0",
    "response": {
        "add_on_deal_list": [
            {
                "start_time": 1617105600,
                "purchase_min_spend": "3.0",
                "promotion_type": 0,
                "source": 1,
                "add_on_deal_id": 20183,
                "end_time": 1617195600,
                "add_on_deal_name": "Bundle deal name test",
                "per_gift_num": 1,
                "promotion_purchase_limit": 12,
                "sub_item_priority":[]
            }
        ],
        "more": true
    },
    "error": ""
}

§10 Error example

Error example

§11 JSON

JSON

{
    "message": "Please input page type between 1-100",
    "request_id": "a62859caba947367db70d566e8a9855b",
    "response": {},
    "error": "add_on.add_on_page_size_error"
}

§12 Errors

Errors

Error	Description	Solution
add_on.add_on_status_error	Please input correct promotion status: all, ongoing, upcoming, expired
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-18	update the required data of promotion_status
2021-05-17	New API

这条内容对你有帮助吗？