注意:以下文档只适用于TOP接口,请谨慎使用!

文档中心 > API类目 > 千牛业务API

taobao.qianniu.delivery.agreement.query (运力协议和支付代扣协议查询)

运力协议和支付代扣协议查询

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
agreement_query_top_request AgreementQueryTopRequest 可选
  • 默认值:{}
  • 待查询的协议
    • └ channel
    • String
    • 必须
    • WAYBILL
    • 运力渠道 1: WAYBILL 2:GUOGUO
    • └ client
    • String
    • 必须
    • MOBILE
    • MOBILE or PC

    响应参数

    名称 类型 示例值 描述
    succ Boolean true 请求是否成功
    res_err_code String SYSTEM_ERROR 错误码
    res_err_msg String 系统异常 错误描述
    model DeliverySignResponseDTO 返回的数据
    • agreement
    • Agreement []
    • 协议内容
    • └ title
    • String
    • 《千牛运力协议》
    • 协议名称
    • └ type
    • Number
    • 1
    • 协议类型,运力协议==1 支付宝代扣协议==2
    • └ url
    • String
    • https://page.cainiao.com/waybill/activity-page-html/qn-agreement.html
    • 协议URL
    • └ sign_type
    • String
    • WAYBILL
    • 运力渠道
    • └ is_sign
    • Boolean
    • false
    • 是否签署了协议

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    QianniuDeliveryAgreementQueryRequest req = new QianniuDeliveryAgreementQueryRequest();
    QianniuDeliveryAgreementQueryRequest.AgreementQueryTopRequest obj1 = new QianniuDeliveryAgreementQueryRequest.AgreementQueryTopRequest();
    obj1.setChannel("WAYBILL");
    obj1.setClient("MOBILE");
    req.setAgreementQueryTopRequest(obj1);
    QianniuDeliveryAgreementQueryResponse rsp = client.execute(req, sessionKey);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <qianniu_delivery_agreement_query_response>
        <succ>true</succ>
        <res_err_code>SYSTEM_ERROR</res_err_code>
        <res_err_msg>系统异常</res_err_msg>
        <model>
            <agreement>
                <agreement>
                    <title>《千牛运力协议》</title>
                    <type>1</type>
                    <url>https://page.cainiao.com/waybill/activity-page-html/qn-agreement.html</url>
                </agreement>
            </agreement>
            <sign_type>WAYBILL</sign_type>
            <is_sign>false</is_sign>
        </model>
    </qianniu_delivery_agreement_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

    返回
    顶部