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

cainiao.endpoint.locker.top.post.query (自提柜投递列表)

包裹侠自提柜投件列表

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
user_id Number 必须 19822 用户ID
package_type Number 必须 1 1:待取件,2:滞留件,3:已取件
page_index Number 必须 1 页码
page_size Number 必须 20 每页条数
session_code String 必须 ajsdfsdfds sessionId

响应参数

名称 类型 示例值 描述
data Page result
  • └ total_num
  • Number
  • 1
  • totalNum
  • └ start
  • Number
  • 1
  • start
  • └ length
  • Number
  • 2
  • length
  • result_list
  • CollectionPostDto []
  • resultList
  • cabinet_list
  • CabinetPostDto []
  • cabinetPostDTOList
  • post_package_list
  • CabinetCollectionPostDto []
  • collectionPostDTOList
  • └ mail_no
  • String
  • 12345678
  • mailNo
  • └ guest_phone
  • String
  • 18758038407
  • guestPhone
  • └ post_time
  • String
  • 20171111 12:12
  • postTime
  • └ guest_address
  • String
  • 西湖区翠苑四区10-2-1234
  • guestAddress
  • └ take_time
  • String
  • 20171111 12:12
  • takeTime
  • └ exceeded_hours
  • Number
  • 72
  • exceededHours
  • └ take_role
  • Number
  • 1
  • 2:快递员,3:用户,4:管理员
  • └ package_id
  • Number
  • 1
  • packageId
  • └ total_collection_num
  • Number
  • 2
  • totalCollectionNum
  • └ fifth_address
  • String
  • 石榴派
  • fifthAddress
  • └ cabinet_detail_address
  • String
  • 石榴派五栋一单元东侧菜鸟驿站智能柜
  • cabinetDetailAddress
  • └ cabinet_company_name
  • String
  • 菜鸟
  • cabinetCompanyName
  • └ cabinet_id
  • Number
  • 1
  • cabinetId
  • └ collection_post_status_enum
  • String
  • PENDING
  • collectionPostStatusEnum
  • └ total_collection_num
  • Number
  • 5
  • totalCollectionNum
  • └ success
  • Boolean
  • true
  • success
status_message String error errorDesc
status_code String errcode errorCode
is_success Boolean false success

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoEndpointLockerTopPostQueryRequest req = new CainiaoEndpointLockerTopPostQueryRequest();
req.setUserId(19822L);
req.setPackageType(1L);
req.setPageIndex(1L);
req.setPageSize(20L);
req.setSessionCode("ajsdfsdfds");
CainiaoEndpointLockerTopPostQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<cainiao_endpoint_locker_top_post_query_response>
    <data>
        <total_num>1</total_num>
        <start>1</start>
        <length>2</length>
        <result_list>
            <collection_post_dto>
                <cabinet_list>
                    <cabinet_post_dto>
                        <post_package_list>
                            <cabinet_collection_post_dto>
                                <mail_no>12345678</mail_no>
                                <guest_phone>18758038407</guest_phone>
                                <post_time>20171111 12:12</post_time>
                                <guest_address>西湖区翠苑四区10-2-1234</guest_address>
                                <take_time>20171111 12:12</take_time>
                                <exceeded_hours>72</exceeded_hours>
                                <take_role>1</take_role>
                                <package_id>1</package_id>
                            </cabinet_collection_post_dto>
                        </post_package_list>
                        <total_collection_num>2</total_collection_num>
                        <fifth_address>石榴派</fifth_address>
                        <cabinet_detail_address>石榴派五栋一单元东侧菜鸟驿站智能柜</cabinet_detail_address>
                        <cabinet_company_name>菜鸟</cabinet_company_name>
                        <cabinet_id>1</cabinet_id>
                    </cabinet_post_dto>
                </cabinet_list>
                <collection_post_status_enum>PENDING</collection_post_status_enum>
                <total_collection_num>5</total_collection_num>
            </collection_post_dto>
        </result_list>
        <success>true</success>
    </data>
    <status_message>error</status_message>
    <status_code>errcode</status_code>
    <is_success>false</is_success>
</cainiao_endpoint_locker_top_post_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

返回
顶部