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

taobao.logistics.express.address.blacklist.tms.delete (aoi地址删除接)

○ 快递->淘天,异步接口 ○ 服务商通过调用此接口通知平台删除已经同步的aoi地址 ○ 接口类型:TOP ○ 调用方式:CP--->淘天

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
address_blacklist_delete_request AddressBlacklistDeleteRequest 必须 上门取退可揽范围黑名单删除
  • └ request_id
  • String
  • 必须
  • 1656674541000_001
  • 业务请求ID,用于做幂等
  • └ request_time
  • Number
  • 必须
  • 1656674541000
  • 时间戳(毫秒)
  • └ supplier_id
  • String
  • 必须
  • 10000000001
  • 服务商ID
  • └ delivery_code
  • String
  • 必须
  • STO-001
  • 配资源编码
  • └ 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(服务商配资源下必须全局唯一)
  • └ ability_status
  • String
  • 可选
  • 1
  • 能力状态 1-无能力 2-有能力

响应参数

名称 类型 示例值 描述
address_blacklist_delete_response AddressBlacklistDeleteResponse 返回值
  • └ 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);
LogisticsExpressAddressBlacklistTmsDeleteRequest req = new LogisticsExpressAddressBlacklistTmsDeleteRequest();
LogisticsExpressAddressBlacklistTmsDeleteRequest.AddressBlacklistDeleteRequest obj1 = new LogisticsExpressAddressBlacklistTmsDeleteRequest.AddressBlacklistDeleteRequest();
obj1.setRequestId("1656674541000_001");
obj1.setRequestTime(1656674541000L);
obj1.setSupplierId("10000000001");
obj1.setDeliveryCode("STO-001");
obj1.setServiceType("1");
obj1.setAbilityType("1");
obj1.setServiceScopeType("2");
obj1.setAddressType("1");
obj1.setAddressIds("");
List<LogisticsExpressAddressBlacklistTmsDeleteRequest.AddressNames> list3 = new ArrayList<LogisticsExpressAddressBlacklistTmsDeleteRequest.AddressNames>();
LogisticsExpressAddressBlacklistTmsDeleteRequest.AddressNames obj4 = new LogisticsExpressAddressBlacklistTmsDeleteRequest.AddressNames();
list3.add(obj4);
obj4.setProvince("浙江省");
obj4.setCity("杭州市");
obj4.setArea("余杭区");
obj4.setTown("五常街道");
obj1.setAddressNames(list3);
obj1.setRegionCode("region_code-001");
obj1.setAbilityStatus("1");
req.setAddressBlacklistDeleteRequest(obj1);
LogisticsExpressAddressBlacklistTmsDeleteResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<logistics_express_address_blacklist_tms_delete_response>
    <address_blacklist_delete_response>
        <success>true</success>
        <code>200</code>
        <message>SUCCESS</message>
        <is_retry>false</is_retry>
    </address_blacklist_delete_response>
</logistics_express_address_blacklist_tms_delete_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

返回
顶部