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

taobao.logistics.express.operate.sync (物流操作节点回传)

物流操作节点回传

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
tms_operate_sync_request TmsOperateSyncRequest 必须 请求
  • └ supplier_id
  • String
  • 必须
  • 100000167
  • 淘天服务商id
  • └ delivery_code
  • String
  • 必须
  • SF_01
  • 服务商资源编码
  • └ out_biz_code
  • String
  • 必须
  • 34234
  • 业务单号-幂等键
  • └ mail_no
  • String
  • 必须
  • SF213131
  • 运单号
  • └ biz_code
  • String
  • 可选
  • 33423dz
  • 单据编码,可传LP单号
  • └ operate_time
  • String
  • 必须
  • 2023-09-28 12:00:00
  • 操作时间
  • └ operate_action
  • String
  • 必须
  • COLLECT
  • 操作节点
  • └ new_mail_no
  • String
  • 可选
  • SF3534545
  • 新运单号
  • └ refuse_type
  • String
  • 可选
  • 退回类型
  • 退回类型(拒签退回、配拦截退货)
  • └ service_type
  • String
  • 可选
  • 1
  • 服务类型,以英文逗号分隔,当前服务枚举值:(1-上门取退 )
  • └ tms_cp_code
  • String
  • 可选
  • SF
  • 配送公司的快递公司编码
  • operate_address
  • AddressDTO
  • 可选
  • 地址信息,条件必填。当拦截类型为退回指定地址时必传。
  • └ province
  • String
  • 可选
  • 浙江省
  • 省份名称
  • └ city
  • String
  • 可选
  • 杭州市
  • 城市名称
  • └ district
  • String
  • 可选
  • 余杭区
  • 区县名称
  • └ street
  • String
  • 可选
  • 仓前街道
  • 镇街道名称
  • └ address
  • String
  • 可选
  • 西溪园区112号
  • 详细地址
  • └ division_id
  • String
  • 可选
  • 330110
  • 最小粒度区域ID
  • └ site_code
  • String
  • 可选
  • 1101
  • 站点编码(揽收网点、分拨中心、派件网点等编码),淘天资源中心定义
  • └ site_type
  • String
  • 可选
  • 2
  • 站点类型:2-分拨中心编码(通用),3-派件网点编码,4-地址id,5-集运直邮分拨(集运定制)

响应参数

名称 类型 示例值 描述
result ResultWrapper 响应结果
  • └ success
  • Boolean
  • true
  • 响应结果
  • └ error_code
  • String
  • 10001
  • 错误码
  • └ error_desc
  • String
  • 系统错误
  • 错误描述
  • └ retry
  • Boolean
  • false
  • 是否可重试

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
LogisticsExpressOperateSyncRequest req = new LogisticsExpressOperateSyncRequest();
LogisticsExpressOperateSyncRequest.TmsOperateSyncRequest obj1 = new LogisticsExpressOperateSyncRequest.TmsOperateSyncRequest();
obj1.setSupplierId("100000167");
obj1.setDeliveryCode("SF_01");
obj1.setOutBizCode("34234");
obj1.setMailNo("SF213131");
obj1.setBizCode("33423dz");
obj1.setOperateTime("2023-09-28 12:00:00");
obj1.setOperateAction("COLLECT");
obj1.setNewMailNo("SF3534545");
obj1.setRefuseType("退回类型");
obj1.setServiceType("1");
obj1.setTmsCpCode("SF");
LogisticsExpressOperateSyncRequest.AddressDTO obj2 = new LogisticsExpressOperateSyncRequest.AddressDTO();
obj2.setProvince("浙江省");
obj2.setCity("杭州市");
obj2.setDistrict("余杭区");
obj2.setStreet("仓前街道");
obj2.setAddress("西溪园区112号");
obj2.setDivisionId("330110");
obj1.setOperateAddress(obj2);
obj1.setSiteCode("1101");
obj1.setSiteType("2");
req.setTmsOperateSyncRequest(obj1);
LogisticsExpressOperateSyncResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<logistics_express_operate_sync_response>
    <result>
        <success>true</success>
        <error_code>10001</error_code>
        <error_desc>系统错误</error_desc>
        <retry>false</retry>
    </result>
</logistics_express_operate_sync_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

返回
顶部