淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	描述
start_date	String	必须	2019-10-01 00:00:00	开始时间
end_date	String	必须	2019-10-15 23:59:59	结束时间
page	Number	必须	1	第几页（从1开始）
limit	Number	必须	500	每页条数

名称	类型	示例值	描述
results	PageResultDTO	ss	接口返回model
result_list AdsEleTaokeBuyShopOrderTagDTO [] kb 系统自动生成 └ biz_date String 20191202 日期 └ pid String mm_25282911_3455987_64919300053 具体在妈妈的资源位置 └ rid String 001 rid └ order_no String 567465190072814000 订单id └ item_order_no String 567465190072814000 子订单id └ order_item_id String 201910242007627 订单商品id └ item_name String 5份A21工作餐（5选1）商品名称 └ seller_id String 2200800784204 sellerid └ merchant_name String 北京吉野家快餐有限公司商户名称 └ whole_level1_name String 美食商品一级类目 └ whole_level2_name String 快餐小吃商品二级类目 └ whole_level3_name String 中式快餐商品三级类目 └ shop_brand_name String 吉野家门店品牌名称 └ commission_rate String 7% 佣金比例 └ order_create_time Date 2019-10-15 15:23:59 订单创建时间 └ commission_amt String 1.65 结算佣金 └ pre_commission_amt String 0 预结算佣金 └ use_cnt Number 1 核销次数 └ use_amount String 23.56 核销金额 └ object_id String 201911110016431 凭证id └ use_time Date 2019-10-15 15:23:59 核销时间 └ cika_cnt Number 1 可用次数 └ cika_flag String 次卡是否次卡 └ order_amount String 0 订单金额 └ user_type String 新客用户类型 └ city_name String 北京订单城市名称 └ extra_info String "" 扩展信息 └ success Boolean true 系统自动生成 └ error_code String 系统自动生成 └ total_count Number 120 总条数 └ error_msg String 系统自动生成

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaKbtkOrderGetRequest req = new AlibabaKbtkOrderGetRequest();
req.setStartDate("2019-10-01 00:00:00");
req.setEndDate("2019-10-15 23:59:59");
req.setPage(1L);
req.setLimit(500L);
AlibabaKbtkOrderGetResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaKbtkOrderGetRequest req = new AlibabaKbtkOrderGetRequest();
req.StartDate = "2019-10-01 00:00:00";
req.EndDate = "2019-10-15 23:59:59";
req.Page = 1L;
req.Limit = 500L;
AlibabaKbtkOrderGetResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaKbtkOrderGetRequest;
$req->setStartDate("2019-10-01 00:00:00");
$req->setEndDate("2019-10-15 23:59:59");
$req->setPage("1");
$req->setLimit("500");
$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.kbtk.order.get' \
-d 'partner_id=apidoc' \
-d 'sign=E241D9B44CF8CDFC38657A43CAA4F880' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-05+19%3A19%3A06' \
-d 'v=2.0' \
-d 'end_date=2019-10-15+23%3A59%3A59' \
-d 'limit=500' \
-d 'page=1' \
-d 'start_date=2019-10-01+00%3A00%3A00'

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

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

req.start_date="2019-10-01 00:00:00"
req.end_date="2019-10-15 23:59:59"
req.page=1
req.limit=500
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.kbtk.order.get");
add_param(pRequest,"start_date","2019-10-01 00:00:00");
add_param(pRequest,"end_date","2019-10-15 23:59:59");
add_param(pRequest,"page","1");
add_param(pRequest,"limit","500");
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.kbtk.order.get', {
	'start_date':'2019-10-01 00:00:00',
	'end_date':'2019-10-15 23:59:59',
	'page':'1',
	'limit':'500'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_kbtk_order_get_response>
    <results>
        <result_list>
            <ads_ele_taoke_buy_shop_order_tag_d_t_o>
                <biz_date>20191202</biz_date>
                <pid>mm_25282911_3455987_64919300053</pid>
                <rid>001</rid>
                <order_no>567465190072814000</order_no>
                <item_order_no>567465190072814000</item_order_no>
                <order_item_id>201910242007627</order_item_id>
                <item_name>5份A21工作餐（5选1）</item_name>
                <seller_id>2200800784204</seller_id>
                <merchant_name>北京吉野家快餐有限公司</merchant_name>
                <whole_level1_name>美食</whole_level1_name>
                <whole_level2_name>快餐小吃</whole_level2_name>
                <whole_level3_name>中式快餐</whole_level3_name>
                <shop_brand_name>吉野家</shop_brand_name>
                <commission_rate>7%</commission_rate>
                <order_create_time>2019-10-15 15:23:59</order_create_time>
                <commission_amt>1.65</commission_amt>
                <pre_commission_amt>0</pre_commission_amt>
                <use_cnt>1</use_cnt>
                <use_amount>23.56</use_amount>
                <object_id>201911110016431</object_id>
                <use_time>2019-10-15 15:23:59</use_time>
                <cika_cnt>1</cika_cnt>
                <cika_flag>次卡</cika_flag>
                <order_amount>0</order_amount>
                <user_type>新客</user_type>
                <city_name>北京</city_name>
                <extra_info>&quot;&quot;</extra_info>
            </ads_ele_taoke_buy_shop_order_tag_d_t_o>
        </result_list>
        <success>true</success>
        <error_code></error_code>
        <total_count>120</total_count>
        <error_msg></error_msg>
    </results>
</alibaba_kbtk_order_get_response>

{
    "alibaba_kbtk_order_get_response":{
        "results":{
            "result_list":{
                "ads_ele_taoke_buy_shop_order_tag_d_t_o":[
                    {
                        "biz_date":"20191202",
                        "pid":"mm_25282911_3455987_64919300053",
                        "rid":"001",
                        "order_no":"567465190072814000",
                        "item_order_no":"567465190072814000",
                        "order_item_id":"201910242007627",
                        "item_name":"5份A21工作餐（5选1）",
                        "seller_id":"2200800784204",
                        "merchant_name":"北京吉野家快餐有限公司",
                        "whole_level1_name":"美食",
                        "whole_level2_name":"快餐小吃",
                        "whole_level3_name":"中式快餐",
                        "shop_brand_name":"吉野家",
                        "commission_rate":"7%",
                        "order_create_time":"2019-10-15 15:23:59",
                        "commission_amt":"1.65",
                        "pre_commission_amt":"0",
                        "use_cnt":1,
                        "use_amount":"23.56",
                        "object_id":"201911110016431",
                        "use_time":"2019-10-15 15:23:59",
                        "cika_cnt":1,
                        "cika_flag":"次卡",
                        "order_amount":"0",
                        "user_type":"新客",
                        "city_name":"北京",
                        "extra_info":"\"\""
                    }
                ]
            },
            "success":true,
            "error_code":"",
            "total_count":120,
            "error_msg":""
        }
    }
}

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

alibaba.kbtk.order.get (口碑淘客订单数据和核销数据披露接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ