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

taobao.logistics.express.service.sync (服务信息回告接口)

服务信息回告接口

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
tms_service_sync_request TmsServiceSyncRequest 必须 参数信息
  • └ service_type
  • String
  • 必须
  • 1
  • 服务类型(1-送货上门;2-放指定驿站;6 消费者自选快递)
  • └ tms_brand_code
  • String
  • 可选
  • STO
  • 配品牌
  • └ logistics_detail_desc
  • String
  • 可选
  • 【站点】已经揽收该包裹
  • 物流轨迹描述信息
  • └ send_sign_type
  • String
  • 可选
  • 1
  • 送货上门签收类型 1-本人签收 2-他人代签收 3-前台 4-家门口 5-水表箱等指定位置
  • └ biz_code
  • String
  • 可选
  • 342342424
  • 服务单code
  • picture_info_list
  • TmsPictureInfoRequest []
  • 可选
  • 图片列表
  • 图片信息
  • └ pic_url
  • String
  • 可选
  • http://ssss.xxxx.com/xxx.jpg
  • 图片访问url
  • └ pic_upload_time
  • String
  • 可选
  • 2023-12-30 12:00:00
  • 图片上传时间
  • └ pic_type
  • String
  • 可选
  • 1
  • (1-运单底图2-环境图)
  • └ pic_std
  • String
  • 可选
  • A100001
  • 对应的图片拍摄标准
  • └ operate_time
  • String
  • 必须
  • 2023-12-30 12:00:00
  • 对应状态的操作时间
  • └ delivery_result
  • String
  • 可选
  • TO_HOME
  • 履约结果 TO_HOME, 送货上门 TO_CABINET, 入库入柜; TO_CUSTOMER_LOCATION, 放置指定地点(未上门)
  • └ mail_no
  • String
  • 必须
  • 234234234
  • 包裹运单号
  • └ service_state
  • String
  • 可选
  • 1
  • 状态(1-已揽收;2-派送中;3-已电联;4-已签收;5-已取消;6-异常;11-网点已寄出 51-拒收;61-拦截&转寄)
  • sms_info_list
  • TmsSmsInfoRequest []
  • 可选
  • 短信列表
  • 短信信息
  • └ sms_send_time
  • String
  • 可选
  • 2023-12-30 12:00:00
  • 短信发送时间。smsInfo有值时,必需
  • └ sms_send_status
  • Boolean
  • 可选
  • true
  • 短信状态。true,发送成功;false,发送失败
  • └ sms_text
  • String
  • 可选
  • 已到达,请签收
  • 短信信息,smsInfo有值时,且smsSendStatus = true时,必需
  • └ phone_call_result
  • String
  • 可选
  • TO_HOME
  • 电联结果 NOT_CONNECT, 未接通; TO_HOME, 送货上门; TO_CABINET, 需入库入柜
  • └ tms_cp_code
  • String
  • 必须
  • STO
  • 快递公司资源编码
  • └ business_type
  • String
  • 必须
  • 1
  • 业务类型(1-送货上门 )
  • phone_call_info_list
  • TmsPhoneCallInfoRequest []
  • 可选
  • 电联列表
  • 电联信息
  • └ phone_call_type
  • String
  • 可选
  • NORMAL
  • 电联属性,phoneCallInfo有值时,必需。SMART 智能云呼; NORMAL, 普通
  • └ hang_up_type
  • String
  • 可选
  • CUSTOMER_HAND_UP
  • 挂断状态,phoneCallInfo有值时,必需。CUSTOMER_HAND_UP,消费者挂断;SENDER_HANG_UP,小件员挂断
  • └ phone_chat_url
  • String
  • 可选
  • http://ssss.xxxx.com/xxx.mp3
  • 电联语音文件,用于客诉场景定责使用
  • └ phone_call_demand_change_time
  • String
  • 可选
  • 2023-12-30 12:00:00
  • 电联用户后,用户确认需要进行改派时,操作改派的时间
  • └ connect_time
  • String
  • 可选
  • 2023-12-30 12:00:00
  • 接通时间
  • └ phone_call_result_remark
  • String
  • 可选
  • 放门卫处,放楼下便利店
  • 消费者电联需求描述
  • └ connection_status
  • String
  • 可选
  • CONNECTED
  • 通话状态,phoneCallInfo有值时,必需。NOT _CONNECT, 未拨通;CONNECTED,已接通; NOBODY_ANSWER,无人接听
  • └ call_time
  • String
  • 可选
  • 2023-12-30 12:00:00
  • 拨打时间。phoneCallInfo有值时,必需
  • └ hang_up_time
  • String
  • 可选
  • 2023-12-30 12:00:00
  • 挂断时间
  • └ delivery_result_remark
  • String
  • 可选
  • 签收备注信息
  • 上门签收描述
  • └ supplier_id
  • String
  • 可选
  • 234343
  • 淘天物流服务商
  • └ delivery_code
  • String
  • 可选
  • SF001
  • 服务商配资源唯一编码
  • process
  • TmsProcessRequest
  • 可选
  • 状态回告
  • └ process_status
  • String
  • 可选
  • COLLECT
  • ACCEPT=下沉指令接单成功 ACCEPTFAILED=接单失败 COLLECT=揽收(商家仓出库揽收)SINKSUCCESS下沉成功 SINKFAILED下沉失败 REV_DELIVERY=接收商家放行指令 STA_DELIVERY=开始放行作业 REFUSE=买家拒签 DEEXCEPTION=派送异常 RETURN=拦截退回 OTHER=其他异常
  • └ site_id
  • String
  • 可选
  • 3434
  • 服务商网点ID
  • └ site_name
  • String
  • 可选
  • **网点
  • 服务商网点名称
  • └ site_address
  • String
  • 可选
  • 服务商网点地址
  • 服务商网点地址
  • └ failed_reason
  • String
  • 可选
  • AREA_NOT_ENOUGH_
  • AREA_NOT_ENOUGH_=可用面积不足 CAPACITY_NOT_ENOUGH=容量不足 SITE_ERROR=网点运营异常 OTHER=其他
  • └ operate_time
  • String
  • 可选
  • 2023-12-30 12:00:00
  • 当前状态操作时间(YYYY-MM-DD HH:MM:SS)
  • └ operate_info
  • String
  • 可选
  • 操作内容
  • 操作内容
  • └ feature
  • String
  • 可选
  • {"self_pick_reason":"1","staOrderCode":"31212","out_biz_product_code":"服务产品code","weight":"123"}
  • 拓展信息
  • └ new_mail_no
  • String
  • 可选
  • KD12312321
  • 新运单号,转寄/退回 换单 等节点发生换运单号操作,需上报新运单号
  • sender
  • ContacterRequest
  • 可选
  • 张三
  • 发件人信息
  • └ province
  • String
  • 可选
  • 北京,上海
  • └ province_id
  • String
  • 可选
  • 440000
  • 省id
  • └ city
  • String
  • 可选
  • 北京市
  • 城市
  • └ city_id
  • String
  • 可选
  • 443000
  • 城市id
  • └ district
  • String
  • 可选
  • 余杭区
  • └ district_id
  • String
  • 可选
  • 443550
  • 区id
  • └ street
  • String
  • 可选
  • 五常街道
  • 街道
  • └ street_id
  • String
  • 可选
  • 443222
  • 四级地址id
  • item_list
  • TmsServiceSyncItemInfoRequest []
  • 可选
  • 商品明细
  • 商品明细
  • └ order_line
  • String
  • 可选
  • XXXXX
  • 货品行id
  • └ item_name
  • String
  • 可选
  • XX衣服
  • 商品名称
  • └ sn
  • String
  • 可选
  • SN1,SN2,SN3
  • SN
  • └ imei
  • String
  • 可选
  • IMEI1,IMEI2
  • imei

响应参数

名称 类型 示例值 描述
suc Boolean true 校验成功或者异常
biz_error_message String 单据不存在 错误码描述
biz_error_code String 10000 错误码标识
retry Boolean true 是否可重试

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
LogisticsExpressServiceSyncRequest req = new LogisticsExpressServiceSyncRequest();
LogisticsExpressServiceSyncRequest.TmsServiceSyncRequest obj1 = new LogisticsExpressServiceSyncRequest.TmsServiceSyncRequest();
obj1.setServiceType("1");
obj1.setTmsBrandCode("STO");
obj1.setLogisticsDetailDesc("【站点】已经揽收该包裹");
obj1.setSendSignType("1");
obj1.setBizCode("342342424");
List<LogisticsExpressServiceSyncRequest.TmsPictureInfoRequest> list3 = new ArrayList<LogisticsExpressServiceSyncRequest.TmsPictureInfoRequest>();
LogisticsExpressServiceSyncRequest.TmsPictureInfoRequest obj4 = new LogisticsExpressServiceSyncRequest.TmsPictureInfoRequest();
list3.add(obj4);
obj4.setPicUrl("http://ssss.xxxx.com/xxx.jpg");
obj4.setPicUploadTime("2023-12-30 12:00:00");
obj4.setPicType("1");
obj4.setPicStd("A100001");
obj1.setPictureInfoList(list3);
obj1.setOperateTime("2023-12-30 12:00:00");
obj1.setDeliveryResult("TO_HOME");
obj1.setMailNo("234234234");
obj1.setServiceState("1");
List<LogisticsExpressServiceSyncRequest.TmsSmsInfoRequest> list6 = new ArrayList<LogisticsExpressServiceSyncRequest.TmsSmsInfoRequest>();
LogisticsExpressServiceSyncRequest.TmsSmsInfoRequest obj7 = new LogisticsExpressServiceSyncRequest.TmsSmsInfoRequest();
list6.add(obj7);
obj7.setSmsSendTime("2023-12-30 12:00:00");
obj7.setSmsSendStatus(true);
obj7.setSmsText("已到达,请签收");
obj1.setSmsInfoList(list6);
obj1.setPhoneCallResult("TO_HOME");
obj1.setTmsCpCode("STO");
obj1.setBusinessType("1");
List<LogisticsExpressServiceSyncRequest.TmsPhoneCallInfoRequest> list9 = new ArrayList<LogisticsExpressServiceSyncRequest.TmsPhoneCallInfoRequest>();
LogisticsExpressServiceSyncRequest.TmsPhoneCallInfoRequest obj10 = new LogisticsExpressServiceSyncRequest.TmsPhoneCallInfoRequest();
list9.add(obj10);
obj10.setPhoneCallType("NORMAL");
obj10.setHangUpType("CUSTOMER_HAND_UP");
obj10.setPhoneChatUrl("http://ssss.xxxx.com/xxx.mp3");
obj10.setPhoneCallDemandChangeTime("2023-12-30 12:00:00");
obj10.setConnectTime("2023-12-30 12:00:00");
obj10.setPhoneCallResultRemark("放门卫处,放楼下便利店");
obj10.setConnectionStatus("CONNECTED");
obj10.setCallTime("2023-12-30 12:00:00");
obj10.setHangUpTime("2023-12-30 12:00:00");
obj1.setPhoneCallInfoList(list9);
obj1.setDeliveryResultRemark("签收备注信息");
obj1.setSupplierId("234343");
obj1.setDeliveryCode("SF001");
LogisticsExpressServiceSyncRequest.TmsProcessRequest obj11 = new LogisticsExpressServiceSyncRequest.TmsProcessRequest();
obj11.setProcessStatus("COLLECT");
obj11.setSiteId("3434");
obj11.setSiteName("**网点");
obj11.setSiteAddress("服务商网点地址");
obj11.setFailedReason("AREA_NOT_ENOUGH_");
obj11.setOperateTime("2023-12-30 12:00:00");
obj11.setOperateInfo("操作内容");
obj1.setProcess(obj11);
obj1.setFeature("{\"self_pick_reason\":\"1\",\"staOrderCode\":\"31212\",\"out_biz_product_code\":\"服务产品code\",\"weight\":\"123\"}");
obj1.setNewMailNo("KD12312321");
LogisticsExpressServiceSyncRequest.ContacterRequest obj12 = new LogisticsExpressServiceSyncRequest.ContacterRequest();
obj12.setProvince("北京,上海");
obj12.setProvinceId("440000");
obj12.setCity("北京市");
obj12.setCityId("443000");
obj12.setDistrict("余杭区");
obj12.setDistrictId("443550");
obj12.setStreet("五常街道");
obj12.setStreetId("443222");
obj1.setSender(obj12);
List<LogisticsExpressServiceSyncRequest.TmsServiceSyncItemInfoRequest> list14 = new ArrayList<LogisticsExpressServiceSyncRequest.TmsServiceSyncItemInfoRequest>();
LogisticsExpressServiceSyncRequest.TmsServiceSyncItemInfoRequest obj15 = new LogisticsExpressServiceSyncRequest.TmsServiceSyncItemInfoRequest();
list14.add(obj15);
obj15.setOrderLine("XXXXX");
obj15.setItemName("XX衣服");
obj15.setSn("SN1,SN2,SN3");
obj15.setImei("IMEI1,IMEI2");
obj1.setItemList(list14);
req.setTmsServiceSyncRequest(obj1);
LogisticsExpressServiceSyncResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<logistics_express_service_sync_response>
    <suc>true</suc>
    <biz_error_message>单据不存在</biz_error_message>
    <biz_error_code>10000</biz_error_code>
    <retry>true</retry>
</logistics_express_service_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

返回
顶部