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

v2.logistics.update_channel

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.update_channel

Use this api to update shop level logistics channel's configuration.

#

§2 Overview

Overview

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

§3 Request parameters

Request parameters

NameTypeRequiredSampleDescription
logistics_channel_idint64Yes14623The identity of logistic channel.
enabledbooleanNotrueWhether to enable this logistic channel.
cod_enabledbooleanNotrueWhether to enable COD for this logistic channel. Only COD supported channels are applicable.
auto_call_driver_settingobjectNo
auto_call_driver_setting.auto_call_driver_enabledbooleanNotrueWhether to enable Auto Call Driver for this logistic channel.
auto_call_driver_setting.preparation_timeint32No10Used to set the Preparation Time for this channel, in minutes. Required when auto_call_driver_enabled = true.; Note: Please ensure the passed preparation_time value falls within the preparation_time_limit range returned by v2.logistics.get_channel_list.
#

§4 Response parameters

Response parameters

NameTypeRequiredSampleDescription
request_idstringdf17f35abb4244938b22a675211dc99cThe identifier of the API request for error tracking.
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.shop_idint64123123Shopee's unique identifier for a shop.
response.enabledbooleantrueWhether this logistic channel is enabled.
response.cod_enabledbooleanfalseWhether COD is enabled for this channel.
response.logistics_channel_idint6414623The identity of logistic channel.
response.updated_channelsobject[]List of channels that are updated in the operation (inclusive of dependent logistics channels)
response.updated_channels.channel_idint6480025Logistics channel ID
response.updated_channels.channel_display_namestringchannel AnterajaLogistics channel name
response.updated_channels.unsupport_warehouseobject[]List details of unsupported warehouses
response.updated_channels.unsupport_warehouse.warehouse_idint6478Unsupported warehouse ID
response.updated_channels.unsupport_warehouse.warehouse_namestringID_WHS_03Unsupported warehouse name
response.is_multi_warehousebooleanfalse
response.auto_call_driver_settingobject
response.auto_call_driver_setting.auto_call_driver_enabledbooleantrueIndicate whether Auto Call Driver is currently enabled for this channel.
response.auto_call_driver_setting.preparation_timeint3210The current valid preparation time for this channel, in minutes.
#

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

§6 Request samples

Request samples

#

§7 Payload

Payload

{
	"logistics_channel_id": 14623,
	"enabled": true,
	"cod_enabled": true
}
#

§8 Java

Java

Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.post("https://partner.shopeemobile.com/api/v2/logistics/update_channel?shop_id=shop_id&partner_id=partner_id&sign=sign&access_token=access_token&timestamp=timestamp")
.header("Content-Type","application/json")
.body("{
   \"cod_enabled\": true,
   \"enabled\": true,
   \"logistics_channel_id\": 14623,
   \"preferred\": true
}")
.asString();
#

§9 PHP

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://partner.shopeemobile.com/api/v2/logistics/update_channel?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 => 'POST',
  CURLOPT_POSTFIELDS => '{
    "cod_enabled": true,
    "enabled": true,
    "logistics_channel_id": 14623,
    "preferred": true
}',
  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/update_channel?partner_id=partner_id&sign=sign&access_token=access_token&timestamp=timestamp&shop_id=shop_id' \
--header 'Content-Type: application/json' \
--data-raw '{
   "cod_enabled": true,
   "enabled": true,
   "logistics_channel_id": 14623,
   "preferred": true
}'
#

§11 Python

Python

import requests
import json

url = "https://partner.shopeemobile.com/api/v2/logistics/update_channel?access_token=access_token&partner_id=partner_id&shop_id=shop_id&sign=sign&timestamp=timestamp"

payload=json.dumps({
  "cod_enabled": True,
  "enabled": True,
  "logistics_channel_id": 14623,
  "preferred": True
})
headers = {
  'Content-Type': 'application/json'
}
response = requests.request("POST",url,headers=headers, data=payload, allow_redirects=False)

print(response.text)
#

§12 Response sample

Response sample

#

§13 JSON

JSON

{
	"request_id": "df17f35abb4244938b22a675211dc99c",
	"error": "error_auth",
	"message": "Invalid access_token.",
	"response": {
		"shop_id": 123123,
		"enabled": true,
		"cod_enabled": false,
		"logistics_channel_id": 14623,
                "is_multi_warehouse": true,
		"update_channels": [{
			"channel_id": 1000,
			"channel_display_name": "",
			"unsupport_warehouse": [{
				"warehouse_id": 1,
				"warehouse_name": "abc"
			}]
		}]
	}

}
#

§14 Error example

Error example

#

§15 JSON

JSON

{
    "error": "logistics.error_param",
    "message": "Invalid logistics_channel_id. Please check the logistics_channel_id.",
    "request_id": "c955f5939580785debf7aaec62ec8d07"
}
#

§16 Errors

Errors

ErrorDescriptionSolution
error_paramSeller or Channel does not support Auto-Call.
error_paramInvalid Auto-Call setting param.
error_paramInvalid Seller preparation time.
error_paramShipping options of Direct Shop will follow Local Shop.
logistics_errorChannel is invalid. Please check the channel id.
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.
logistics.has_item_in_bundlechannel is not allow to disable due to there is item in the bundle
logistics.error_paramInvalid logistics_channel_id. Please check the logistics_channel_id.
errorno supported warehouse address
logistics_errorThis channel is now related to SPX Hemat channel (80029), to enable or disable it please update SPX Hemat channel instead
logistics.compulsory_channel_rule{parent_channel} cannot be modified. Please enable at least 1 of the following channel(s) first: {seller channel name list}
logistics.dependent_block_rule{parent_channel} cannot be turned off due to dependent block rule. Please disable all the following channel(s) before proceed: {seller channel name list}
logistics.minimum_activation_rule{parent_channel} cannot be turned off. Please enable at least 1 of the following channel(s): {seller channel name list}
logistics.address_miss_long_latAddress miss long lat.
logistics.require_pickup_addressPlease go to set pickup address first.
logistics.not_allow_to_update_channelYou are not allowed to enable or disable channel.
common.invalid_shopShop id is invalid. Please check your shop.
logistics_errorSorry that this masked channel can't be enabled.
logistics_errorSorry that this masked channel can't be enabled.
logistics_errorSorry that this channel can’t be disabled since it is force enabled.
logistics_errorSorry that this channel can't be enabled since it doesn’t pass the validation (whitelist validation / exclusive validation / serviceable validation ).
logistics_errorSorry that this masked channel can't be preferred.
logistics_errorSorry that this channel can't be enabled(disabled)/preferred/ COD enabled(COD disabled).
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
#

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

§18 Update log

Update log

DateChange
2026-04-09Add auto_call_driver_setting request and response parameters
2023-09-27sunset the request parameters "preferred" since "Preferred channel setting is no longer supported".
#