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

taobao.logistics.express.order.pay.tms.query (上门取退运费支付状态查询接口)

上门取退运费支付状态查询接口

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
tms2_msc_pay_query_request Tms2MscPayQueryRequest 必须 查询入参
  • └ service_type
  • String
  • 必须
  • 1
  • 服务类型
  • └ supplier_id
  • String
  • 必须
  • 10001
  • 服务商ID
  • └ biz_code
  • String
  • 必须
  • 10001
  • 配资源编码
  • └ delivery_code
  • String
  • 必须
  • 10001
  • 唯一标识单号

响应参数

名称 类型 示例值 描述
data Tms2MscPayQueryResponse 业务处理结果
  • └ pay_flag
  • String
  • 0
  • 消费者支付状态
  • └ pay_time
  • String
  • YYYY-MM-DD HH:MM:SS
  • 消费者支付时间
  • └ post_fee
  • Number
  • 123
  • 总运费金额(单位:分)
  • └ post_deduct_fee
  • Number
  • 123
  • 运费险抵扣金额(单位:分)
biz_error_message String 系统错误 错误信息
biz_error_code String 10004 错误码
retry Boolean true 是否可重试
suc Boolean true 是 系统成功失败 true|false

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
LogisticsExpressOrderPayTmsQueryRequest req = new LogisticsExpressOrderPayTmsQueryRequest();
LogisticsExpressOrderPayTmsQueryRequest.Tms2MscPayQueryRequest obj1 = new LogisticsExpressOrderPayTmsQueryRequest.Tms2MscPayQueryRequest();
obj1.setServiceType("1");
obj1.setSupplierId("10001");
obj1.setBizCode("10001");
obj1.setDeliveryCode("10001");
req.setTms2MscPayQueryRequest(obj1);
LogisticsExpressOrderPayTmsQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<logistics_express_order_pay_tms_query_response>
    <data>
        <pay_flag>0</pay_flag>
        <pay_time>YYYY-MM-DD HH:MM:SS</pay_time>
        <post_fee>123</post_fee>
        <post_deduct_fee>123</post_deduct_fee>
    </data>
    <biz_error_message>系统错误</biz_error_message>
    <biz_error_code>10004</biz_error_code>
    <retry>true</retry>
    <suc>true</suc>
</logistics_express_order_pay_tms_query_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

返回
顶部