文档中心 > API类目 > 淘天物流API

taobao.logistics.express.delivery.cut.notify (TMS配拦截结果回告)

TMS配拦截结果回告

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
notify_cut_off_delivery_process_status_request NotifyCutOffDeliveryProcessStatusRequest 必须 请求
  • └ mail_no
  • String
  • 必须
  • 12345
  • 快递单号
  • └ outer_order_id
  • String
  • 可选
  • 12345
  • 业务单号
  • └ intercept_status
  • String
  • 必须
  • OK
  • 拦截状态,0-接受拦截,1拦截成功,2拦截失败,3拦截取消
  • └ tms_cp_code
  • String
  • 可选
  • STO
  • 快递公司
  • └ intercept_status_message
  • String
  • 可选
  • test
  • 拦截失败、拦截取消原因
  • └ service_type
  • String
  • 可选
  • 41
  • 合作业务,41=淘天配拦截
  • └ intercept_node
  • String
  • 可选
  • 1
  • 包裹所在物流(路由)节点: 1-取消揽收(待揽收前取消) 2-首分拨拦截( 已揽收-首分拨出港前,含在首分拨) 3-末分拨拦截 ( 首分拨出港后-末分拨出港前,含在末分拨) 4-派送网点拦截 ( 末分拨出港后-派送前,含在派送网点) 5-取消派送( 派送中/待取件,含拒收),条件必填,当合作业务为41,拦截状态=1 或 0,必填
  • └ intercept_source
  • String
  • 可选
  • 1
  • 拦截发起方: 1- 当前指令下发方(默认) 2- 非当前指令下发方,条件必填,当合作业务为41,在实物拦截状态=1,必填
  • └ operate_time
  • String
  • 可选
  • 2023-12-16 10:05:00
  • 实际操作时间(YYYY-MM-DD HH24:MI:SS),对应所返回状态的实际操作时间
  • └ supplier_id
  • String
  • 可选
  • 123456
  • 淘天服务商id
  • └ delivery_code
  • String
  • 可选
  • STO
  • 服务商资源编码
  • └ intercept_status_code
  • String
  • 可选
  • PACKAGE_STATUS_INVALID
  • PACKAGE_STATUS_INVALID:包裹状态不满足要求(已签收) MAIL_NO_INVALID: 运单号不合法 PACKAGE_TYPE_NO_SUPPORT : 包裹类型不支持拦截(时效件等)

响应参数

名称 类型 示例值 描述
suc Boolean true 是否成功
biz_error_message String test 错误信息
biz_error_code Boolean E1001 错误编码
retry Boolean true 是否支持重试

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
LogisticsExpressDeliveryCutNotifyRequest req = new LogisticsExpressDeliveryCutNotifyRequest();
LogisticsExpressDeliveryCutNotifyRequest.NotifyCutOffDeliveryProcessStatusRequest obj1 = new LogisticsExpressDeliveryCutNotifyRequest.NotifyCutOffDeliveryProcessStatusRequest();
obj1.setMailNo("12345");
obj1.setOuterOrderId("12345");
obj1.setInterceptStatus("OK");
obj1.setTmsCpCode("STO");
obj1.setInterceptStatusMessage("test");
obj1.setServiceType("41");
obj1.setInterceptNode("1");
obj1.setInterceptSource("1");
obj1.setOperateTime("2023-12-16 10:05:00");
obj1.setSupplierId("123456");
obj1.setDeliveryCode("STO");
obj1.setInterceptStatusCode("PACKAGE_STATUS_INVALID");
req.setNotifyCutOffDeliveryProcessStatusRequest(obj1);
LogisticsExpressDeliveryCutNotifyResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<logistics_express_delivery_cut_notify_response>
    <suc>true</suc>
    <biz_error_message>test</biz_error_message>
    <biz_error_code>E1001</biz_error_code>
    <retry>true</retry>
</logistics_express_delivery_cut_notify_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

返回
顶部