淘宝开放平台

请求地址：

环境	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	可选	订单查询条件
└ counter_id String 可选 10934 银泰专柜Id └ start_date Date 可选 2018-01-01 12:23:12 订单创建时间 └ end_date Date 可选 2018-01-12 12:23:12 订单创建时间 └ order_numbers String [] 可选 2018062809746929","2018062809746928 订单号 └ status String [] 可选 PAID,CANCEL 未支付(“UNPAID”),已支付("PAID"),部分发货("PARTDISTRIBUTION"),全部发货("ALLDISTRIBUTION"),取消("CANCEL") └ out_counter_id String 可选 34321 供应商专柜Id
paginator	Paginator	可选	分页信息
└ page_size Number 可选 20 取多少条，每次最多取20 └ page Number 可选 1 当前页，从1开始，最多支持返回250页

名称	类型	示例值	描述
result	ResultDo		结果
data PagedList 结果集 list SalesOrderDto [] 集合 invoice InvoiceDto 发票信息（已废弃） └ kind String 发票类型:普通发票、电子发票、增值税发票 └ title String 北京XXX公司名称 └ content String 发票内容:日用品 └ title_type String 发票抬头类型：个人、单位 └ tax_number String 税号 order_items SalesOrderItemDto [] 订单商品明细 └ out_id String 外部商品Id └ sku_id String 商品Id └ title String 商品名称 └ product_type String NORMAL 商品类型:普通商品(NORMAL) └ sale_property String 销售属性：颜色:15#/规格:3.5g，用/分隔 └ quantity String 1.0000 数量 └ price String 价格，单位:元 └ discount String 折扣金额，单位:元 └ tag_price String 2.0000 吊牌价，单位:元 └ payments String 支付信息 └ disc_code String 11 唯一码（仅西有用） └ disc_amount String 11 分摊金额（仅西有用） └ shipment_interception String INTERCEPTION 发货拦截标识（ NORMAL 正常 ;INTERCEPTION 拦截） └ guider_id String 001 导购Id └ barcode String 111 条码 └ art_no String 111 货号 └ id String 2001222 唯一标识 └ e2_part_discount String 11 E2分摊金额 └ settlement_code String 商品编码 └ store_name String 杭州武林店门店名称 └ sale_type String STORE 销售类型：STORE（门店销售)、ONLINE(线上销售) └ last_updated Date 2017-10-11 12:00:12 最后更新时间 └ date_created Date 2017-10-10 12:00:12 订单创建时间 └ paid_time Date 2017-10-10 12:26:00 支付时间 └ freight String 2.0903 运费，单位:元 └ amount String 2.3431 订单商品金额，单位:元 └ order_number String 订单号 └ counter_id String 专柜ID └ counter_name String 百丽专柜名称 └ status String 订单状态，可选值：UNPAID(未支付)、PAID(已支付)、PARTDISTRIBUTION(部分发货)、ALLDISTRIBUTION(全部发货)、CANCEL(取消)、BUYER_REFUND_GOODS（买家退货） └ buyer_memo String 请在上午10点前送达买家备注 └ payments String [{"amount":"11.68","code":"14","name":"INTIME365","paymentSerialNumber":"9548167"},{"amount":"105.17","code":"88","name":"支付宝","paymentSerialNumber":"18900302"}] 支付信息 └ out_counter_id String 23423 供应商专柜Id └ shipper String INTIME 发货方:INTIME(银泰)、THIRD(第三方) └ delivery_type String TOSTORE 配送方式:TOSTORE(门店自提)、APPOINTTIME(定时达)、EXPRESS(普通快递)、NEXTDAY(次日定时达)、TOSTORESERVICE(到店服务)、OFFLINESALE(现场销售)、NOT_REQUIRED（无需配送（虚拟商品）） └ page_size Number 取的记录数 └ current_page Number 当前是第几页 └ total_count Number 总记录数 └ total_page Number 总页数 └ sub_msg String 消息 └ sub_code String 状态码 └ success Boolean 成功标志

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaMosOrderListGetRequest req = new AlibabaMosOrderListGetRequest();
AlibabaMosOrderListGetRequest.OrderCriteria obj1 = new AlibabaMosOrderListGetRequest.OrderCriteria();
obj1.setCounterId("10934");
obj1.setStartDate(StringUtils.parseDateTime("2018-01-01 12:23:12"));
obj1.setEndDate(StringUtils.parseDateTime("2018-01-12 12:23:12"));
obj1.setOrderNumbers("2018062809746929\",\"2018062809746928");
obj1.setStatus("PAID,CANCEL");
obj1.setOutCounterId("34321");
req.setOrderCriteria(obj1);
AlibabaMosOrderListGetRequest.Paginator obj2 = new AlibabaMosOrderListGetRequest.Paginator();
obj2.setPageSize(20L);
obj2.setPage(1L);
req.setPaginator(obj2);
AlibabaMosOrderListGetResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaMosOrderListGetRequest req = new AlibabaMosOrderListGetRequest();
AlibabaMosOrderListGetRequest.OrderCriteriaDomain obj1 = new AlibabaMosOrderListGetRequest.OrderCriteriaDomain();
obj1.CounterId = "10934";
obj1.StartDate = DateTime.Parse(2018-01-01 12:23:12");
obj1.EndDate = DateTime.Parse(2018-01-12 12:23:12");
obj1.OrderNumbers = "2018062809746929\",\"2018062809746928";
obj1.Status = "PAID,CANCEL";
obj1.OutCounterId = "34321";
req.OrderCriteria_ = obj1;
AlibabaMosOrderListGetRequest.PaginatorDomain obj2 = new AlibabaMosOrderListGetRequest.PaginatorDomain();
obj2.PageSize = 20L;
obj2.Page = 1L;
req.Paginator_ = obj2;
AlibabaMosOrderListGetResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaMosOrderListGetRequest;
$order_criteria = new OrderCriteria;
$order_criteria->counter_id="10934";
$order_criteria->start_date="2018-01-01 12:23:12";
$order_criteria->end_date="2018-01-12 12:23:12";
$order_criteria->order_numbers="2018062809746929\",\"2018062809746928";
$order_criteria->status="PAID,CANCEL";
$order_criteria->out_counter_id="34321";
$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.list.get' \
-d 'partner_id=apidoc' \
-d 'session=b6fdc381-d1be-463c-9da1-d981033239b5' \
-d 'sign=50463BF213AC55945880F94403DF9C77' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-23+01%3A56%3A46' \
-d 'v=2.0' \
-d 'order_criteria=null' \
-d 'paginator=null'

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

req=top.api.AlibabaMosOrderListGetRequest(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.list.get");
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.list.get', {
	'order_criteria':'数据结构JSON示例',
	'paginator':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_mos_order_list_get_response>
    <result>
        <data>
            <list>
                <sales_order_dto>
                    <invoice>
                        <kind></kind>
                        <title>北京XXX公司</title>
                        <content></content>
                        <title_type></title_type>
                        <tax_number></tax_number>
                    </invoice>
                    <order_items>
                        <sales_order_item_dto>
                            <out_id></out_id>
                            <sku_id></sku_id>
                            <title></title>
                            <product_type>NORMAL</product_type>
                            <sale_property></sale_property>
                            <quantity>1.0000</quantity>
                            <price></price>
                            <discount></discount>
                            <tag_price>2.0000</tag_price>
                            <payments></payments>
                            <disc_code>11</disc_code>
                            <disc_amount>11</disc_amount>
                            <shipment_interception>INTERCEPTION</shipment_interception>
                            <guider_id>001</guider_id>
                            <barcode>111</barcode>
                            <art_no>111</art_no>
                            <id>2001222</id>
                            <e2_part_discount>11</e2_part_discount>
                            <settlement_code></settlement_code>
                        </sales_order_item_dto>
                    </order_items>
                    <store_name>杭州武林店</store_name>
                    <sale_type>STORE</sale_type>
                    <last_updated>2017-10-11 12:00:12</last_updated>
                    <date_created>2017-10-10 12:00:12</date_created>
                    <paid_time>2017-10-10 12:26:00</paid_time>
                    <freight>2.0903</freight>
                    <amount>2.3431</amount>
                    <order_number></order_number>
                    <counter_id></counter_id>
                    <counter_name>百丽</counter_name>
                    <status></status>
                    <buyer_memo>请在上午10点前送达</buyer_memo>
                    <payments>[{&quot;amount&quot;:&quot;11.68&quot;,&quot;code&quot;:&quot;14&quot;,&quot;name&quot;:&quot;INTIME365&quot;,&quot;paymentSerialNumber&quot;:&quot;9548167&quot;},{&quot;amount&quot;:&quot;105.17&quot;,&quot;code&quot;:&quot;88&quot;,&quot;name&quot;:&quot;支付宝&quot;,&quot;paymentSerialNumber&quot;:&quot;18900302&quot;}]</payments>
                    <out_counter_id>23423</out_counter_id>
                    <shipper>INTIME</shipper>
                    <delivery_type>TOSTORE</delivery_type>
                </sales_order_dto>
            </list>
            <page_size></page_size>
            <current_page></current_page>
            <total_count></total_count>
            <total_page></total_page>
        </data>
        <sub_msg></sub_msg>
        <sub_code></sub_code>
        <success></success>
    </result>
</alibaba_mos_order_list_get_response>

{
    "alibaba_mos_order_list_get_response":{
        "result":{
            "data":{
                "list":{
                    "sales_order_dto":[
                        {
                            "invoice":{
                                "kind":"",
                                "title":"北京XXX公司",
                                "content":"",
                                "title_type":"",
                                "tax_number":""
                            },
                            "order_items":{
                                "sales_order_item_dto":[
                                    {
                                        "out_id":"",
                                        "sku_id":"",
                                        "title":"",
                                        "product_type":"NORMAL",
                                        "sale_property":"",
                                        "quantity":"1.0000",
                                        "price":"",
                                        "discount":"",
                                        "tag_price":"2.0000",
                                        "payments":"",
                                        "disc_code":"11",
                                        "disc_amount":"11",
                                        "shipment_interception":"INTERCEPTION",
                                        "guider_id":"001",
                                        "barcode":"111",
                                        "art_no":"111",
                                        "id":"2001222",
                                        "e2_part_discount":"11",
                                        "settlement_code":""
                                    }
                                ]
                            },
                            "store_name":"杭州武林店",
                            "sale_type":"STORE",
                            "last_updated":"2017-10-11 12:00:12",
                            "date_created":"2017-10-10 12:00:12",
                            "paid_time":"2017-10-10 12:26:00",
                            "freight":"2.0903",
                            "amount":"2.3431",
                            "order_number":"",
                            "counter_id":"",
                            "counter_name":"百丽",
                            "status":"",
                            "buyer_memo":"请在上午10点前送达",
                            "payments":"[{\"amount\":\"11.68\",\"code\":\"14\",\"name\":\"INTIME365\",\"paymentSerialNumber\":\"9548167\"},{\"amount\":\"105.17\",\"code\":\"88\",\"name\":\"支付宝\",\"paymentSerialNumber\":\"18900302\"}]",
                            "out_counter_id":"23423",
                            "shipper":"INTIME",
                            "delivery_type":"TOSTORE"
                        }
                    ]
                },
                "page_size":,
                "current_page":,
                "total_count":,
                "total_page":
            },
            "sub_msg":"",
            "sub_code":"",
            "success":
        }
    }
}

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"
	}
}

错误码	错误描述	解决方案

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

银泰scm-openapi

alibaba.mos.order.list.get (批量查询订单交易)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ