淘宝开放平台

登录
文档中心 > API类目 > 隐私保护API

taobao.top.package.query (淘系包裹查询)

淘系包裹查询

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
query_package_list_request QueryPackageListRequest 可选 查询用户的包裹列表
  • └ query_role
  • String
  • 必须
  • USER/RECEIVER
  • 用户包裹的身份，淘宝账号/收件人
  • └ order_show_app
  • Number
  • 必须
  • 1
  • 1-淘宝端
  • └ station_type
  • String
  • 必须
  • FENGCHAO
  • 末端类型
  • └ open_id
  • String
  • 必须
  • xxxx
  • 用户的唯一标识
  • └ scene
  • String
  • 必须
  • CUSTOM/RECEIVE
  • 客服场景:CUSTOM，可查询已取件15天内和未取件包裹，收件场景：RECEIVE，仅可查询未取件包裹
  • └ page_no
  • Number
  • 必须
  • 1
  • 页数，从1开始
  • └ page_size
  • Number
  • 必须
  • 10
  • 页大小

响应参数

名称 类型 示例值 描述
data PackageInfo [] 包裹信息列表
  • └ mail_no
  • String
  • YTXXXXX
  • 运单号
  • └ privacy_order
  • Boolean
  • true
  • 是否为隐私订单
  • └ secret_no
  • String
  • 180310xxxx-1234
  • 订单隐私号
  • └ secret_no_expire_time
  • Date
  • 2022-08-22 00:00:00
  • 隐私号过期时间
  • └ receiver_mobile
  • String
  • 180310xxxx
  • 收件人手机号,如果用户未授权手机号则不返回
  • └ cp_code
  • String
  • SF/YTO等
  • 快递公司代码
  • └ station_type
  • String
  • FENG_CHAO
  • 代收点类型
total_num Number 100 面单总数量

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
1
2
3
4
5
6
7
8
9
10
11
12
13
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TopPackageQueryRequest req = new TopPackageQueryRequest();
TopPackageQueryRequest.QueryPackageListRequest obj1 = new TopPackageQueryRequest.QueryPackageListRequest();
obj1.setQueryRole("USER/RECEIVER");
obj1.setOrderShowApp(1L);
obj1.setStationType("FENGCHAO");
obj1.setOpenId("xxxx");
obj1.setScene("CUSTOM/RECEIVE");
obj1.setPageNo(1L);
obj1.setPageSize(10L);
req.setQueryPackageListRequest(obj1);
TopPackageQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
1
2
3
4
5
6
7
8
9
10
11
12
13
14
<top_package_query_response>
    <data>
        <package_info>
            <mail_no>YTXXXXX</mail_no>
            <privacy_order>true</privacy_order>
            <secret_no>180310xxxx-1234</secret_no>
            <secret_no_expire_time>2022-08-22 00:00:00</secret_no_expire_time>
            <receiver_mobile>180310xxxx</receiver_mobile>
            <cp_code>SF/YTO等</cp_code>
            <station_type>FENG_CHAO</station_type>
        </package_info>
    </data>
    <total_num>100</total_num>
</top_package_query_response>

异常示例

  • XML示例
  • JSON示例
1
2
3
4
5
6
<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

错误码解释

错误码 错误描述 解决方案
isv.non-user-auth 用户未授权 获取用户授权

API工具

API测试工具 错误码查询工具 SDK下载

如何获得此API

FAQ

我要提问
返回
顶部