淘宝开放平台

请求地址：

环境	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。

名称	类型	是否必须	描述
order_criteria	OrderCriteria	可选	订单查询
└ out_counter_id String 可选 23423 外部专柜Id └ status String [] 可选 PAID 订单状态：UNPAID(未支付),PAID(已支付),PARTDISTRIBUTION(部分发货),ALLDISTRIBUTION(全部发货),CANCEL(取消) └ order_numbers String [] 可选 2018112122650159 订单集合 └ end_date Date 可选 2018-10-13 19:21:00 创建时间范围，开始时间 └ start_date Date 可选 2018-10-12 10:21:00 创建时间范围，结束时间 └ counter_id String 可选 23122 专柜Id └ modify_end_date Date 可选 2018-10-13 18:21:00 订单修改时间范围，开始时间 └ modify_start_date Date 可选 2018-10-12 10:21:00 订单修改时间范围，结束时间
paginator	Paginator	可选	分页信息
└ page_size Number 必须 20 取多少条,每次最多取20条 └ page Number 必须 1 当前页，最多支持返回250页

名称	类型	示例值	描述
result	ResultDo		返回结果
data PagedList 订单数据 list SalesOrderDto [] 订单集合 invoice InvoiceDto 发票信息（已废弃，不再支持） └ kind String 电子发票类型：电子/纸质 └ title String 北京XX有限公司发票名称：北京XX有限公司 └ content String 服饰发票明细:服饰 └ title_type String 个人抬头类型：个人/公司 └ tax_number String 234009440494 纳税人识别号 order_items SalesOrderItemDto [] 订单明细 └ out_id String 234234 外部商品id └ sku_id String 14983761320224 商品sku └ title String 女士连衣裙商品标题 └ product_type String NORMAL 商品类型:NORMAL(普通商品) └ sale_property String 颜色: 白色/尺码:m/规格:双商品销售属性 └ quantity String 1 数量 └ price String 239.00 销售价，单位:元 └ discount String 0 折扣金额 └ tag_price String 239.00 吊牌价，单位:元 └ shipment_interception String NORMAL 发货拦截标识:NORMAL(正常),INTERCEPTION(拦截) └ id String 123123049494023 唯一标识 └ disc_code String 11 唯一码 └ guider_id String 001 导购id └ barcode String 111 条码 └ art_no String 1111 货号 └ e2_part_discount String 11 E2满减分摊金额 └ store_name String 杭州武林门店名称 └ sale_type String STORE 销售类型:STORE(门店销售),ONLINE(线上销售) └ last_updated Date 2018-10-12 10:59:59 订单更新时间 └ date_created Date 2018-10-12 10:57:59 订单创建时间 └ paid_time Date 2018-10-12 10:59:59 支付时间 └ freight String 0.00 运费，单位:元 └ amount String 239.00 订单金额，单位:元 └ order_number String 2018112122650159 订单号 └ counter_id String 23432 专柜Id └ counter_name String 雅氏专柜名称 └ status String PAID 订单状态:UNPAID(未支付),PAID(已支付),PARTDISTRIBUTION(部分发货),ALLDISTRIBUTION(全部发货),CANCEL(取消)，BUYER_REFUND_GOODS（买家退货） └ buyer_memo String 尽快发货买家留言 └ out_counter_id String 234324 外部专柜Id └ shipper String INTIME 发货方:INTIME(银泰)、THIRD(第三方) └ receiver_name String 张三收货人姓名 └ receiver_address String 朝阳区四惠东XX街道101 收货人详细地址 └ receiver_state String 北京收货人省份 └ receiver_zip String 10000 收货地址邮编 └ receiver_mobile String 130XXXX0910 收货人移动电话 └ receiver_phone String 010-23091201 收货人固话 └ delivery_type String TOSTORE 配送方式:TOSTORE(门店自提)、APPOINTTIME(定时达)、EXPRESS(普通快递)、NEXTDAY(次日定时达)、TOSTORESERVICE(到店服务)、OFFLINESALE(现场销售)、NOT_REQUIRED（无需配送（虚拟商品）） └ appointment_start_time Date 2018-11-10 12:00:00 预约送达时间范围，开始时间 └ receiver_area String 朝阳区收货人所在区域 └ receiver_city String 北京收货人所在市 └ appointment_end_time Date 2018-11-10 14:00:00 预约送达时间范围，结束时间 └ latest_delivery_time Date 2018-10-23 12:00 预售订单，最晚发货时间 └ tag String 订单标签，PRE_ORDER(预购)，PRE_SALE（预售），DUTCH_ACTION（东东抢） └ page_size Number 20 取多少条 └ current_page Number 1 当前页 └ total_count Number 10 总记录数 └ total_page Number 1 总页数 └ sub_msg String 异常信息 └ sub_code String 等于200代表成功 └ success Boolean true 调用是否成功

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaMosOrderQueryRequest req = new AlibabaMosOrderQueryRequest();
AlibabaMosOrderQueryRequest.OrderCriteria obj1 = new AlibabaMosOrderQueryRequest.OrderCriteria();
obj1.setOutCounterId("23423");
obj1.setStatus("PAID");
obj1.setOrderNumbers("2018112122650159");
obj1.setEndDate(StringUtils.parseDateTime("2018-10-13 19:21:00"));
obj1.setStartDate(StringUtils.parseDateTime("2018-10-12 10:21:00"));
obj1.setCounterId("23122");
obj1.setModifyEndDate(StringUtils.parseDateTime("2018-10-13 18:21:00"));
obj1.setModifyStartDate(StringUtils.parseDateTime("2018-10-12 10:21:00"));
req.setOrderCriteria(obj1);
AlibabaMosOrderQueryRequest.Paginator obj2 = new AlibabaMosOrderQueryRequest.Paginator();
obj2.setPageSize(20L);
obj2.setPage(1L);
req.setPaginator(obj2);
AlibabaMosOrderQueryResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaMosOrderQueryRequest req = new AlibabaMosOrderQueryRequest();
AlibabaMosOrderQueryRequest.OrderCriteriaDomain obj1 = new AlibabaMosOrderQueryRequest.OrderCriteriaDomain();
obj1.OutCounterId = "23423";
obj1.Status = "PAID";
obj1.OrderNumbers = "2018112122650159";
obj1.EndDate = DateTime.Parse(2018-10-13 19:21:00");
obj1.StartDate = DateTime.Parse(2018-10-12 10:21:00");
obj1.CounterId = "23122";
obj1.ModifyEndDate = DateTime.Parse(2018-10-13 18:21:00");
obj1.ModifyStartDate = DateTime.Parse(2018-10-12 10:21:00");
req.OrderCriteria_ = obj1;
AlibabaMosOrderQueryRequest.PaginatorDomain obj2 = new AlibabaMosOrderQueryRequest.PaginatorDomain();
obj2.PageSize = 20L;
obj2.Page = 1L;
req.Paginator_ = obj2;
AlibabaMosOrderQueryResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaMosOrderQueryRequest;
$order_criteria = new OrderCriteria;
$order_criteria->out_counter_id="23423";
$order_criteria->status="PAID";
$order_criteria->order_numbers="2018112122650159";
$order_criteria->end_date="2018-10-13 19:21:00";
$order_criteria->start_date="2018-10-12 10:21:00";
$order_criteria->counter_id="23122";
$order_criteria->modify_end_date="2018-10-13 18:21:00";
$order_criteria->modify_start_date="2018-10-12 10:21:00";
$req->setOrderCriteria(json_encode($order_criteria));
$paginator = new Paginator;
$paginator->page_size="20";
$paginator->page="1";
$req->setPaginator(json_encode($paginator));
$resp = $c->execute($req, $sessionKey);

curl -X POST 'http://gw.api.taobao.com/router/rest' \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'app_key=12129701' \
-d 'format=json' \
-d 'method=alibaba.mos.order.query' \
-d 'partner_id=apidoc' \
-d 'session=8228c993-5183-41bb-ab1a-7bcc9d1ae698' \
-d 'sign=1913FF17E18B30F70AF3CF1C8CDBF914' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-23+01%3A58%3A55' \
-d 'v=2.0' \
-d 'order_criteria=null' \
-d 'paginator=null'

# -*- coding: utf-8 -*-
import top.api

req=top.api.AlibabaMosOrderQueryRequest(url,port)
req.set_app_info(top.appinfo(appkey,secret))

req.order_criteria=""
req.paginator=""
try:
	resp= req.getResponse(sessionkey)
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"alibaba.mos.order.query");
add_param(pRequest,"order_criteria","数据结构JSON示例");
add_param(pRequest,"paginator","数据结构JSON示例");
pResponse = top_execute(pClient,pRequest,sessionKey);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('alibaba.mos.order.query', {
	'order_criteria':'数据结构JSON示例',
	'paginator':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_mos_order_query_response>
    <result>
        <data>
            <list>
                <sales_order_dto>
                    <invoice>
                        <kind>电子</kind>
                        <title>北京XX有限公司</title>
                        <content>服饰</content>
                        <title_type>个人</title_type>
                        <tax_number>234009440494</tax_number>
                    </invoice>
                    <order_items>
                        <sales_order_item_dto>
                            <out_id>234234</out_id>
                            <sku_id>14983761320224</sku_id>
                            <title>女士连衣裙</title>
                            <product_type>NORMAL</product_type>
                            <sale_property>颜色: 白色/尺码:m/规格:双</sale_property>
                            <quantity>1</quantity>
                            <price>239.00</price>
                            <discount>0</discount>
                            <tag_price>239.00</tag_price>
                            <shipment_interception>NORMAL</shipment_interception>
                            <id>123123049494023</id>
                            <disc_code>11</disc_code>
                            <guider_id>001</guider_id>
                            <barcode>111</barcode>
                            <art_no>1111</art_no>
                            <e2_part_discount>11</e2_part_discount>
                        </sales_order_item_dto>
                    </order_items>
                    <store_name>杭州武林</store_name>
                    <sale_type>STORE</sale_type>
                    <last_updated>2018-10-12 10:59:59</last_updated>
                    <date_created>2018-10-12 10:57:59</date_created>
                    <paid_time>2018-10-12 10:59:59</paid_time>
                    <freight>0.00</freight>
                    <amount>239.00</amount>
                    <order_number>2018112122650159</order_number>
                    <counter_id>23432</counter_id>
                    <counter_name>雅氏</counter_name>
                    <status>PAID</status>
                    <buyer_memo>尽快发货</buyer_memo>
                    <out_counter_id>234324</out_counter_id>
                    <shipper>INTIME</shipper>
                    <receiver_name>张三</receiver_name>
                    <receiver_address>朝阳区四惠东XX街道101</receiver_address>
                    <receiver_state>北京</receiver_state>
                    <receiver_zip>10000</receiver_zip>
                    <receiver_mobile>130XXXX0910</receiver_mobile>
                    <receiver_phone>010-23091201</receiver_phone>
                    <delivery_type>TOSTORE</delivery_type>
                    <appointment_start_time>2018-11-10 12:00:00</appointment_start_time>
                    <receiver_area>朝阳区</receiver_area>
                    <receiver_city>北京</receiver_city>
                    <appointment_end_time>2018-11-10 14:00:00</appointment_end_time>
                    <latest_delivery_time>2018-10-23 12:00</latest_delivery_time>
                    <tag></tag>
                </sales_order_dto>
            </list>
            <page_size>20</page_size>
            <current_page>1</current_page>
            <total_count>10</total_count>
            <total_page>1</total_page>
        </data>
        <sub_msg></sub_msg>
        <sub_code></sub_code>
        <success>true</success>
    </result>
</alibaba_mos_order_query_response>

{
    "alibaba_mos_order_query_response":{
        "result":{
            "data":{
                "list":{
                    "sales_order_dto":[
                        {
                            "invoice":{
                                "kind":"电子",
                                "title":"北京XX有限公司",
                                "content":"服饰",
                                "title_type":"个人",
                                "tax_number":"234009440494"
                            },
                            "order_items":{
                                "sales_order_item_dto":[
                                    {
                                        "out_id":"234234",
                                        "sku_id":"14983761320224",
                                        "title":"女士连衣裙",
                                        "product_type":"NORMAL",
                                        "sale_property":"颜色: 白色\/尺码:m\/规格:双",
                                        "quantity":"1",
                                        "price":"239.00",
                                        "discount":"0",
                                        "tag_price":"239.00",
                                        "shipment_interception":"NORMAL",
                                        "id":"123123049494023",
                                        "disc_code":"11",
                                        "guider_id":"001",
                                        "barcode":"111",
                                        "art_no":"1111",
                                        "e2_part_discount":"11"
                                    }
                                ]
                            },
                            "store_name":"杭州武林",
                            "sale_type":"STORE",
                            "last_updated":"2018-10-12 10:59:59",
                            "date_created":"2018-10-12 10:57:59",
                            "paid_time":"2018-10-12 10:59:59",
                            "freight":"0.00",
                            "amount":"239.00",
                            "order_number":"2018112122650159",
                            "counter_id":"23432",
                            "counter_name":"雅氏",
                            "status":"PAID",
                            "buyer_memo":"尽快发货",
                            "out_counter_id":"234324",
                            "shipper":"INTIME",
                            "receiver_name":"张三",
                            "receiver_address":"朝阳区四惠东XX街道101",
                            "receiver_state":"北京",
                            "receiver_zip":"10000",
                            "receiver_mobile":"130XXXX0910",
                            "receiver_phone":"010-23091201",
                            "delivery_type":"TOSTORE",
                            "appointment_start_time":"2018-11-10 12:00:00",
                            "receiver_area":"朝阳区",
                            "receiver_city":"北京",
                            "appointment_end_time":"2018-11-10 14:00:00",
                            "latest_delivery_time":"2018-10-23 12:00",
                            "tag":""
                        }
                    ]
                },
                "page_size":20,
                "current_page":1,
                "total_count":10,
                "total_page":1
            },
            "sub_msg":"",
            "sub_code":"",
            "success":true
        }
    }
}

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>

{
	"error_response":{
		"msg":"Remote service error",
		"code":50,
		"sub_msg":"非法参数",
		"sub_code":"isv.invalid-parameter"
	}
}

错误码	错误描述	解决方案
isv.format-parameter	参数格式不正确	调整入参
isv.invalid-parameter	参数无效	调整入参
isp.remote-connection-error	远程调用异常	请联系接口负责人
isv.service-unavailable	服务不可用	请联系接口负责人

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

银泰scm-openapi

alibaba.mos.order.query (批量查询订单信息)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ