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

cainiao.endpoint.locker.top.withhold.query (查询能否代扣)

查询是否有代扣欠款,是否签署代扣协议。

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
company_code String 必须 sudiyi 柜子公司编码
order_type Number 必须 0 柜子业务:0-取件业务,1-寄件业务,2-派样业务,3-小件员约柜(在约期内仅能使用一次)4-小件员租柜(在约期内可反复使用)
open_user_id String 必须 112321312 开放用户Id

响应参数

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

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoEndpointLockerTopWithholdQueryRequest req = new CainiaoEndpointLockerTopWithholdQueryRequest();
req.setCompanyCode("sudiyi");
req.setOrderType(0L);
req.setOpenUserId("112321312");
CainiaoEndpointLockerTopWithholdQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

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

返回
顶部