淘宝开放平台 - 文档中心

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
target_app_key	String	否	被调用的目标AppKey，仅当被调用的API为第三方ISV提供时有效。
sign_method	String	是	签名的摘要算法，可选值为：hmac，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。
session	String	否	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选。
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。
format	String	否	响应格式。默认为xml格式，可选值：xml，json。
v	String	是	API协议版本，可选值：2.0。
partner_id	String	否	合作伙伴身份标识。
simplify	Boolean	否	是否采用精简JSON返回格式，仅当format=json时有效，默认值为：false。

名称	类型	是否必须	示例值	更多限制	描述
capacity_request	CapacityRequest	必须			上门取退产能信息同步/更新
└ request_id String 必须 1691997065571 业务请求ID，用于做幂等 └ request_time Number 必须 1691997065571 时间戳（毫秒） └ supplier_id String 必须 10241007442310358 服务商ID └ delivery_code String 必须 STO 配资源编码 └ service_type String 必须 1 服务类型：1-上门取退 └ ability_type String 必须 1 能力：1-上门取退 └ service_scope_type String 必须 2 服务范围地址类型：1-行政地址；2-电子围栏 └ address_type String 可选 1 如果传入为行政地址，行政地址传入类型 1- 菜鸟地址库ID 传入 2- 中文地址传入 └ address_ids String [] 可选行政地址id（菜鸟地址库id） address_names AddressName [] 可选中文地址信息 └ province String 可选浙江省省 └ city String 可选杭州市市 └ area String 可选余杭区区 └ town String 可选五常街道街道 └ region_code String 可选 region-001 电子围栏外部ID64 条件必填（service_scope_type=2时，必填） └ update_method Number 必须 1 产能更新方式：1-全量更新；2-部分更新 ● 电子围栏产能首次同步时，需选择全量更新 ● 选择全量更新时，日常及指定日期时间段产能均做全量覆盖更新； ● 选择部分更新时，日常及指定日期时间段产能仅对传入的时间段的产能进行更新，其他时间段不做处理，维持原状 daily_capacity_infos CapacityInfo [] 可选日常产能信息 └ time_range String 可选 01:00-02:00 单位时间段（整点小时纬度，HH:MM-HH:MM）只能传入单位整点时间段，eg：01:00-02:00 └ capacity Number 可选 1 时间段产能（单），表示时间段内可揽可上门单数 specify_capacity_infos SpecifyCapacityInfo [] 可选指定日期产能信息 └ specify_date String 可选 2023-08-14 指定日期，YYYY-MM-DD specify_date_capacity CapacityInfo [] 可选时间段产能 └ time_range String 可选 01:00-02:00 单位时间段（整点小时纬度，HH:MM-HH:MM）只能传入单位整点时间段，eg：01:00-02:00 └ capacity Number 可选 1 时间段产能（单），表示时间段内可揽可上门单数

名称	类型	示例值	描述
capacity_response	CapacityResponse		返回值
└ success Boolean true 系统成功失败 true\|false └ code String 200 响应码 └ message String SUCCESS 响应信息 └ is_retry Boolean false 是否可重试

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
LogisticsExpressCapacityTmsAsyncRequest req = new LogisticsExpressCapacityTmsAsyncRequest();
LogisticsExpressCapacityTmsAsyncRequest.CapacityRequest obj1 = new LogisticsExpressCapacityTmsAsyncRequest.CapacityRequest();
obj1.setRequestId("1691997065571");
obj1.setRequestTime(1691997065571L);
obj1.setSupplierId("10241007442310358");
obj1.setDeliveryCode("STO");
obj1.setServiceType("1");
obj1.setAbilityType("1");
obj1.setServiceScopeType("2");
obj1.setAddressType("1");
obj1.setAddressIds("");
List<LogisticsExpressCapacityTmsAsyncRequest.AddressName> list3 = new ArrayList<LogisticsExpressCapacityTmsAsyncRequest.AddressName>();
LogisticsExpressCapacityTmsAsyncRequest.AddressName obj4 = new LogisticsExpressCapacityTmsAsyncRequest.AddressName();
list3.add(obj4);
obj4.setProvince("浙江省");
obj4.setCity("杭州市");
obj4.setArea("余杭区");
obj4.setTown("五常街道");
obj1.setAddressNames(list3);
obj1.setRegionCode("region-001");
obj1.setUpdateMethod(1L);
List<LogisticsExpressCapacityTmsAsyncRequest.CapacityInfo> list6 = new ArrayList<LogisticsExpressCapacityTmsAsyncRequest.CapacityInfo>();
LogisticsExpressCapacityTmsAsyncRequest.CapacityInfo obj7 = new LogisticsExpressCapacityTmsAsyncRequest.CapacityInfo();
list6.add(obj7);
obj7.setTimeRange("01:00-02:00");
obj7.setCapacity(1L);
obj1.setDailyCapacityInfos(list6);
List<LogisticsExpressCapacityTmsAsyncRequest.SpecifyCapacityInfo> list9 = new ArrayList<LogisticsExpressCapacityTmsAsyncRequest.SpecifyCapacityInfo>();
LogisticsExpressCapacityTmsAsyncRequest.SpecifyCapacityInfo obj10 = new LogisticsExpressCapacityTmsAsyncRequest.SpecifyCapacityInfo();
list9.add(obj10);
obj10.setSpecifyDate("2023-08-14");
List<LogisticsExpressCapacityTmsAsyncRequest.CapacityInfo> list13 = new ArrayList<LogisticsExpressCapacityTmsAsyncRequest.CapacityInfo>();
LogisticsExpressCapacityTmsAsyncRequest.CapacityInfo obj14 = new LogisticsExpressCapacityTmsAsyncRequest.CapacityInfo();
list13.add(obj14);
obj14.setTimeRange("01:00-02:00");
obj14.setCapacity(1L);
list11.setSpecifyDateCapacity(list13);
obj1.setSpecifyCapacityInfos(list9);
req.setCapacityRequest(obj1);
LogisticsExpressCapacityTmsAsyncResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
LogisticsExpressCapacityTmsAsyncRequest req = new LogisticsExpressCapacityTmsAsyncRequest();
LogisticsExpressCapacityTmsAsyncRequest.CapacityRequestDomain obj1 = new LogisticsExpressCapacityTmsAsyncRequest.CapacityRequestDomain();
obj1.RequestId = "1691997065571";
obj1.RequestTime = 1691997065571L;
obj1.SupplierId = "10241007442310358";
obj1.DeliveryCode = "STO";
obj1.ServiceType = "1";
obj1.AbilityType = "1";
obj1.ServiceScopeType = "2";
obj1.AddressType = "1";
obj1.AddressIds = "";
List<LogisticsExpressCapacityTmsAsyncRequest.AddressNameDomain> list3 = new List<LogisticsExpressCapacityTmsAsyncRequest.AddressNameDomain>();
LogisticsExpressCapacityTmsAsyncRequest.AddressNameDomain obj4 = new LogisticsExpressCapacityTmsAsyncRequest.AddressNameDomain();
list3.Add(obj4);
obj4.Province = "浙江省";
obj4.City = "杭州市";
obj4.Area = "余杭区";
obj4.Town = "五常街道";
obj1.AddressNames= list3;
obj1.RegionCode = "region-001";
obj1.UpdateMethod = 1L;
List<LogisticsExpressCapacityTmsAsyncRequest.CapacityInfoDomain> list6 = new List<LogisticsExpressCapacityTmsAsyncRequest.CapacityInfoDomain>();
LogisticsExpressCapacityTmsAsyncRequest.CapacityInfoDomain obj7 = new LogisticsExpressCapacityTmsAsyncRequest.CapacityInfoDomain();
list6.Add(obj7);
obj7.TimeRange = "01:00-02:00";
obj7.Capacity = 1L;
obj1.DailyCapacityInfos= list6;
List<LogisticsExpressCapacityTmsAsyncRequest.SpecifyCapacityInfoDomain> list9 = new List<LogisticsExpressCapacityTmsAsyncRequest.SpecifyCapacityInfoDomain>();
LogisticsExpressCapacityTmsAsyncRequest.SpecifyCapacityInfoDomain obj10 = new LogisticsExpressCapacityTmsAsyncRequest.SpecifyCapacityInfoDomain();
list9.Add(obj10);
obj10.SpecifyDate = "2023-08-14";
List<LogisticsExpressCapacityTmsAsyncRequest.CapacityInfoDomain> list12 = new List<LogisticsExpressCapacityTmsAsyncRequest.CapacityInfoDomain>();
LogisticsExpressCapacityTmsAsyncRequest.CapacityInfoDomain obj13 = new LogisticsExpressCapacityTmsAsyncRequest.CapacityInfoDomain();
list12.Add(obj13);
obj13.TimeRange = "01:00-02:00";
obj13.Capacity = 1L;
obj10.SpecifyDateCapacity= list12;
obj1.SpecifyCapacityInfos= list9;
req.CapacityRequest_ = obj1;
LogisticsExpressCapacityTmsAsyncResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

XML示例
JSON示例

<logistics_express_capacity_tms_async_response>
    <capacity_response>
        <success>true</success>
        <code>200</code>
        <message>SUCCESS</message>
        <is_retry>false</is_retry>
    </capacity_response>
</logistics_express_capacity_tms_async_response>

XML示例
JSON示例

<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

错误码	错误描述	解决方案

API测试工具错误码查询工具 SDK下载

开放平台

天猫供应链

taobao.logistics.express.capacity.tms.async (正逆向上门产能信息同步/更新 )

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ