stable本次发布有变化全部展示
来自 Shopee 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存,可追溯
- 官方原文可核对
资料正文
§1 v2.bundle_deal.get_bundle_deal
get bundle deal detail
§2 Overview
Overview
| Field | Value |
|---|---|
| Module | Bundle Deal |
| API type | Shop |
| HTTP method | GET |
| Path | /api/v2/bundle_deal/get_bundle_deal |
| Production URL | https://partner.shopeemobile.com/api/v2/bundle_deal/get_bundle_deal |
| Sandbox URL | https://partner.test-stable.shopeemobile.com/api/v2/bundle_deal/get_bundle_deal |
| 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 |
|---|---|---|---|---|
| bundle_deal_id | int32 | Yes | 113891 | Shopee's unique identifier for a bundle deal activity. |
§4 Response parameters
Response parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| error | string | Indicate error type if hit error. Empty if no error happened. | ||
| message | string | Indicate error details if hit error. Empty if no error happened. | ||
| request_id | string | d929c6ca9b4dbff5ed8fb33bb45c30a8 | The identifier of the API request for error tracking | |
| response | object | Detail informations you are querying. | ||
| response.bundle_deal_id | int32 | 113891 | Shopee's unique identifier for a bundle deal activity. | |
| response.name | string | Bundle Deal Test | Title of the bundle deal | |
| response.start_time | timestamp | 1655654412 | The time when bundle deal activity start. | |
| response.end_time | timestamp | 1658246412 | The time when bundle deal activity end. | |
| response.bundle_deal_rule | object | |||
| response.bundle_deal_rule.rule_type | int32 | 1 | The bundle deal rule type:FIX_PRICE = 1 ;DISCOUNT_PERCENTAGE = 2; DISCOUNT_VALUE = 3 | |
| response.bundle_deal_rule.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 | |
| response.bundle_deal_rule.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 | |
| response.bundle_deal_rule.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 | |
| response.bundle_deal_rule.min_amount | int32 | 2 | The quantity of items that need buyer to combine purchased | |
| response.bundle_deal_rule.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 | ||
| response.bundle_deal_rule.additional_tiers.min_amount | int32 | 2 | The quantity of items that the buyers need to purchase for additional tier | |
| response.bundle_deal_rule.additional_tiers.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. | |
| response.bundle_deal_rule.additional_tiers.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 | |
| response.bundle_deal_rule.additional_tiers.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 | |
| response.purchase_limit | int32 | 6 | Maximum number of bundle deals that can be bought by a buyer. |
§5 Common parameters
Common parameters
| Name | Type | Required | 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
Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.get("https://partner.shopeemobile.com/api/v2/bundle_deal/get_bundle_deal?access_token=access_token&bundle_deal_id=113891&partner_id=partner_id&shop_id=shop_id&sign=sign×tamp=timestamp")
.asString();
§8 PHP
PHP
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://partner.shopeemobile.com/api/v2/bundle_deal/get_bundle_deal?access_token=access_token&bundle_deal_id=113891&partner_id=partner_id&shop_id=shop_id&sign=sign×tamp=timestamp',
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => '',
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 0,
CURLOPT_FOLLOWLOCATION => true,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => 'GET',
CURLOPT_HTTPHEADER => array(
'Content-Type: application/json'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
§9 cURL
cURL
curl --location --request GET 'https://partner.shopeemobile.com/api/v2/bundle_deal/get_bundle_deal?access_token=access_token&bundle_deal_id=113891&partner_id=partner_id&shop_id=shop_id&sign=sign×tamp=timestamp'
§10 Python
Python
import requests
url = "https://partner.shopeemobile.com/api/v2/bundle_deal/get_bundle_deal?access_token=access_token&bundle_deal_id=113891&partner_id=partner_id&shop_id=shop_id&sign=sign×tamp=timestamp"
payload={}
headers = {
}
response = requests.request("GET",url,headers=headers, data=payload, allow_redirects=False)
print(response.text)
§11 Response sample
Response sample
§12 JSON
JSON
{
"error": "-",
"message": "-",
"request_id": "d929c6ca9b4dbff5ed8fb33bb45c30a8",
"response": {
"bundle_deal_id": 113891,
"name": "Bundle Deal Test",
"start_time": 1655654412,
"end_time": 1658246412,
"bundle_deal_rule": {
"rule_type": 1,
"discount_value": 11,
"fix_price": 11,
"discount_percentage": 33,
"min_amount": 2,
"additional_tiers": {
"min_amount": 2,
"fix_price": 11,
"discount_value": 11,
"discount_percentage": 33
}
},
"purchase_limit": 6
}
}
§13 Error example
Error example
§14 JSON
JSON
{
"message": "Bundle deal doesn't existed",
"request_id": "d73545189ae166e04df1a6688346bc64",
"response": {},
"error": "bundle.bundle_deal_not_exists"
}
§15 Errors
Errors
| Error | Description | Solution |
|---|---|---|
| bundle.bundle_deal_error_unknown | Unknown error occurred in the service | |
| bundle.bundle_deal_not_exists | Bundle deal doesn't existed | |
| 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 |
§16 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. |
§17 Update log
Update log
| Date | Change |
|---|---|
| 2025-09-08 | select type for some parameters |
| 2022-08-29 | add additional_tiers |
| 2022-07-26 | Add Error Example information |
| 2022-06-30 | Optimize the Sample information of Request Parameter and Response Parameter |
| 2021-04-25 | update |
