v2.logistics.get_channel_list

GET /api/v2/logistics/get_channel_list

Use this api to get all supported logistic channels.

Endpoint URL

URL: https://partner.shopeemobile.com/api/v2/logistics/get_channel_list

Common Request Parameters

Name	Type	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

No Request Parameters Set.

Response Parameters

Name	Type	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.
logistics_channel_list	object[]		The list of logistics channel.
logistics_channel_id	int64	28016	The identity of logistic channel.
logistics_channel_name	string	VNPost Nhanh_product	The name of logistic channel.
cod_enabled	boolean	true	This is to indicate whether this logistic channel supports COD
enabled	boolean	true	Whether this logistic channel is enabled on shop level.
fee_type	string	SIZE_INPUT	SIZE_SELECTION SIZE_INPUT FIXED_DEFAULT_PRICE CUSTOM_PRICE
size_list	object[]		Only for fee_type is SIZE_SELECTION
size_id	string	0	The identity of size.
name	string		The name of size.
default_price	float		The pre-defined shipping fee for the specific size.
weight_limit	object		The weight limit for this logistic channel.
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.
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.
item_max_dimension	object		The dimension limit for this logistic channel.
height	float	100.0	The max height limit.
width	float	100.0	The max width limit.
length	float	100.0	The max length limit.
unit	string	cm	The unit for the limit.
dimension_sum	float	280.0	The sum of the item's dimension
volume_limit	object		The limit of item volume.
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.
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.
logistics_description	string		For checkout channels, this field indicates its corresponding fulfillment channels.
force_enable	boolean	false	Indicates whether the logistic channel is force enabled on Shop Level. If true, sellers cannot close this channel.
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.
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.
support_cross_border	boolean	false	Indicate whether this channel support cross border shipping.
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.
logistics_capability	object		The capability of one logistic channel.
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.
preprint	boolean	false	Indicate whether this channel support pre-print AWB
service_type_identifier	string	instant	This parameter specifies the delivery service type of logistics channel. Applicable values: - instant - same_day - null