v2.bundle_deal.get_bundle_deal_list

GET /api/v2/bundle_deal/get_bundle_deal_list

get bundle deal list

Endpoint URL

URL: https://partner.shopeemobile.com/api/v2/bundle_deal/get_bundle_deal_list

Common Request 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

Request Parameters

Name	Type	Required	Sample	Description
page_size	int32	False	100	Data paging, representing the data size of each page, the maximum is 1000, the default is 20
time_status	int32	False	2	The Status of bundle deal，all=1；upcoming=2；ongoing=3，expired=4 , the default is 1
page_no	int32	False	1	Data paging, represents the page number, starting from 1, the default is 1

Response Parameters

Name	Type	Sample	Description
error	string		Error code
message	string		The description of error code
request_id	string	d929c6ca9b4dbff5ed8fb33bb45c30a8	The identifier of the API request for error tracking
response	object
bundle_deal_list	object[]		The list of bundle deal id
bundle_deal_id	int32	1111432	Shopee's unique identifier for a bundle deal activity.
name	string	Bundle Deal Test	Title of the bundle deal
start_time	timestamp	1655654412	The time when bundle deal activity start.
end_time	timestamp	1658246412	The time when bundle deal activity end.
bundle_deal_rule	object
rule_type	int32	1	The bundle deal rule type：FIX_PRICE = 1 ；DISCOUNT_PERCENTAGE = 2； DISCOUNT_VALUE = 3
discount_value	float	11.0	The deducted price when when buying a bundle deal. Need to input it when the bundle deal rule type is 3
fix_price	float	11.0	The amount of the buyer needs to spend to purchase a bundle deal. Need to input it when the bundle deal rule type is 1
discount_percentage	int32	33	The discount that the buyer can get when buying a bundle deal. Need to input it when the bundle deal rule type is 2
min_amount	int32	123	The quantity of items that need buyer to combine purchased
additional_tiers	object[]		Use to create tiered discount for bundle deals, a max of 2 additional tiers are allowed to create bundle deals like buy 2 get 10% off, buy 3 for 15% off, buy 4 for 20% off; For each tier, we will need to set the following 4 values based on bundle deal type +    min_amount = IntAttribute() +    fix_price = IntAttribute() +    discount_percentage = IntAttribute() +    discount_value = IntAttribute() Note: for additional tiers, the fix price, discount_percentage, discount_value should be consistent with tier 1
min_amount	int32	123	The quantity of items that the buyers need to purchase for additional tier
fix_price	float	11.0	The bundle price when the buyers purchase a bundle deal for additional tiers. Need to input it when the bundle deal rule type is 1.
discount_value	float	11.0	The bundle deal discount amount the buyer can save when purchasing a bundle deal. Need to input it when the bundle deal rule type is 3
discount_percentage	int32	33	The bundle deal discount% that the buyer can get when buying a bundle deal for additional tiers. Need to input it when the bundle deal rule type is 2
purchase_limit	int32	6	Maximum number of bundle deals that can be bought by a buyer.
more	boolean	true	this field shows whether there are more bundle deals in next page or not