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

v2.bundle_deal.add_bundle_deal_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.bundle_deal.add_bundle_deal_item

add product to bundle deal

#

§2 Overview

Overview

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

§3 Request parameters

Request parameters

NameTypeRequiredSampleDescription
bundle_deal_idint32Yes1234522Shopee's unique identifier for a bundle deal activity.
item_listobject[]YesThe items added in this bundle deal promotion.
item_list.item_idint32Yes1234221Shopee's unique identifier for an item.
item_list.statusint32Yes1The status of bundle deal item:enable = 1;disable =0
#

§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.
request_idstring30f80940cd99f194e488203d36bc1d21The identifier of the API request for error tracking
responseobjectDetail informations you are querying.
response.failed_listobject[]Indicate error details.
response.failed_list.item_idint321234221Shopee's unique identifier for an item.
response.failed_list.fail_errorstringbundle.bundle_deal_no_shipping_channelIndicate error type if one element hit error.
response.failed_list.fail_messagestringThis product does not set shipping channel.Indicate error details if one element hit error.
response.success_listobject[]The list of succeed added items
#

§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

{
    "bundle_deal_id": 11111,
    "item_list": [
        {
            "item_id": 1234,
            "status": 1
        }
    ]
}
#

§8 Response sample

Response sample

#

§9 JSON

JSON

{
    "error": "",
    "message": "",
    "request_id": "fdsfsdafdasfbgvfdgergd",
    "response": {
        "failed_list": [
            {
                "item_id": 1234,
                "fail_error": "bundle.bundle_deal_no_shipping_channel",
                "fail_message": "This product does not set shipping channel."
            }
        ],
        "success_list": [
            1111,
            2222,
            3333
        ]
    }
}
#

§10 Error example

Error example

#

§11 JSON

JSON

{
    "message": "",
    "request_id": "78118965d91ef184bfdc20a08b62d3ad",
    "response": {
        "success_list": [],
        "failed_list": [
            {
                "item_id": 8002383931,
                "fail_message": "product id not exists",
                "fail_error": "bundle.product_not_exist"
            }
        ]
    },
    "error": ""
}
#

§12 Errors

Errors

ErrorDescriptionSolution
bundle.bundle_deal_no_common_shipping_channelThis product does not share a common shipping channel with the first enabled product.
bundle.bundle_deal_no_shipping_channelThis product does not set shipping channel.
bundle.bundle_deal_item_no_common_logisticsbundle deal item has no common logistics
bundle.bundle_deal_item_under_btoc_tagThere are B2C items that can't be added into your promotion
bundle.bundle_deal_error_unknownUnknown error occurred in the service
bundle.bundle_deal_item_already_existThe item is already added
bundle.bundle_deal_item_exceed_discount_limit_errorThe overall item level promotion limit has been reached.
bundle.bundle_deal_status_errorItem status is abnormal
bundle.bundle_deal_overlap_errorThe item is already in add on deal
bundle.bundle_deal_overlap_errorThe item is already in other bundle deal
bundle.bundle_deal_stock_errorInsufficient item stock
bundle.bundle_deal_item_total_errorA maximum of 1000 items in bundle deal can be created
bundle.bundle_deal_no_auth_updateThe shopee created bundle deal can't be edited
bundle.bundle_deal_not_existsBundle deal doesn't existed
bundle.product_not_existproduct id not exists
bundle.bundle_deal_item_errorFailed to set bundle deal item
bundle.bundle_expiredbundle deal expired can not update
error_networkInner http call failed
error_dataparse data failed
error_datadata not exist
error_paramparameter invalid
error_paramThe information you queried is not found.
error_paramWrong parameters, detail: {msg}.
error_serverSomething wrong. Please try later.
error_shopshopid is invalid
error_paramrequest not from gateway
#

§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
2025-09-08select type for some parameters
2022-07-26Add Error Example information
2022-06-30Optimize the Sample information of Request Parameter and Response Parameter
2021-04-25update
2021-04-09New API
#