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

v2.logistics.get_channel_list

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.logistics.get_channel_list

Use this api to get all supported logistic channels.

#

§2 Overview

Overview

FieldValue
ModuleLogistics
API typeShop
HTTP methodGET
Path/api/v2/logistics/get_channel_list
Production URLhttps://partner.shopeemobile.com/api/v2/logistics/get_channel_list
Sandbox URLhttps://partner.test-stable.shopeemobile.com/api/v2/logistics/get_channel_list
Rate limit[0, 0, 0]
PermissionERP System; Seller In House System; Product Management; Order Management; Swam ERP
#

§3 Response parameters

Response parameters

NameTypeRequiredSampleDescription
errorstringerror_authIndicate error type if hit error. Empty if no error happened.
messagestringInvalid access_token.Indicate error details if hit error. Empty if no error happened.
responseobjectDetail informations you are querying.
response.logistics_channel_listobject[]The list of logistics channel.
response.logistics_channel_list.logistics_channel_idint6428016The identity of logistic channel.
response.logistics_channel_list.logistics_channel_namestringVNPost Nhanh_productThe name of logistic channel.
response.logistics_channel_list.cod_enabledbooleantrueThis is to indicate whether this logistic channel supports COD
response.logistics_channel_list.enabledbooleantrueWhether this logistic channel is enabled on shop level.
response.logistics_channel_list.fee_typestringSIZE_INPUTSIZE_SELECTION; SIZE_INPUT; FIXED_DEFAULT_PRICE; CUSTOM_PRICE
response.logistics_channel_list.size_listobject[]Only for fee_type is SIZE_SELECTION
response.logistics_channel_list.size_list.size_idstring0The identity of size.
response.logistics_channel_list.size_list.namestringThe name of size.
response.logistics_channel_list.size_list.default_pricefloatThe pre-defined shipping fee for the specific size.
response.logistics_channel_list.weight_limitobjectThe weight limit for this logistic channel.
response.logistics_channel_list.weight_limit.item_max_weightfloat10.0The 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_weightfloat0.01The 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_dimensionobjectThe dimension limit for this logistic channel.
response.logistics_channel_list.item_max_dimension.heightfloat100.0The max height limit.
response.logistics_channel_list.item_max_dimension.widthfloat100.0The max width limit.
response.logistics_channel_list.item_max_dimension.lengthfloat100.0The max length limit.
response.logistics_channel_list.item_max_dimension.unitstringcmThe unit for the limit.
response.logistics_channel_list.item_max_dimension.dimension_sumfloat280.0The sum of the item's dimension
response.logistics_channel_list.volume_limitobjectThe limit of item volume.
response.logistics_channel_list.volume_limit.item_max_volumefloat10.0The 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_volumefloat1.0The 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_descriptionstringFor checkout channels, this field indicates its corresponding fulfillment channels.
response.logistics_channel_list.force_enablebooleanfalseIndicates whether the logistic channel is force enabled on Shop Level. If true, sellers cannot close this channel.
response.logistics_channel_list.mask_channel_idint640Indicate 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_feebooleanfalseIndicate 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_borderbooleanfalseIndicate whether this channel support cross border shipping.
response.logistics_channel_list.seller_logistic_has_configurationbooleanfalseIndicate 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_capabilityobjectThe capability of one logistic channel.
response.logistics_channel_list.logistics_capability.seller_logisticsbooleanfalseIndicate 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.preprintbooleanfalseIndicate whether this channel support pre-print AWB
response.logistics_channel_list.service_type_identifierstringinstantThis parameter specifies the delivery service type of logistics channel. Applicable values: - instant; - same_day; - null
response.logistics_channel_list.auto_call_driver_settingobject
response.logistics_channel_list.auto_call_driver_setting.auto_call_driver_eligiblebooleantrueIndicate whether this channel is eligible for Auto Call Driver.
response.logistics_channel_list.auto_call_driver_setting.auto_call_driver_enabledbooleantrueIndicate whether Auto Call Driver is currently enabled for this channel
response.logistics_channel_list.auto_call_driver_setting.preparation_timeint3210The current valid preparation time for this channel, in minutes.
response.logistics_channel_list.auto_call_driver_setting.preparation_time_limitobjectThe 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_timeint3210The minimum allowable preparation time, in minutes.
response.logistics_channel_list.auto_call_driver_setting.preparation_time_limit.max_preparation_timeint3230The maximum allowable preparation time, in minutes.
response.logistics_channel_list.support_pausebooleanfalseIndicates 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_channelbooleantrueIndicates if the channel is compulsory. If the value is true, at least one such channel must be enabled.
response.logistics_channel_list.channel_relation_rulesobject[]Indicate the related rules & channels of this logistic channel.
response.logistics_channel_list.channel_relation_rules.related_enabled_channelsint64[]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_channelsint64[]Channels that must be disabled before or while disabling this parent channel.
#

§4 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
#

§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&timestamp=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&timestamp=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&timestamp=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&timestamp=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

ErrorDescriptionSolution
error_paramShipping options of Direct Shop will follow Local Shop.
error_not_foundWrong parameters, detail: {msg}.
error_paramWrong parameters, detail: {msg}.
error_permissionSorry you don't have the permission, detail: {msg}.
error_serverSystem error. Please try again later.
common.invalid_shopShop id is invalid. Please check your shop.
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
#

§15 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.
#

§16 Update log

Update log

DateChange
2026-05-22Add compulsory_channel and channel_relation_rules response parameters
2026-04-09Add auto_call_driver_setting & support_pause response parameters
2025-12-26Add service_type_identifier response parameter
2025-09-08add new response field "preprint"
2023-12-15add new response field "support_cross_border"
#