淘宝开放平台 - 文档中心

请求地址：

环境	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_relation_xm_query	OrderRelationXmQuery	可选			小满外部查询请求
└ company_id Number 必须 111 小满企业客户id └ eid Number 必须 111 企业id └ tenant_code String 可选 com.alibaba.ames 租户代码 └ sort_field String 可选 GMT_CREATE 排序字段 └ sort_type String 可选 false 排序类型 operator_dto OperatorDTO 必须操作人信息 └ operator_id String 必须 111 AMES商家-eid └ type String 必须 AMES_CUSTOMER AMES客户（AMES_CUSTOMER） └ user_eid Number 必须 112 当前登录的员工号 └ page_size Number 必须 10 pagesize └ current_page Number 必须 1 当前页

名称	类型	示例值	描述
result	PageResult		result
└ total Number 1 数量 └ code String CO_INN_00_000 code data OrderBaseXmResponse [] 数据 └ order_number String 10022886554 订单编号 └ document_maker String 张三制单人 └ order_amount BigDecimal 11 订单金额 └ order_currency_code String USD 订单币制 └ gmt_create Date 1648176156641 创建时间 └ status String TEMPLATE 订单状态 └ order_id Number 10011001 订单id └ total_page Number 1 总页数 └ success Boolean true 成功标志 └ page_size Number 10 pagesize └ current_page Number 1 当前页

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaIcbuAmesQueryOrderlistRequest req = new AlibabaIcbuAmesQueryOrderlistRequest();
AlibabaIcbuAmesQueryOrderlistRequest.OrderRelationXmQuery obj1 = new AlibabaIcbuAmesQueryOrderlistRequest.OrderRelationXmQuery();
obj1.setCompanyId(111L);
obj1.setEid(111L);
obj1.setTenantCode("com.alibaba.ames");
obj1.setSortField("GMT_CREATE");
obj1.setSortType("false");
AlibabaIcbuAmesQueryOrderlistRequest.OperatorDTO obj2 = new AlibabaIcbuAmesQueryOrderlistRequest.OperatorDTO();
obj2.setOperatorId("111");
obj2.setType("AMES_CUSTOMER");
obj2.setUserEid(112L);
obj1.setOperatorDto(obj2);
obj1.setPageSize(10L);
obj1.setCurrentPage(1L);
req.setOrderRelationXmQuery(obj1);
AlibabaIcbuAmesQueryOrderlistResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaIcbuAmesQueryOrderlistRequest req = new AlibabaIcbuAmesQueryOrderlistRequest();
AlibabaIcbuAmesQueryOrderlistRequest.OrderRelationXmQueryDomain obj1 = new AlibabaIcbuAmesQueryOrderlistRequest.OrderRelationXmQueryDomain();
obj1.CompanyId = 111L;
obj1.Eid = 111L;
obj1.TenantCode = "com.alibaba.ames";
obj1.SortField = "GMT_CREATE";
obj1.SortType = "false";
AlibabaIcbuAmesQueryOrderlistRequest.OperatorDTODomain obj2 = new AlibabaIcbuAmesQueryOrderlistRequest.OperatorDTODomain();
obj2.OperatorId = "111";
obj2.Type = "AMES_CUSTOMER";
obj2.UserEid = 112L;
obj1.OperatorDto= obj2;
obj1.PageSize = 10L;
obj1.CurrentPage = 1L;
req.OrderRelationXmQuery_ = obj1;
AlibabaIcbuAmesQueryOrderlistResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaIcbuAmesQueryOrderlistRequest;
$order_relation_xm_query = new OrderRelationXmQuery;
$order_relation_xm_query->company_id="111";
$order_relation_xm_query->eid="111";
$order_relation_xm_query->tenant_code="com.alibaba.ames";
$order_relation_xm_query->sort_field="GMT_CREATE";
$order_relation_xm_query->sort_type="false";
$operator_dto = new OperatorDTO;
$operator_dto->operator_id="111";
$operator_dto->type="AMES_CUSTOMER";
$operator_dto->user_eid="112";
$order_relation_xm_query->operator_dto = $operator_dto;
$order_relation_xm_query->page_size="10";
$order_relation_xm_query->current_page="1";
$req->setOrderRelationXmQuery(json_encode($order_relation_xm_query));
$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.icbu.ames.query.orderlist' \
-d 'partner_id=apidoc' \
-d 'sign=EF33E78A98B2CC3AD8093291880BC09A' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-11+22%3A59%3A33' \
-d 'v=2.0' \
-d 'order_relation_xm_query=null'

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

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

req.order_relation_xm_query="数据结构示例JSON格式"
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.icbu.ames.query.orderlist");
add_param(pRequest,"order_relation_xm_query","数据结构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.icbu.ames.query.orderlist', {
	'order_relation_xm_query':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_icbu_ames_query_orderlist_response>
    <result>
        <total>1</total>
        <code>CO_INN_00_000</code>
        <data>
            <order_base_xm_response>
                <order_number>10022886554</order_number>
                <document_maker>张三</document_maker>
                <order_amount>11</order_amount>
                <order_currency_code>USD</order_currency_code>
                <gmt_create>1648176156641</gmt_create>
                <status>TEMPLATE</status>
                <order_id>10011001</order_id>
            </order_base_xm_response>
        </data>
        <total_page>1</total_page>
        <success>true</success>
        <page_size>10</page_size>
        <current_page>1</current_page>
    </result>
</alibaba_icbu_ames_query_orderlist_response>

{
    "alibaba_icbu_ames_query_orderlist_response":{
        "result":{
            "total":1,
            "code":"CO_INN_00_000",
            "data":{
                "order_base_xm_response":[
                    {
                        "order_number":"10022886554",
                        "document_maker":"张三",
                        "order_amount":"11",
                        "order_currency_code":"USD",
                        "gmt_create":"1648176156641",
                        "status":"TEMPLATE",
                        "order_id":10011001
                    }
                ]
            },
            "total_page":1,
            "success":true,
            "page_size":10,
            "current_page":1
        }
    }
}

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

开放平台

ICBU－一达通

alibaba.icbu.ames.query.orderlist (根据商家客户id查询订单列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ