文档中心 > API类目 > 菜鸟裹裹API

cainiao.endpoint.locker.top.order.withhold (代扣支付)

提供代扣,允许有一笔欠款。

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
company_code String 必须 suduyi 柜子公司编码
gui_id String 必须 123231232 柜子id
order_code String 必须 123 柜子订单编码
order_type Number 必须 0 订单类型(0-取件业务,1-寄件业务,2-派样业务)
mail_no String 必须 adfj1 运单号
open_user_id String 必须 545454 开放用户id
total_fee Number 必须 123 代扣金额(全额),单位:分
extra String 可选 {"gui_type":"L","mail_no":"312312f"} 扩展字段

响应参数

名称 类型 示例值 描述
result SingleResult result result
  • └ error_desc
  • String
  • 成功
  • errorDesc
  • └ error_code
  • String
  • 200
  • errorCode
  • └ success
  • Boolean
  • true
  • success

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoEndpointLockerTopOrderWithholdRequest req = new CainiaoEndpointLockerTopOrderWithholdRequest();
req.setCompanyCode("suduyi");
req.setGuiId("123231232");
req.setOrderCode("123");
req.setOrderType(0L);
req.setMailNo("adfj1");
req.setOpenUserId("545454");
req.setTotalFee(123L);
req.setExtra("{\"gui_type\":\"L\",\"mail_no\":\"312312f\"}");
CainiaoEndpointLockerTopOrderWithholdResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<cainiao_endpoint_locker_top_order_withhold_response>
    <result>
        <error_desc>成功</error_desc>
        <error_code>200</error_code>
        <success>true</success>
    </result>
</cainiao_endpoint_locker_top_order_withhold_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

返回
顶部