阿里大于 -

请求地址：

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

名称	类型	是否必须	描述
contract_order_list_req	ContractOrderListReq	可选	订单列表请求
└ contract_id String 可选 10000001 合同ID └ out_order_id_list String [] 可选 Top,Pub 外部订单列表 └ biz_order_id_list String [] 可选 Top,Pub 企业购订单列表 └ pay_status Number 可选 10 支付状态:1一未冻结/未付款 -＞等待买家发起付款 2-已冻结/已付款/信用额度占用 -＞等待卖家发货 4 - 已退款-＞交易关闭 6- 已转交易/信用额度释放一＞交易成功 7-没有创建外部交易(支付宝交易） 8 -交易被淘宝关闭 9- 不可付款/信用额度不足 └ status Number 可选 10 订单状态：0-订单可见待确认 1 订单不可见 2 订单已确认 3 结算已收单 4 已结算 └ logistics_status Number 可选 10 物流状态：1-未发货-＞等待卖家发货 2-已发货-＞等待买家确认收货 3 -已收货-＞交易成功 4- 已经退货-＞交易失败 5- 部分收货-＞交易成功 6- 部分发货中 8-还未创建物流订单 9- 配货中,目前周期购已经使用到 └ create_time_start String 可选 xxxxx 创建订单起始时间, 格式为yyyy-MM-dd HH:mm:ss └ create_time_end String 可选 xxxxx 创建订单截止时间, 格式为yyyy-MM-dd HH:mm:ss └ pay_time_start String 可选 xxxxx 订单支付起始时间, 格式为yyyy-MM-dd HH:mm:ss └ pay_time_end String 可选 xxxxx 订单支付截止时间, 格式为yyyy-MM-dd HH:mm:ss └ end_time_start String 可选 xxxxx 订单完结起始时间, 格式为yyyy-MM-dd HH:mm:ss └ end_time_end String 可选 xxxxx 订单完结截止时间, 格式为yyyy-MM-dd HH:mm:ss └ buyer_id Number 必须 10000001 买家ID
page_query_param	PageQueryParam	可选	分页查询参数
└ page_size Number 必须 20 分页大小，区间[1,20] └ current_page Number 必须 1 当前页，从1开始 └ cursor String 可选 12345 游标，开启了游标模式，查询下一页的时候需要传入，第一次查询可以不传 └ cursor_mode Boolean 可选 false 是否开启游标模式 └ with_total Boolean 可选 true 是否需要返回总数

名称	类型	示例值	描述
page_result	OrderListItem		pageResult
└ success Boolean true 操作是否成功 └ error_code String 200 结果码 └ error_msg String 参数错误结果描述 order_list_item_page_data OrderListItem 分页结果 └ current_page Number 1 当前页码 └ page_size Number 20 每页大小 └ total_count Number 100 总数量 └ cursor_mode Boolean false 是否游标模式 └ cursor String 12345 游标 order_list_item_list OrderListItem [] 数据集合 sub_order_list SubOrderListItem [] 子订单列表信息 └ biz_order_id String xxxxx 子订单ID └ parent_id String xxxxx 父订单ID └ tp_order_id String xxxxx 淘宝订单ID └ out_order_id String xxxxx 外部订单号 └ item_id Number 3 商品ID └ item_name String xxxxx 商品名称 └ item_pic String xxxxx 商品主图链接 └ sku_id Number 3 SKU ID └ sku_property String xxxxx SKU属性 └ item_price Number 3 商品单价 └ buy_amount Number 10 购买数量 └ status Number 10 订单状态：0-订单可见待确认 1 订单不可见 2 订单已确认 3 结算已收单 4 已结算 └ pay_status Number 10 支付状态：1一未冻结/未付款 -＞等待买家发起付款 2-已冻结/已付款/信用额度占用 -＞等待卖家发货 4 - 已退款-＞交易关闭 6- 已转交易/信用额度释放一＞交易成功 7-没有创建外部交易(支付宝交易） 8 -交易被淘宝关闭 9- 不可付款/信用额度不足 └ logistics_status Number 10 物流状态：1-未发货-＞等待卖家发货 2-已发货-＞等待买家确认收货 3 -已收货-＞交易成功 4- 已经退货-＞交易失败 5- 部分收货-＞交易成功 6- 部分发货中 8-还未创建物流订单 9- 配货中,目前周期购已经使用到 └ refund_status Number 10 退款状态：1-买家已经申请退款，等待卖家同意 2-卖家已经同意退款，等待买家退货 3一买家已经退货，等待卖家确认收货 4- 退款关闭 5- 退款成功 6一卖家拒绝退款 9一没有申请退款,对主定单和子订单都有效 10一有活动退款，申请退款后，只对主定单有效只有一笔订单的情况，主定单的退款状态可能为1,2,3,6,10 ；11一退款结束，只对父订单有效 └ create_time String xxxxx 创建时间 └ pay_time String xxxxx 支付确认时间 └ end_time String xxxxx 结束时间 └ buyer_id Number 3 买方的企业账号ID └ out_service_id Number 3 服务商ID └ out_service_nick String xxxxx 服务商名称 └ biz_order_id String xxxxx 企业购订单号 └ out_order_id String xxxxx 外部系统订单号 └ contract_no String xxxxx 合同ID └ social_credit_code String xxxxx 社会信用代码 └ tp_order_id_list String [] Top,Pub 关联的淘宝订单列表 └ buy_amount Number 10 购买的商品数量 └ total_fee Number 3 总费用, 单位为分 └ post_fee Number 3 邮费, 单位为分 └ status Number 10 订单状态：0-订单可见待确认 1 订单不可见 2 订单已确认 3 结算已收单 4 已结算 └ pay_status Number 10 支付状态：1一未冻结/未付款 -＞等待买家发起付款 2-已冻结/已付款/信用额度占用 -＞等待卖家发货 4 - 已退款-＞交易关闭 6- 已转交易/信用额度释放一＞交易成功 7-没有创建外部交易(支付宝交易） 8 -交易被淘宝关闭 9- 不可付款/信用额度不足 └ logistics_status Number 10 物流状态：1-未发货-＞等待卖家发货 2-已发货-＞等待买家确认收货 3 -已收货-＞交易成功 4- 已经退货-＞交易失败 5- 部分收货-＞交易成功 6- 部分发货中 8-还未创建物流订单 9- 配货中,目前周期购已经使用到 └ refund_status Number 10 退款状态：1-买家已经申请退款，等待卖家同意 2-卖家已经同意退款，等待买家退货 3一买家已经退货，等待卖家确认收货 4- 退款关闭 5- 退款成功 6一卖家拒绝退款 9一没有申请退款,对主定单和子订单都有效 10一有活动退款，申请退款后，只对主定单有效只有一笔订单的情况，主定单的退款状态可能为1,2,3,6,10 ；11一退款结束，只对父订单有效 └ create_time String xxxxx 创建时间 └ pay_time String xxxxx 支付确认时间 └ end_time String xxxxx 结束时间 └ logistics_confirm_time String xxxxx 确认收货时间 └ remark String xxxxx 买家的额外说明或备注 receiver Receiver 收货人信息 └ receiver_name String xxxxx 收件人的姓名 └ mobile String xxxxx 手机号码 └ address_detail String xxxxx 地址详情

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
PcOrderListRequest req = new PcOrderListRequest();
PcOrderListRequest.ContractOrderListReq obj1 = new PcOrderListRequest.ContractOrderListReq();
obj1.setContractId("10000001");
obj1.setOutOrderIdList("Top,Pub");
obj1.setBizOrderIdList("Top,Pub");
obj1.setPayStatus(10L);
obj1.setStatus(10L);
obj1.setLogisticsStatus(10L);
obj1.setCreateTimeStart("xxxxx");
obj1.setCreateTimeEnd("xxxxx");
obj1.setPayTimeStart("xxxxx");
obj1.setPayTimeEnd("xxxxx");
obj1.setEndTimeStart("xxxxx");
obj1.setEndTimeEnd("xxxxx");
obj1.setBuyerId(10000001L);
req.setContractOrderListReq(obj1);
PcOrderListRequest.PageQueryParam obj2 = new PcOrderListRequest.PageQueryParam();
obj2.setPageSize(20L);
obj2.setCurrentPage(1L);
obj2.setCursor("12345");
obj2.setCursorMode(false);
obj2.setWithTotal(true);
req.setPageQueryParam(obj2);
PcOrderListResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
PcOrderListRequest req = new PcOrderListRequest();
PcOrderListRequest.ContractOrderListReqDomain obj1 = new PcOrderListRequest.ContractOrderListReqDomain();
obj1.ContractId = "10000001";
obj1.OutOrderIdList = "Top,Pub";
obj1.BizOrderIdList = "Top,Pub";
obj1.PayStatus = 10L;
obj1.Status = 10L;
obj1.LogisticsStatus = 10L;
obj1.CreateTimeStart = "xxxxx";
obj1.CreateTimeEnd = "xxxxx";
obj1.PayTimeStart = "xxxxx";
obj1.PayTimeEnd = "xxxxx";
obj1.EndTimeStart = "xxxxx";
obj1.EndTimeEnd = "xxxxx";
obj1.BuyerId = 10000001L;
req.ContractOrderListReq_ = obj1;
PcOrderListRequest.PageQueryParamDomain obj2 = new PcOrderListRequest.PageQueryParamDomain();
obj2.PageSize = 20L;
obj2.CurrentPage = 1L;
obj2.Cursor = "12345";
obj2.CursorMode = false;
obj2.WithTotal = true;
req.PageQueryParam_ = obj2;
PcOrderListResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new PcOrderListRequest;
$contract_order_list_req = new ContractOrderListReq;
$contract_order_list_req->contract_id="10000001";
$contract_order_list_req->out_order_id_list="Top,Pub";
$contract_order_list_req->biz_order_id_list="Top,Pub";
$contract_order_list_req->pay_status="10";
$contract_order_list_req->status="10";
$contract_order_list_req->logistics_status="10";
$contract_order_list_req->create_time_start="xxxxx";
$contract_order_list_req->create_time_end="xxxxx";
$contract_order_list_req->pay_time_start="xxxxx";
$contract_order_list_req->pay_time_end="xxxxx";
$contract_order_list_req->end_time_start="xxxxx";
$contract_order_list_req->end_time_end="xxxxx";
$contract_order_list_req->buyer_id="10000001";
$req->setContractOrderListReq(json_encode($contract_order_list_req));
$page_query_param = new PageQueryParam;
$page_query_param->page_size="20";
$page_query_param->current_page="1";
$page_query_param->cursor="12345";
$page_query_param->cursor_mode="false";
$page_query_param->with_total="true";
$req->setPageQueryParam(json_encode($page_query_param));
$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=taobao.pc.order.list' \
-d 'partner_id=apidoc' \
-d 'sign=748B6C40D89C2F2E54888C54EE1D57F3' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-29+15%3A36%3A41' \
-d 'v=2.0' \
-d 'contract_order_list_req=null' \
-d 'page_query_param=null'

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

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

req.contract_order_list_req=""
req.page_query_param=""
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,"taobao.pc.order.list");
add_param(pRequest,"contract_order_list_req","数据结构JSON示例");
add_param(pRequest,"page_query_param","数据结构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('taobao.pc.order.list', {
	'contract_order_list_req':'数据结构JSON示例',
	'page_query_param':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<pc_order_list_response>
    <page_result>
        <success>true</success>
        <error_code>200</error_code>
        <error_msg>参数错误</error_msg>
        <order_list_item_page_data>
            <current_page>1</current_page>
            <page_size>20</page_size>
            <total_count>100</total_count>
            <cursor_mode>false</cursor_mode>
            <cursor>12345</cursor>
            <order_list_item_list>
                <order_list_item>
                    <sub_order_list>
                        <sub_order_list_item>
                            <biz_order_id>xxxxx</biz_order_id>
                            <parent_id>xxxxx</parent_id>
                            <tp_order_id>xxxxx</tp_order_id>
                            <out_order_id>xxxxx</out_order_id>
                            <item_id>3</item_id>
                            <item_name>xxxxx</item_name>
                            <item_pic>xxxxx</item_pic>
                            <sku_id>3</sku_id>
                            <sku_property>xxxxx</sku_property>
                            <item_price>3</item_price>
                            <buy_amount>10</buy_amount>
                            <status>10</status>
                            <pay_status>10</pay_status>
                            <logistics_status>10</logistics_status>
                            <refund_status>10</refund_status>
                            <create_time>xxxxx</create_time>
                            <pay_time>xxxxx</pay_time>
                            <end_time>xxxxx</end_time>
                        </sub_order_list_item>
                    </sub_order_list>
                    <buyer_id>3</buyer_id>
                    <out_service_id>3</out_service_id>
                    <out_service_nick>xxxxx</out_service_nick>
                    <biz_order_id>xxxxx</biz_order_id>
                    <out_order_id>xxxxx</out_order_id>
                    <contract_no>xxxxx</contract_no>
                    <social_credit_code>xxxxx</social_credit_code>
                    <tp_order_id_list>
                        <string>Top</string>
                        <string>Pub</string>
                    </tp_order_id_list>
                    <buy_amount>10</buy_amount>
                    <total_fee>3</total_fee>
                    <post_fee>3</post_fee>
                    <status>10</status>
                    <pay_status>10</pay_status>
                    <logistics_status>10</logistics_status>
                    <refund_status>10</refund_status>
                    <create_time>xxxxx</create_time>
                    <pay_time>xxxxx</pay_time>
                    <end_time>xxxxx</end_time>
                    <logistics_confirm_time>xxxxx</logistics_confirm_time>
                    <remark>xxxxx</remark>
                    <receiver>
                        <receiver_name>xxxxx</receiver_name>
                        <mobile>xxxxx</mobile>
                        <address_detail>xxxxx</address_detail>
                    </receiver>
                </order_list_item>
            </order_list_item_list>
        </order_list_item_page_data>
    </page_result>
</pc_order_list_response>

{
    "pc_order_list_response":{
        "page_result":{
            "success":true,
            "error_code":"200",
            "error_msg":"参数错误",
            "order_list_item_page_data":{
                "current_page":1,
                "page_size":20,
                "total_count":100,
                "cursor_mode":false,
                "cursor":"12345",
                "order_list_item_list":{
                    "order_list_item":[
                        {
                            "sub_order_list":{
                                "sub_order_list_item":[
                                    {
                                        "biz_order_id":"xxxxx",
                                        "parent_id":"xxxxx",
                                        "tp_order_id":"xxxxx",
                                        "out_order_id":"xxxxx",
                                        "item_id":3,
                                        "item_name":"xxxxx",
                                        "item_pic":"xxxxx",
                                        "sku_id":3,
                                        "sku_property":"xxxxx",
                                        "item_price":3,
                                        "buy_amount":10,
                                        "status":10,
                                        "pay_status":10,
                                        "logistics_status":10,
                                        "refund_status":10,
                                        "create_time":"xxxxx",
                                        "pay_time":"xxxxx",
                                        "end_time":"xxxxx"
                                    }
                                ]
                            },
                            "buyer_id":3,
                            "out_service_id":3,
                            "out_service_nick":"xxxxx",
                            "biz_order_id":"xxxxx",
                            "out_order_id":"xxxxx",
                            "contract_no":"xxxxx",
                            "social_credit_code":"xxxxx",
                            "tp_order_id_list":{
                                "string":[
                                    "Top",
                                    "Pub"
                                ]
                            },
                            "buy_amount":10,
                            "total_fee":3,
                            "post_fee":3,
                            "status":10,
                            "pay_status":10,
                            "logistics_status":10,
                            "refund_status":10,
                            "create_time":"xxxxx",
                            "pay_time":"xxxxx",
                            "end_time":"xxxxx",
                            "logistics_confirm_time":"xxxxx",
                            "remark":"xxxxx",
                            "receiver":{
                                "receiver_name":"xxxxx",
                                "mobile":"xxxxx",
                                "address_detail":"xxxxx"
                            }
                        }
                    ]
                }
            }
        }
    }
}

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

采购宝API

taobao.pc.order.list (企业购订单列表查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ