文档中心 > API类目 > 电子面单API

cainiao.waybill.ii.query.by.tradecode (通过订单号查询电子面单通接口)

通过订单号查看面单的信息

公共参数

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
target_app_key	String	否	被调用的目标AppKey，仅当被调用的API为第三方ISV提供时有效。
sign_method	String	是	签名的摘要算法，可选值为：hmac，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。
session	String	否	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选。
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。
format	String	否	响应格式。默认为xml格式，可选值：xml，json。
v	String	是	API协议版本，可选值：2.0。
partner_id	String	否	合作伙伴身份标识。
simplify	Boolean	否	是否采用精简JSON返回格式，仅当format=json时有效，默认值为：false。

请求参数

名称	类型	是否必须	示例值	更多限制	描述
param_list	WaybillDetailQueryByBizSubCodeRequest []	可选		最大列表长度：10	订单号列表
└ biz_sub_code String 可选 1111,2222 订单号 └ object_id String 可选 1 请求id

响应参数

名称	类型	示例值	描述
modules	WaybillCloudPrintWithResultDescResponse []	x	查询返回值
└ error_code String xx 单查询错误code └ error_message String x 单查询错误message └ object_id String x 请求id └ success Boolean x 是否查询 waybill_cloud_print_response WaybillCloudPrintResponse x 面单信息 └ print_data String x 面单信息 └ waybill_code String x 面单号

请求示例

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoWaybillIiQueryByTradecodeRequest req = new CainiaoWaybillIiQueryByTradecodeRequest();
List<CainiaoWaybillIiQueryByTradecodeRequest.WaybillDetailQueryByBizSubCodeRequest> list2 = new ArrayList<CainiaoWaybillIiQueryByTradecodeRequest.WaybillDetailQueryByBizSubCodeRequest>();
CainiaoWaybillIiQueryByTradecodeRequest.WaybillDetailQueryByBizSubCodeRequest obj3 = new CainiaoWaybillIiQueryByTradecodeRequest.WaybillDetailQueryByBizSubCodeRequest();
list2.add(obj3);
obj3.setBizSubCode("1111,2222");
obj3.setObjectId("1");
req.setParamList(list2);
CainiaoWaybillIiQueryByTradecodeResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

响应示例

XML示例
JSON示例

<cainiao_waybill_ii_query_by_tradecode_response>
    <modules>
        <waybill_cloud_print_with_result_desc_response>
            <error_code>xx</error_code>
            <error_message>x</error_message>
            <object_id>x</object_id>
            <success>x</success>
            <waybill_cloud_print_response>
                <print_data>x</print_data>
                <waybill_code>x</waybill_code>
            </waybill_cloud_print_response>
        </waybill_cloud_print_with_result_desc_response>
    </modules>
</cainiao_waybill_ii_query_by_tradecode_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测试工具错误码查询工具 SDK下载

如何获得此API

FAQ

我要提问

返回
顶部

开放平台

电子面单API

cainiao.waybill.ii.query.by.tradecode (通过订单号查询电子面单通接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ