Skip to main content

v2.bundle_deal.update_bundle_deal

POST /api/v2/bundle_deal/update_bundle_deal

update bundle deal. Relevant restrictions refer to FAQ:https://open.shopee.com/faq/254

Endpoint URL

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

Common Request Parameters

NameTypeSampleDescription
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

Request Parameters

NameTypeRequiredSampleDescription
rule_typeint32False1The bundle deal rule type:FIX_PRICE = 1 ;DISCOUNT_PERCENTAGE = 2; DISCOUNT_VALUE = 3
discount_valuefloatFalse11.0The deducted price when when buying a bundle deal. Need to input it when the bundle deal rule type is 3
fix_pricefloatFalse11.0The 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_percentageint32False33The discount that the buyer can get when buying a bundle deal. Need to input it when the bundle deal rule type is 2
min_amountint32False123The quantity of items that need buyer to combine purchased
start_timetimestampFalse1655654412The time when bundle deal activity start.The start time must be later than current time.
end_timetimestampFalse1658246412The time when bundle deal activity end. The end time must be later than current time.
namestringFalsebundle nameTitle of the bundle deal
purchase_limitint32False3Maximum number of bundle deals that can be bought by a buyer.
bundle_deal_idint32True6833Shopee's unique identifier for a bundle deal activity.
additional_tiersobjectFalseUse 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_amountint32True100The quantity of items that the buyers need to purchase for additional tier
fix_pricefloatFalse100.00The 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_valuefloatFalse20.00The 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_percentageint32False20The 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

Response Parameters

NameTypeSampleDescription
errorstringError code
messagestringThe description of error code
request_idstring2cda1f9c9b44449aedbc11dwer3ced242The identifier of the API request for error tracking
responseobject
bundle_deal_idint326833Shopee's unique identifier for a bundle deal activity.
namestringbundle nameTitle of the bundle deal
start_timetimestamp1655654412The time when bundle deal activity start.
end_timetimestamp1658246412The time when bundle deal activity end.
bundle_deal_ruleobject
rule_typeint321The bundle deal rule type:FIX_PRICE = 1 ;DISCOUNT_PERCENTAGE = 2; DISCOUNT_VALUE = 3
discount_valuefloat11.0The deducted price when when buying a bundle deal. Need to input it when the bundle deal rule type is 3
fix_pricefloat11.0The 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_percentageint3233The discount that the buyer can get when buying a bundle deal. Need to input it when the bundle deal rule type is 2
min_amountint32123The quantity of items that need buyer to combine purchased
additional_tiersobject[]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_amountint32123The quantity of items that the buyers need to purchase for additional tier
fix_pricefloat11.0The 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_valuefloat11.0The 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_percentageint3233The 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_limitint323Maximum number of bundle deals that can be bought by a buyer.