文档中心 > API类目 > 手淘开放API

taobao.logistics.applet.package.query (淘宝包裹查询)

淘宝包裹查询

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
query_package_list_request QueryPackageListRequest 必须 查询用户的包裹列表
  • └ cp_code
  • String
  • 必须
  • ZTO/SF/YTO等
  • 快递公司编码
  • └ open_id
  • String
  • 必须
  • xxxx
  • 用户的唯一标识
  • └ page_no
  • Number
  • 必须
  • 1
  • 页数,从1开始
  • └ page_size
  • Number
  • 必须
  • 10
  • 页大小

响应参数

名称 类型 示例值 描述
query_response QueryPackageListResponse 结果对象
  • └ total_num
  • Number
  • 100
  • 包裹总数量
  • └ success
  • Boolean
  • true
  • 查询是否成功
  • └ error_code
  • String
  • exceedLimit
  • 查询错误码(成功情况无需关注)
  • └ error_msg
  • String
  • exceedLimit
  • 查询错误原因(成功情况无需关注)
  • package_infos
  • PackageInfoVO []
  • 180310xxxx
  • 包裹信息
  • └ package_id
  • Number
  • xxxxxx
  • 包裹id
  • └ cp_code
  • String
  • ZTO/SF/YTO等
  • 快递公司编码
  • └ mail_no
  • String
  • ZTOxxxxxxx
  • 快递面单编码
result_success Boolean true 通讯成功/失败
result_code Boolean isv.sys.error 通讯失败码
result_msg String 服务端异常 通讯失败信息

请求示例

  • JAVA
  • .NET
  • PHP
  • CURL
  • Python
  • C/C++
  • NodeJS
TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
LogisticsAppletPackageQueryRequest req = new LogisticsAppletPackageQueryRequest();
LogisticsAppletPackageQueryRequest.QueryPackageListRequest obj1 = new LogisticsAppletPackageQueryRequest.QueryPackageListRequest();
obj1.setCpCode("ZTO/SF/YTO等");
obj1.setOpenId("xxxx");
obj1.setPageNo(1L);
obj1.setPageSize(10L);
req.setQueryPackageListRequest(obj1);
LogisticsAppletPackageQueryResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

  • XML示例
  • JSON示例
<logistics_applet_package_query_response>
    <query_response>
        <total_num>100</total_num>
        <success>true</success>
        <error_code>exceedLimit</error_code>
        <error_msg>exceedLimit</error_msg>
        <package_infos>
            <package_info_v_o>
                <package_id>xxxxxx</package_id>
                <cp_code>ZTO/SF/YTO等</cp_code>
                <mail_no>ZTOxxxxxxx</mail_no>
            </package_info_v_o>
        </package_infos>
    </query_response>
    <result_success>true</result_success>
    <result_code>isv.sys.error</result_code>
    <result_msg>服务端异常</result_msg>
</logistics_applet_package_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

返回
顶部