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

taobao.logistics.express.collect.resource.tms.async (配服务商揽收能力同步接口)

配服务商揽收能力同步接口

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
collect_resource_request CollectResourceRequest 必须 上门取退可揽范围
  • └ request_id
  • String
  • 必须
  • 1656674541000_001
  • 业务请求ID,用于做幂等
  • └ request_time
  • Number
  • 必须
  • 1656674541000
  • 时间戳(毫秒)
  • └ supplier_id
  • String
  • 必须
  • 10000000001
  • 服务商ID
  • └ delivery_code
  • String
  • 必须
  • STO-001
  • 配资源编码
  • └ site_code
  • String
  • 必须
  • site-001
  • 网点编码(仅一个)
  • └ site_name
  • String
  • 必须
  • 网点名
  • 网点名称(仅一个)
  • └ 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
  • AddressNames []
  • 可选
  • 中文地址信息
  • └ province
  • String
  • 可选
  • 浙江省
  • └ city
  • String
  • 可选
  • 杭州市
  • └ area
  • String
  • 可选
  • 余杭区
  • └ town
  • String
  • 可选
  • 五常街道
  • 街道
  • └ region_code
  • String
  • 可选
  • region_code-001
  • 电子围栏外部ID(服务商配资源下必须全局唯一)
  • └ region_address_id
  • String
  • 可选
  • 330110005,330110004
  • 电子围栏内包含的三级地址id(菜鸟地址库ID),电子围栏内包含多个三级地址时,需传多个,以英文逗号分隔
  • region_ids
  • RegionIds []
  • 可选
  • 电子围栏(经纬度),电子围栏最多5000个点(数组)
  • └ longitude
  • String
  • 可选
  • 120.21201
  • 经度(高德)
  • └ latitude
  • String
  • 可选
  • 120.21201
  • 纬度(高德)
  • └ begin_time
  • String
  • 必须
  • 10:00:00
  • 日常上班时间(HH:MM:SS)
  • └ end_time
  • String
  • 必须
  • 18:00:00
  • 日常下班时间(HH:MM:SS)
  • └ immediate_collect_ability
  • Number
  • 可选
  • 2
  • 日常即时单上门能力,枚举: 1 - 1小时内上门 2 - 2小时内上门 3 - 3小时内上门 4 - 4小时内上门 5 - 不支持即时单 未填写时,默认可2小时内上门
  • └ reservation_ability
  • Number
  • 必须
  • 1
  • 日常预约单上门能力,枚举: 1 - 1小时预约单可上门 2 - 2小时预约单可上门 3 - 半天预约单(上下午)可上门 4 - 当天预约单可上门
  • specify_date_work_ability
  • SpecifyDateWorkAbility []
  • 可选
  • 指定日期服务能力
  • └ specify_date
  • String
  • 可选
  • 2023-07-18
  • 指定日期,YYYY-MM-DD
  • └ begin_time
  • String
  • 可选
  • 10:00:00
  • 上班时间(HH:MM:SS)
  • └ end_time
  • String
  • 可选
  • 18:00:00
  • 下班时间(HH:MM:SS)
  • └ immediate_collect_ability
  • Number
  • 可选
  • 1
  • 即时单上门能力,举例 1 - 1小时内上门 2 - 2小时内上门 3 - 3小时内上门 4 - 4小时内上门 5 - 不支持即时单 未填写时,默认可2小时内上门
  • └ reservation_ability
  • Number
  • 可选
  • 1
  • 预约单上门能力,枚举: 1 - 1小时预约单可上门 2 - 2小时预约单可上门 3 - 半天预约单(上下午)可上门 4 - 当天预约单可上门

响应参数

名称 类型 示例值 描述
collect_resource_response CollectResourceResponse 返回值
  • └ 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);
LogisticsExpressCollectResourceTmsAsyncRequest req = new LogisticsExpressCollectResourceTmsAsyncRequest();
LogisticsExpressCollectResourceTmsAsyncRequest.CollectResourceRequest obj1 = new LogisticsExpressCollectResourceTmsAsyncRequest.CollectResourceRequest();
obj1.setRequestId("1656674541000_001");
obj1.setRequestTime(1656674541000L);
obj1.setSupplierId("10000000001");
obj1.setDeliveryCode("STO-001");
obj1.setSiteCode("site-001");
obj1.setSiteName("网点名");
obj1.setServiceType("1");
obj1.setAbilityType("1");
obj1.setServiceScopeType("2");
obj1.setAddressType("1");
obj1.setAddressIds("");
List<LogisticsExpressCollectResourceTmsAsyncRequest.AddressNames> list3 = new ArrayList<LogisticsExpressCollectResourceTmsAsyncRequest.AddressNames>();
LogisticsExpressCollectResourceTmsAsyncRequest.AddressNames obj4 = new LogisticsExpressCollectResourceTmsAsyncRequest.AddressNames();
list3.add(obj4);
obj4.setProvince("浙江省");
obj4.setCity("杭州市");
obj4.setArea("余杭区");
obj4.setTown("五常街道");
obj1.setAddressNames(list3);
obj1.setRegionCode("region_code-001");
obj1.setRegionAddressId("330110005,330110004");
List<LogisticsExpressCollectResourceTmsAsyncRequest.RegionIds> list6 = new ArrayList<LogisticsExpressCollectResourceTmsAsyncRequest.RegionIds>();
LogisticsExpressCollectResourceTmsAsyncRequest.RegionIds obj7 = new LogisticsExpressCollectResourceTmsAsyncRequest.RegionIds();
list6.add(obj7);
obj7.setLongitude("120.21201");
obj7.setLatitude("120.21201");
obj1.setRegionIds(list6);
obj1.setBeginTime("10:00:00");
obj1.setEndTime("18:00:00");
obj1.setImmediateCollectAbility(2L);
obj1.setReservationAbility(1L);
List<LogisticsExpressCollectResourceTmsAsyncRequest.SpecifyDateWorkAbility> list9 = new ArrayList<LogisticsExpressCollectResourceTmsAsyncRequest.SpecifyDateWorkAbility>();
LogisticsExpressCollectResourceTmsAsyncRequest.SpecifyDateWorkAbility obj10 = new LogisticsExpressCollectResourceTmsAsyncRequest.SpecifyDateWorkAbility();
list9.add(obj10);
obj10.setSpecifyDate("2023-07-18");
obj10.setBeginTime("10:00:00");
obj10.setEndTime("18:00:00");
obj10.setImmediateCollectAbility(1L);
obj10.setReservationAbility(1L);
obj1.setSpecifyDateWorkAbility(list9);
req.setCollectResourceRequest(obj1);
LogisticsExpressCollectResourceTmsAsyncResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<logistics_express_collect_resource_tms_async_response>
    <collect_resource_response>
        <success>true</success>
        <code>200</code>
        <message>SUCCESS</message>
        <is_retry>false</is_retry>
    </collect_resource_response>
</logistics_express_collect_resource_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

返回
顶部