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

taobao.logistics.express.pickcode.check (快递公司取货码校验)

快递公司取货码校验

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
tms_pick_code_request TmsPickCodeRequest 必须 取件码校验参数
  • └ service_type
  • String
  • 必须
  • 1
  • 订单业务类型(1-退货业务 )
  • └ biz_code
  • String
  • 必须
  • 12324324
  • 单据标识
  • └ service_flag
  • String
  • 可选
  • 1,2
  • 订单所需服务,以英文逗号分隔,当前服务枚举值:(1-上门取退
  • └ pick_code
  • String
  • 可选
  • 2345
  • 取件码
  • └ supplier_id
  • String
  • 可选
  • 12341567891022
  • 服务商id
  • └ delivery_code
  • String
  • 可选
  • abc
  • 驿站编码
  • feature
  • TmsCheckPickCodeFeatureDTO
  • 可选
  • feature
  • └ pick_pic_url
  • String
  • 可选
  • http://img.com
  • 收件时的照片URL
  • └ item_num
  • Number
  • 可选
  • 2
  • 商品数量

响应参数

名称 类型 示例值 描述
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);
LogisticsExpressPickcodeCheckRequest req = new LogisticsExpressPickcodeCheckRequest();
LogisticsExpressPickcodeCheckRequest.TmsPickCodeRequest obj1 = new LogisticsExpressPickcodeCheckRequest.TmsPickCodeRequest();
obj1.setServiceType("1");
obj1.setBizCode("12324324");
obj1.setServiceFlag("1,2");
obj1.setPickCode("2345");
obj1.setSupplierId("12341567891022");
obj1.setDeliveryCode("abc");
LogisticsExpressPickcodeCheckRequest.TmsCheckPickCodeFeatureDTO obj2 = new LogisticsExpressPickcodeCheckRequest.TmsCheckPickCodeFeatureDTO();
obj2.setPickPicUrl("http://img.com");
obj2.setItemNum(2L);
obj1.setFeature(obj2);
req.setTmsPickCodeRequest(obj1);
LogisticsExpressPickcodeCheckResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

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

返回
顶部