stable本次发布有变化全部展示
来自 Shopee 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存,可追溯
- 官方原文可核对
资料正文
§1 v2.logistics.get_channel_list
Use this api to get all supported logistic channels.
§2 Overview
Overview
| Field | Value |
|---|---|
| Module | Logistics |
| API type | Shop |
| HTTP method | GET |
| Path | /api/v2/logistics/get_channel_list |
| Production URL | https://partner.shopeemobile.com/api/v2/logistics/get_channel_list |
| Sandbox URL | https://partner.test-stable.shopeemobile.com/api/v2/logistics/get_channel_list |
| Rate limit | [0, 0, 0] |
| Permission | ERP System; Seller In House System; Product Management; Order Management; Swam ERP |
§3 Response parameters
Response parameters
| Name | Type | Required | Sample | Description |
|---|---|---|---|---|
| error | string | error_auth | Indicate error type if hit error. Empty if no error happened. | |
| message | string | Invalid access_token. | Indicate error details if hit error. Empty if no error happened. | |
| response | object | Detail informations you are querying. | ||
| response.logistics_channel_list | object[] | The list of logistics channel. | ||
| response.logistics_channel_list.logistics_channel_id | int64 | 28016 | The identity of logistic channel. | |
| response.logistics_channel_list.logistics_channel_name | string | VNPost Nhanh_product | The name of logistic channel. | |
| response.logistics_channel_list.cod_enabled | boolean | true | This is to indicate whether this logistic channel supports COD | |
| response.logistics_channel_list.enabled | boolean | true | Whether this logistic channel is enabled on shop level. | |
| response.logistics_channel_list.fee_type | string | SIZE_INPUT | SIZE_SELECTION; SIZE_INPUT; FIXED_DEFAULT_PRICE; CUSTOM_PRICE | |
| response.logistics_channel_list.size_list | object[] | Only for fee_type is SIZE_SELECTION | ||
| response.logistics_channel_list.size_list.size_id | string | 0 | The identity of size. | |
| response.logistics_channel_list.size_list.name | string | The name of size. | ||
| response.logistics_channel_list.size_list.default_price | float | The pre-defined shipping fee for the specific size. | ||
| response.logistics_channel_list.weight_limit | object | The weight limit for this logistic channel. | ||
| response.logistics_channel_list.weight_limit.item_max_weight | float | 10.0 | The max weight for an item on this logistic channel.If the value is 0 or null, that means there is no limit. | |
| response.logistics_channel_list.weight_limit.item_min_weight | float | 0.01 | The min weight for an item on this logistic channel. If the value is 0 or null, that means there is no limit. | |
| response.logistics_channel_list.item_max_dimension | object | The dimension limit for this logistic channel. | ||
| response.logistics_channel_list.item_max_dimension.height | float | 100.0 | The max height limit. | |
| response.logistics_channel_list.item_max_dimension.width | float | 100.0 | The max width limit. | |
| response.logistics_channel_list.item_max_dimension.length | float | 100.0 | The max length limit. | |
| response.logistics_channel_list.item_max_dimension.unit | string | cm | The unit for the limit. | |
| response.logistics_channel_list.item_max_dimension.dimension_sum | float | 280.0 | The sum of the item's dimension | |
| response.logistics_channel_list.volume_limit | object | The limit of item volume. | ||
| response.logistics_channel_list.volume_limit.item_max_volume | float | 10.0 | The max volume for an item on this logistic channel.If the value is 0 or null, that means there is no limit for the item weight. | |
| response.logistics_channel_list.volume_limit.item_min_volume | float | 1.0 | The min volume for an item on this logistic channel. If the value is 0 or null, that means there is no limit for the item weight. | |
| response.logistics_channel_list.logistics_description | string | For checkout channels, this field indicates its corresponding fulfillment channels. | ||
| response.logistics_channel_list.force_enable | boolean | false | Indicates whether the logistic channel is force enabled on Shop Level. If true, sellers cannot close this channel. | |
| response.logistics_channel_list.mask_channel_id | int64 | 0 | Indicate the parent logistic channel ID. If it’s 0, it indicates the channel is a checkout(masked) channel; if it’s not 0, indicate the channel is a fulfillment channel and has a checkout channel(checkout channel’s channel_id equals this mask_channel_id) on top of it. Multiple channels may share the same mask_channel_id. | |
| response.logistics_channel_list.block_seller_cover_shipping_fee | boolean | false | Indicate whether the channel is blocked to use seller cover shipping fee function.; if the channel does not allow sellers to cover shipping fee, then the block_seller_cover_shipping_fee field will return true, otherwise it will return false. | |
| response.logistics_channel_list.support_cross_border | boolean | false | Indicate whether this channel support cross border shipping. | |
| response.logistics_channel_list.seller_logistic_has_configuration | boolean | false | Indicate If seller has set the Seller logistics configuration if set will return true, otherwise it will return false or null. | |
| response.logistics_channel_list.logistics_capability | object | The capability of one logistic channel. | ||
| response.logistics_channel_list.logistics_capability.seller_logistics | boolean | false | Indicate If it's a Seller logistics channel, if it's a Seller logistics channel will return true, otherwise it will return false. | |
| response.logistics_channel_list.preprint | boolean | false | Indicate whether this channel support pre-print AWB | |
| response.logistics_channel_list.service_type_identifier | string | instant | This parameter specifies the delivery service type of logistics channel. Applicable values: - instant; - same_day; - null | |
| response.logistics_channel_list.auto_call_driver_setting | object | |||
| response.logistics_channel_list.auto_call_driver_setting.auto_call_driver_eligible | boolean | true | Indicate whether this channel is eligible for Auto Call Driver. | |
| response.logistics_channel_list.auto_call_driver_setting.auto_call_driver_enabled | boolean | true | Indicate whether Auto Call Driver is currently enabled for this channel | |
| response.logistics_channel_list.auto_call_driver_setting.preparation_time | int32 | 10 | The current valid preparation time for this channel, in minutes. | |
| response.logistics_channel_list.auto_call_driver_setting.preparation_time_limit | object | The preparation time range allowed for this channel.; Note: When calling v2.logistics.update_channel to set the Preparation Time for the channel, the time must not exceed this range. | ||
| response.logistics_channel_list.auto_call_driver_setting.preparation_time_limit.min_preparation_time | int32 | 10 | The minimum allowable preparation time, in minutes. | |
| response.logistics_channel_list.auto_call_driver_setting.preparation_time_limit.max_preparation_time | int32 | 30 | The maximum allowable preparation time, in minutes. | |
| response.logistics_channel_list.support_pause | boolean | false | Indicates whether this channel supports the pause operation (Pausing allows the shop to temporarily prevent buyers from placing orders through this logistics channel).; - true: This channel is affected by the pause function. - false: This channel is not affected by the pause function. Note: Please first call v2.logistics.get_pause_status to get the current pause status of logistics channels under the shop. If is_paused = true, then call v2.logistics.get_channel_list and identify the range of channels affected by the pause function through support_pause = true. | |
| response.logistics_channel_list.compulsory_channel | boolean | true | Indicates if the channel is compulsory. If the value is true, at least one such channel must be enabled. | |
| response.logistics_channel_list.channel_relation_rules | object[] | Indicate the related rules & channels of this logistic channel. | ||
| response.logistics_channel_list.channel_relation_rules.related_enabled_channels | int64[] | Channels that will be auto-enabled in the same request if this channel is enabled. | ||
| response.logistics_channel_list.channel_relation_rules.related_dependent_block_channels | int64[] | Channels that must be disabled before or while disabling this parent channel. |
§4 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 |
§5 Request samples
Request samples
§6 Java
Java
Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.get("https://partner.shopeemobile.com/api/v2/logistics/get_channel_list?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign×tamp=timestamp")
.asString();
§7 PHP
PHP
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://partner.shopeemobile.com/api/v2/logistics/get_channel_list?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 => 'GET',
CURLOPT_HTTPHEADER => array(
'Content-Type: application/json'
),
));
$response = curl_exec($curl);
curl_close($curl);
echo $response;
§8 cURL
cURL
curl --location --request GET 'https://partner.shopeemobile.com/api/v2/logistics/get_channel_list?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign×tamp=timestamp'
§9 Python
Python
import requests
url = "https://partner.shopeemobile.com/api/v2/logistics/get_channel_list?access_token=access_token&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)
§10 Response sample
Response sample
§11 JSON
JSON
{
"error": "",
"message": "",
"request_id": "686fe13cb4c852300e2bf0c5d7527021",
"response": {
"logistics_channel_list": [
{
"block_seller_cover_shipping_fee": false,
"cod_enabled": true,
"enabled": true,
"fee_type": "SIZE_INPUT",
"force_enable": false,
"item_max_dimension": {
"dimension_sum": 90,
"height": 30,
"length": 30,
"unit": "cm",
"width": 30
},
"logistics_capability": {
"seller_logistics": false
},
"logistics_channel_id": 40029,
"logistics_channel_name": "Shopee Self Pick-up",
"logistics_description": "Shopee Self Collect operating hours are from Monday to Sunday, 9AM to 9PM (could varied by Collect)<br>Enable buyer to pick up their parcels at their convenient time and get parcels early.<br>You will have 7 days to collect once parcels arrive at selected Xpress Collect.<br>Shopee Xpress will notify by push notification and SMS or you can also check parcel status at in-app My Order page.\nShopee currently offer Free Shipping for buyer self collect option<br>You can find the Xpress Collect location near you in the Shopee Xpress Collect website<br>Please remember to bring your personal ID (same as the account buyer name) upon self collect for non- Cash of Delivery order.",
"mask_channel_id": 0,
"seller_logistic_has_configuration": null,
"size_list": [],
"support_cross_border": false,
"volume_limit": {
"item_max_volume": 0,
"item_min_volume": 0
},
"weight_limit": {
"item_max_weight": 5,
"item_min_weight": 0
},
"support_pause": false
},
{
"block_seller_cover_shipping_fee": false,
"cod_enabled": true,
"enabled": false,
"fee_type": "SIZE_INPUT",
"force_enable": false,
"item_max_dimension": {
"dimension_sum": 0,
"height": 0,
"length": 0,
"unit": "UNKNOWN",
"width": 0
},
"logistics_capability": {
"seller_logistics": false
},
"logistics_channel_id": 4002,
"logistics_channel_name": "Sulit Local",
"logistics_description": "",
"mask_channel_id": 0,
"seller_logistic_has_configuration": null,
"size_list": [],
"support_cross_border": false,
"volume_limit": {
"item_max_volume": 0,
"item_min_volume": 0
},
"weight_limit": {
"item_max_weight": 0,
"item_min_weight": 0
},
"support_pause": false
},
{
"block_seller_cover_shipping_fee": false,
"cod_enabled": true,
"enabled": true,
"fee_type": "SIZE_INPUT",
"force_enable": false,
"item_max_dimension": {
"dimension_sum": 0,
"height": 0,
"length": 0,
"unit": "UNKNOWN",
"width": 0
},
"logistics_capability": {
"seller_logistics": false
},
"logistics_channel_id": 4000,
"logistics_channel_name": "Standard Local",
"logistics_description": "",
"mask_channel_id": 0,
"seller_logistic_has_configuration": null,
"size_list": [],
"support_cross_border": false,
"volume_limit": {
"item_max_volume": 0,
"item_min_volume": 0
},
"weight_limit": {
"item_max_weight": 0,
"item_min_weight": 0
},
"support_pause": false
},
{
"block_seller_cover_shipping_fee": false,
"cod_enabled": true,
"enabled": true,
"fee_type": "SIZE_INPUT",
"force_enable": false,
"item_max_dimension": {
"dimension_sum": 0,
"height": 150,
"length": 150,
"unit": "cm",
"width": 150
},
"logistics_capability": {
"seller_logistics": false
},
"logistics_channel_id": 40018,
"logistics_channel_name": "J&T Express",
"logistics_description": "J&T branches operating hours are from Monday to Sunday, 9:00 AM to 5:00 PM\nEnable this channel to offer <a href=\"https://seller.shopee.ph/edu/article/1443\" target=\"_blank\">Free Shipping</a> to your buyers.<br><br>\nMaximum dimensions in centimeters (length x width x height): 150 cm x 150 cm x 150 cm\nMaximum weight in kilograms: 30 kg<br><br>\nYou need to provide your own packaging and shipping label/air waybill (AWB) on A6 size sticker paper. Air waybills (AWB) can be printed through Seller Centre upon arrangement of pickup.<br><br>\nYou can schedule pickup with J&T Express via Shopee app or Seller Centre.\nBooking cut-off time for <a href=\"https://seller.shopee.ph/edu/article/3848\" target=\"_blank\">same-day pickup:</a> 10:00 AM<br><br>\nYou can also drop off your parcels at any J&T Express participating branches stated in the <a href=\"http://www.jtexpress.ph/\" target=\"_blank\">J&T Express website.</a><br><br>\nBuyers can return parcels to sellers via integrated <a href=\"https://seller.shopee.ph/edu/article/5735\" target=\"_blank\">J&T Express Drop-off service.</a> This service is available in all participating J&T Express branches nationwide.",
"mask_channel_id": 4000,
"seller_logistic_has_configuration": null,
"size_list": [],
"support_cross_border": false,
"volume_limit": {
"item_max_volume": 0,
"item_min_volume": 0
},
"weight_limit": {
"item_max_weight": 50,
"item_min_weight": 0
},
"support_pause": true
},
{
"block_seller_cover_shipping_fee": false,
"cod_enabled": true,
"enabled": false,
"fee_type": "SIZE_INPUT",
"force_enable": false,
"item_max_dimension": {
"dimension_sum": 300,
"height": 150,
"length": 150,
"unit": "cm",
"width": 150
},
"logistics_capability": {
"seller_logistics": false
},
"logistics_channel_id": 40025,
"logistics_channel_name": "Flash Express",
"logistics_description": "<p>3pl Name: Flash Express Max Dimensions: 150 cm each side Max Actual Weight: 50kg Service Time: Monday to Sunday Pickup period - every day(including weekend and public holiday) 11am to 6pm Deliver period - every day(including weekend and public holiday) 9am to 6pm</p>",
"mask_channel_id": 4000,
"seller_logistic_has_configuration": null,
"size_list": [],
"support_cross_border": false,
"volume_limit": {
"item_max_volume": 0,
"item_min_volume": 0
},
"weight_limit": {
"item_max_weight": 50,
"item_min_weight": 0
}
},
{
"block_seller_cover_shipping_fee": false,
"cod_enabled": true,
"enabled": false,
"fee_type": "SIZE_INPUT",
"force_enable": false,
"item_max_dimension": {
"dimension_sum": 0,
"height": 150,
"length": 150,
"unit": "cm",
"width": 150
},
"logistics_capability": {
"seller_logistics": false
},
"logistics_channel_id": 40032,
"logistics_channel_name": "YTO Express",
"logistics_description": "",
"mask_channel_id": 4002,
"seller_logistic_has_configuration": null,
"size_list": [],
"support_cross_border": false,
"volume_limit": {
"item_max_volume": 0,
"item_min_volume": 0
},
"weight_limit": {
"item_max_weight": 80,
"item_min_weight": 0
},
"support_pause": false
}
]
}
}
§12 Error example
Error example
§13 JSON
JSON
{
"request_id": "2486e26ab8dcbb46e2b4e7177bc11e62",
"error": "error_auth",
"message": "Invalid partner_id or shopid."
}
§14 Errors
Errors
| Error | Description | Solution |
|---|---|---|
| error_param | Shipping options of Direct Shop will follow Local Shop. | |
| error_not_found | Wrong parameters, detail: {msg}. | |
| error_param | Wrong parameters, detail: {msg}. | |
| error_permission | Sorry you don't have the permission, detail: {msg}. | |
| error_server | System error. Please try again later. | |
| common.invalid_shop | Shop id is invalid. Please check your shop. | |
| 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 |
§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 |
|---|---|
| 2026-05-22 | Add compulsory_channel and channel_relation_rules response parameters |
| 2026-04-09 | Add auto_call_driver_setting & support_pause response parameters |
| 2025-12-26 | Add service_type_identifier response parameter |
| 2025-09-08 | add new response field "preprint" |
| 2023-12-15 | add new response field "support_cross_border" |
