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

cainiao.guoguo.graborder.takepackagebycourier (小件员上门取件)

小件员上门取件

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
order_total_price String 可选 1 订单应付价格(分)
order_insurance_value String 可选 1 声明价(分)
adjust_fee String 可选 1 调价(分)
package_fee String 可选 1 包装费(分)
append_fee String 可选 1 附加费(分)
order_insurance_price String 可选 1 保价费(分)
cp_delivery_fee String 可选 1 运费(分)
goods_weight String 可选 1 商品重量(kg)
order_id Number 必须 12 订单id
session_code String 必须 132 会话session
got_code String 必须 1113 取件码
task_id Number 可选 11 任务id
courier_id Number 必须 12 小件员id
provider_id String 可选 cp cpCode
pass_weight_check Number 可选 0
  • 默认值:0
  • 是否跳过核价重量校验
    mail_no String 可选 500123123423 运单号
    personal_user_id Number 可选 11111 个人账号

    响应参数

    名称 类型 示例值 描述
    data CourierTakePackageResponse demo 结果集
    • └ goods_continued_heavy
    • String
    • 1
    • 续重总重量(kg)
    • └ start_price
    • String
    • 1
    • 首重费用(元)
    • └ start_weight
    • String
    • 1
    • 首重重量(kg)
    • └ continued_heavy_price
    • String
    • 1
    • 续重费用(元)
    • └ sender_address
    • String
    • 杭州市
    • 寄件人地址
    • └ receiver_address
    • String
    • 嘉兴市
    • 收件人地址
    • └ adjust_fee
    • String
    • 1
    • 调价(元)
    • └ order_insured_value
    • String
    • 1
    • 声明价(元)
    • └ order_total_price
    • String
    • 1
    • 订单应付价额(元)
    • └ insurance_fee
    • String
    • 1
    • 保价费(元)
    • └ take_package_spend_time
    • Number
    • 10
    • takePackageSpendTime
    • └ status_code
    • Number
    • 35
    • orderStatus
    • └ goods_continued_price
    • String
    • 1
    • continuedTotalPrice
    • └ prompt_info
    • String
    • 123123
    • promptInfo
    • └ order_id
    • Number
    • 123123
    • 订单号
    • └ complete_operation
    • Boolean
    • true
    • 操作集是否结束
    • └ new_task
    • Boolean
    • true
    • 是否新履行订单
    • └ task_order_id
    • Number
    • 2232323
    • 新履行订单
    • └ new_task_detail
    • Boolean
    • true
    • 是否跳转到新详情页
    • └ check_pkg_code
    • String
    • 1234
    • 对货码
    • └ support_check_bill
    • Boolean
    • true
    • 是否支撑核价
    status_code String ERROR statusCode
    status_message String ERROR_MSG statusMessage
    is_success Boolean true 是否正确

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    CainiaoGuoguoGraborderTakepackagebycourierRequest req = new CainiaoGuoguoGraborderTakepackagebycourierRequest();
    req.setOrderTotalPrice("1");
    req.setOrderInsuranceValue("1");
    req.setAdjustFee("1");
    req.setPackageFee("1");
    req.setAppendFee("1");
    req.setOrderInsurancePrice("1");
    req.setCpDeliveryFee("1");
    req.setGoodsWeight("1");
    req.setOrderId(12L);
    req.setSessionCode("132");
    req.setGotCode("1113");
    req.setTaskId(11L);
    req.setCourierId(12L);
    req.setProviderId("cp");
    req.setPassWeightCheck(0L);
    req.setMailNo("500123123423");
    req.setPersonalUserId(11111L);
    CainiaoGuoguoGraborderTakepackagebycourierResponse rsp = client.execute(req);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <cainiao_guoguo_graborder_takepackagebycourier_response>
        <data>
            <goods_continued_heavy>1</goods_continued_heavy>
            <start_price>1</start_price>
            <start_weight>1</start_weight>
            <continued_heavy_price>1</continued_heavy_price>
            <sender_address>杭州市</sender_address>
            <receiver_address>嘉兴市</receiver_address>
            <adjust_fee>1</adjust_fee>
            <order_insured_value>1</order_insured_value>
            <order_total_price>1</order_total_price>
            <insurance_fee>1</insurance_fee>
            <take_package_spend_time>10</take_package_spend_time>
            <status_code>35</status_code>
            <goods_continued_price>1</goods_continued_price>
            <prompt_info>123123</prompt_info>
            <order_id>123123</order_id>
            <complete_operation>true</complete_operation>
            <new_task>true</new_task>
            <task_order_id>2232323</task_order_id>
            <new_task_detail>true</new_task_detail>
            <check_pkg_code>1234</check_pkg_code>
            <support_check_bill>true</support_check_bill>
        </data>
        <status_code>ERROR</status_code>
        <status_message>ERROR_MSG</status_message>
        <is_success>true</is_success>
    </cainiao_guoguo_graborder_takepackagebycourier_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

    返回
    顶部