淘宝开放平台

请求地址：

环境	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_oms_sale_order_query_request	OmsSaleOrderQueryRequest	可选			参数
└ category String 可选 TIANMAOJINGLINGCHENGPIN 类别 └ customer_code_list String [] 可选 [] 客户编码列表 └ gmt_create_end Date 可选 2021-04-01 00:00:00 订单创建结束时间 └ gmt_create_start Date 可选 2021-01-01 00:00:00 订单创建开始时间 └ item_number_list String [] 可选 [] 商品编码列表 └ operator String 可选 79456 操作人 └ order_amount_end Number 可选 100000 价格开始 └ order_amount_start Number 可选 0 价格结束 └ out_customer_code_list String [] 可选 ["100"] 外部客户编码列表 └ page_no Number 可选 1 页码 └ page_size Number 可选 10 页数 └ product_id_list Number [] 可选 [] 产品线ID列表 └ request_id String 可选 12345612345 请求ID └ ship_order_status_list String [] 可选 [] 物流状态列表 └ status_list String [] 可选 [] 订单状态列表 └ tenant String 可选 ailab 租户 └ trade_order_id String 可选 SO00000936 订单号

名称	类型	示例值	描述
result	DataResult	1	返回对象封装
└ code String foo 参数code data SaleOrderDataDto 1 data order_list SaleOrderDto [] 订单列表 └ actual_fee Number 实付金额，分 └ buyer_code String 1 客户编码 └ buyer_name String 1 客户名称 └ gmt_create Date 2017-12-12 12:12:12 创建时间 └ gmt_modified Date 2017-12-12 12:12:12 更新时间 └ item_quantity Number 商品个数 └ ship_order_status String 1 发运状态 └ status String 1 订单状态 └ trade_order_id String 1 订单号 └ channel String 渠道 order_status_count SaleOrderCountDto [] 状态个数统计列表 └ key String 状态值 └ value String 状态下个数 └ msg String foo 参数msg └ success Boolean false 是否正常 └ total Number 10 总数 └ trace_id String 123456 traceId

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaGscDmsAgentPurchaseorderListGetRequest req = new AlibabaGscDmsAgentPurchaseorderListGetRequest();
AlibabaGscDmsAgentPurchaseorderListGetRequest.OmsSaleOrderQueryRequest obj1 = new AlibabaGscDmsAgentPurchaseorderListGetRequest.OmsSaleOrderQueryRequest();
obj1.setCategory("TIANMAOJINGLINGCHENGPIN");
obj1.setCustomerCodeList("");
obj1.setGmtCreateEnd(StringUtils.parseDateTime("2021-04-01 00:00:00"));
obj1.setGmtCreateStart(StringUtils.parseDateTime("2021-01-01 00:00:00"));
obj1.setItemNumberList("");
obj1.setOperator("79456");
obj1.setOrderAmountEnd(100000L);
obj1.setOrderAmountStart(0L);
obj1.setOutCustomerCodeList(""100"");
obj1.setPageNo(1L);
obj1.setPageSize(10L);
obj1.setProductIdList(new Long[] {  };
);
obj1.setRequestId("12345612345");
obj1.setShipOrderStatusList("");
obj1.setStatusList("");
obj1.setTenant("ailab");
obj1.setTradeOrderId("SO00000936");
req.setParamOmsSaleOrderQueryRequest(obj1);
AlibabaGscDmsAgentPurchaseorderListGetResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaGscDmsAgentPurchaseorderListGetRequest req = new AlibabaGscDmsAgentPurchaseorderListGetRequest();
AlibabaGscDmsAgentPurchaseorderListGetRequest.OmsSaleOrderQueryRequestDomain obj1 = new AlibabaGscDmsAgentPurchaseorderListGetRequest.OmsSaleOrderQueryRequestDomain();
obj1.Category = "TIANMAOJINGLINGCHENGPIN";
obj1.CustomerCodeList = "";
obj1.GmtCreateEnd = DateTime.Parse(2021-04-01 00:00:00");
obj1.GmtCreateStart = DateTime.Parse(2021-01-01 00:00:00");
obj1.ItemNumberList = "";
obj1.Operator = "79456";
obj1.OrderAmountEnd = 100000L;
obj1.OrderAmountStart = 0L;
obj1.OutCustomerCodeList = ""100"";
obj1.PageNo = 1L;
obj1.PageSize = 10L;
obj1.ProductIdList = new long[] {  };
;
obj1.RequestId = "12345612345";
obj1.ShipOrderStatusList = "";
obj1.StatusList = "";
obj1.Tenant = "ailab";
obj1.TradeOrderId = "SO00000936";
req.ParamOmsSaleOrderQueryRequest_ = obj1;
AlibabaGscDmsAgentPurchaseorderListGetResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaGscDmsAgentPurchaseorderListGetRequest;
$param_oms_sale_order_query_request = new OmsSaleOrderQueryRequest;
$param_oms_sale_order_query_request->category="TIANMAOJINGLINGCHENGPIN";
$param_oms_sale_order_query_request->customer_code_list="[]";
$param_oms_sale_order_query_request->gmt_create_end="2021-04-01 00:00:00";
$param_oms_sale_order_query_request->gmt_create_start="2021-01-01 00:00:00";
$param_oms_sale_order_query_request->item_number_list="[]";
$param_oms_sale_order_query_request->operator="79456";
$param_oms_sale_order_query_request->order_amount_end="100000";
$param_oms_sale_order_query_request->order_amount_start="0";
$param_oms_sale_order_query_request->out_customer_code_list="[\"100\"]";
$param_oms_sale_order_query_request->page_no="1";
$param_oms_sale_order_query_request->page_size="10";
$param_oms_sale_order_query_request->product_id_list="[]";
$param_oms_sale_order_query_request->request_id="12345612345";
$param_oms_sale_order_query_request->ship_order_status_list="[]";
$param_oms_sale_order_query_request->status_list="[]";
$param_oms_sale_order_query_request->tenant="ailab";
$param_oms_sale_order_query_request->trade_order_id="SO00000936";
$req->setParamOmsSaleOrderQueryRequest(json_encode($param_oms_sale_order_query_request));
$resp = $c->execute($req);

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.gsc.dms.agent.purchaseorder.list.get' \
-d 'partner_id=apidoc' \
-d 'sign=12C3F5312F27FCF9168FAD5997521152' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-06-21+15%3A12%3A42' \
-d 'v=2.0' \
-d 'param_oms_sale_order_query_request=null'

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

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

req.param_oms_sale_order_query_request=""
try:
	resp= req.getResponse()
	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.gsc.dms.agent.purchaseorder.list.get");
add_param(pRequest,"param_oms_sale_order_query_request","数据结构JSON示例");
pResponse = top_execute(pClient,pRequest,NULL);
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.gsc.dms.agent.purchaseorder.list.get', {
	'param_oms_sale_order_query_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_gsc_dms_agent_purchaseorder_list_get_response>
    <result>
        <code>foo</code>
        <data>
            <order_list>
                <sale_order_dto>
                    <actual_fee></actual_fee>
                    <buyer_code>1</buyer_code>
                    <buyer_name>1</buyer_name>
                    <gmt_create>2017-12-12 12:12:12</gmt_create>
                    <gmt_modified>2017-12-12 12:12:12</gmt_modified>
                    <item_quantity></item_quantity>
                    <ship_order_status>1</ship_order_status>
                    <status>1</status>
                    <trade_order_id>1</trade_order_id>
                    <channel></channel>
                </sale_order_dto>
            </order_list>
            <order_status_count>
                <sale_order_count_dto>
                    <key></key>
                    <value></value>
                </sale_order_count_dto>
            </order_status_count>
        </data>
        <msg>foo</msg>
        <success>false</success>
        <total>10</total>
        <trace_id>123456</trace_id>
    </result>
</alibaba_gsc_dms_agent_purchaseorder_list_get_response>

{
    "alibaba_gsc_dms_agent_purchaseorder_list_get_response":{
        "result":{
            "code":"foo",
            "data":{
                "order_list":{
                    "sale_order_dto":[
                        {
                            "actual_fee":,
                            "buyer_code":"1",
                            "buyer_name":"1",
                            "gmt_create":"2017-12-12 12:12:12",
                            "gmt_modified":"2017-12-12 12:12:12",
                            "item_quantity":,
                            "ship_order_status":"1",
                            "status":"1",
                            "trade_order_id":"1",
                            "channel":""
                        }
                    ]
                },
                "order_status_count":{
                    "sale_order_count_dto":[
                        {
                            "key":"",
                            "value":""
                        }
                    ]
                }
            },
            "msg":"foo",
            "success":false,
            "total":10,
            "trace_id":"123456"
        }
    }
}

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下载

天猫精灵供应链销售运营

alibaba.gsc.dms.agent.purchaseorder.list.get (销售订单数据查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ