stable本次发布有变化全部展示
来自 Shopee 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存,可追溯
- 官方原文可核对
资料正文
§1 v2.logistics.set_mart_packaging_info
[Only for ID mart seller] This API allows sellers to set up their packaging fee info. Through this API, sellers can enable or disable packaging fees, and if enabled, specify the dimensions of the packaging and the associated fee. This ensures that sellers can configure their shipping costs accurately based on their packaging requirements.
§2 Overview
Overview
| Field | Value |
|---|---|
| Module | Logistics |
| API type | Shop |
| HTTP method | POST |
| Path | /api/v2/logistics/set_mart_packaging_info |
| Production URL | https://partner.shopeemobile.com/api/v2/logistics/set_mart_packaging_info |
| Sandbox URL | https://partner.test-stable.shopeemobile.com/api/v2/logistics/set_mart_packaging_info |
| Permission | ERP System; Seller In House System; Order Management |
§3 Request parameters
Request parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| enable | boolean | Yes | true | Indicates whether the seller has enabled or disabled the packaging fee configuration.; True: The seller charges a packaging fee.; False: The seller does not charge a packaging fee. |
| dimension | object | No | Required if enabled is set to True. | |
| dimension.length | int32 | Yes | 15 | The length of the packaging in centimetres (cm). |
| dimension.width | int32 | Yes | 15 | The width of the packaging in centimetres (cm). |
| dimension.height | int32 | Yes | 15 | The height of the packaging in centimetres (cm). |
| packaging_fee | object | No | Required if enabled is set to True. | |
| packaging_fee.value | float | Yes | 100.00 | The packaging fee price in your region's local currency.; For SG/MY/BR/MX seller: Sellers can set the price with two decimal place, other regions can only set the price as an integer. |
§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 | The identifier for an API request for error tracking. | ||
| response | object | Detail informations you are querying. | ||
| response.enable | boolean | true | Indicates whether the seller has enabled or disabled the packaging fee configuration.; True: The seller charges a packaging fee.; False: The seller does not charge a packaging fee. | |
| response.dimension | object | Returned only if enabled is set to True. | ||
| response.dimension.length | int32 | 15 | The length of the packaging in centimetres (cm). | |
| response.dimension.width | int32 | 15 | The width of the packaging in centimetres (cm). | |
| response.dimension.height | int32 | 15 | The height of the packaging in centimetres (cm). | |
| response.packaging_fee | object | Returned only if enabled is set to True. | ||
| response.packaging_fee.value | float | 100.00 | The packaging fee price in the seller's local currency. |
§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 Payload
Payload
{
"enable": true,
"dimension": {
"length": 15,
"width": 15,
"height": 15
},
"packaging_fee": {
"value": 100.00
}
}
§8 Java
Java
Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.post("https://partner.shopeemobile.com/api/v2/logistics/set_mart_packaging_info?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign×tamp=timestamp")
.header("Content-Type","application/json")
.body("{
\"dimension\": {
\"height\": 15,
\"length\": 15,
\"width\": 15
},
\"enable\": true,
\"packaging_fee\": {
\"value\": 100.00
}
}")
.asString();
§9 PHP
PHP
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://partner.shopeemobile.com/api/v2/logistics/set_mart_packaging_info?access_token=access_token&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 => 'POST',
CURLOPT_POSTFIELDS => '{
"dimension": {
"height": 15,
"length": 15,
"width": 15
},
"enable": true,
"packaging_fee": {
"value": 100.00
}
}',
CURLOPT_HTTPHEADER => array(
'Content-Type: application/json'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
§10 cURL
cURL
curl --location --request POST 'https://partner.shopeemobile.com/api/v2/logistics/set_mart_packaging_info?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign×tamp=timestamp' \
--header 'Content-Type: application/json' \
--data-raw '{
"dimension": {
"height": 15,
"length": 15,
"width": 15
},
"enable": true,
"packaging_fee": {
"value": 100.00
}
}'
§11 Python
Python
import requests
import json
url = "https://partner.shopeemobile.com/api/v2/logistics/set_mart_packaging_info?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign×tamp=timestamp"
payload=json.dumps({
"dimension": {
"height": 15,
"length": 15,
"width": 15
},
"enable": True,
"packaging_fee": {
"value": 100.00
}
})
headers = {
'Content-Type': 'application/json'
}
response = requests.RPCRequest("POST",url,headers=headers, data=payload, allow_redirects=False)
print(response.text)
§12 Response sample
Response sample
§13 JSON
JSON
{
"error": "",
"message": "",
"request_id": "e3e3e7f334afb1ec6b29b57e1285f801",
"response": {
"enable": true,
"dimension": {
"length": 15,
"width": 15,
"height": 15
},
"packaging_fee": {
"value": 100.00
}
}
}
§14 Errors
Errors
| Error | Description | Solution |
|---|---|---|
| logistics.invalid_address_version | Some addresses are no longer supported per new regulation, please update to avoid wrong fulfilment | |
| 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 |
§15 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. |
§16 Update log
Update log
| Date | Change |
|---|---|
| 2025-07-03 | New API |
