文档中心 > API类目 > 菜鸟集货API

cainiao.global.im.pickup.bigbag.info (大包状态查询)

大包状态查询

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
bigbag_status_request BigbagStatusRequest 必须 请求参数
  • └ bigbag_id
  • Number
  • 必须
  • 123
  • 大包id
  • └ seller_id
  • Number
  • 必须
  • 2345
  • 商家id

响应参数

名称 类型 示例值 描述
hsf_result HsfResult xxxxx hsfResult
  • └ success
  • Boolean
  • true
  • 是否响应正常
  • └ error_code
  • String
  • xxxxx
  • 异常code
  • └ internal_error_code
  • String
  • xxxxx
  • 网络异常code
  • └ error_msg
  • String
  • xxxxx
  • 异常消息
  • data
  • BigbagStatusResponse
  • xxxxx
  • 响应体
  • └ bigbag_id
  • Number
  • 3
  • handoverContentId
  • └ bigbag_code
  • String
  • xxxxx
  • handoverContentCode
  • └ status
  • String
  • arrived
  • 交接物状态,draft:草稿、committed:已提交、awaiting_tracking_number:等待分配运单号、awaiting_pickup:等待揽收、pickup:已揽收、pickup_failed:揽收失败、arrived:已到达、signed_normal:签收正常、signed_abnormal:签收异常、signed_failed:签收失败、canceled:已取消、cancel_failure:取消失败、canceling:取消中、express_signed_normal:快递签收正常、express_signed_abnormal:快递签收异常
  • └ gmt_modified
  • String
  • 2021-11-22 15:14:59
  • 更新时间(北京时间)
  • parcel_order_list
  • ParcelOrderStatusResponse []
  • xxxxx
  • parcelOrderList
  • └ logistics_order_code
  • String
  • LP8887777666
  • 小包LP
  • └ status
  • String
  • inbound_normal
  • 状态,init:初始化、inbound_normal:入库正常、inbound_abnormal:入库异常

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoGlobalImPickupBigbagInfoRequest req = new CainiaoGlobalImPickupBigbagInfoRequest();
CainiaoGlobalImPickupBigbagInfoRequest.BigbagStatusRequest obj1 = new CainiaoGlobalImPickupBigbagInfoRequest.BigbagStatusRequest();
obj1.setBigbagId(123L);
obj1.setSellerId(2345L);
req.setBigbagStatusRequest(obj1);
CainiaoGlobalImPickupBigbagInfoResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<cainiao_global_im_pickup_bigbag_info_response>
    <hsf_result>
        <success>true</success>
        <error_code>xxxxx</error_code>
        <internal_error_code>xxxxx</internal_error_code>
        <error_msg>xxxxx</error_msg>
        <data>
            <bigbag_id>3</bigbag_id>
            <bigbag_code>xxxxx</bigbag_code>
            <status>arrived</status>
            <gmt_modified>2021-11-22 15:14:59</gmt_modified>
            <parcel_order_list>
                <parcel_order_status_response>
                    <logistics_order_code>LP8887777666</logistics_order_code>
                    <status>inbound_normal</status>
                </parcel_order_status_response>
            </parcel_order_list>
        </data>
    </hsf_result>
</cainiao_global_im_pickup_bigbag_info_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

返回
顶部