文档中心 > API类目 > 天猫供应链

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

正逆向上门产能信息同步/更新

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
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());

响应示例

  • 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工具

如何获得此API

FAQ

返回
顶部