淘宝开放平台 - 文档中心

请求地址：

环境	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_type	String	必须	CPS_EFFECT	订单类型，枚举值。"CPS_EFFECT": CPS效果口径订单；"CPA_THIRD_EFFECT": CPA首购效果订单; 必传
biz_type	String	必须	ALIMAMA	订单业务类型，枚举值。"PANAMA": 巴拿马订单；"ALIMAMA": 阿里妈妈订单。必传
page_no	Number	可选	1	页码，默认1
order_status	String	可选	12	订单状态，不传默认所有状态
page_size	Number	可选	20	页大小，不传默认20
start_time	String	必须	2021-04-03 01:02:04	查询开始时间
end_time	String	必须	2021-04-03 01:02:04	2021-04-03 01:02:08
query_type	Number	必须	4	查询时间类型。准实时订单：1：按照订单淘客创建时间查询，2:按照订单淘客付款时间查询，3:按照订单淘客结算时间查询，4:按照订单更新时间；T+N订单只支持 4: 按照订单更新时间查
position_index	String	可选	asddfsd1	点位，预留字段
sandbox	Number	可选	0	是否沙盒环境，0否 1是

名称	类型	示例值	描述
order_list	TbkOrder []		订单列表
└ modified_time String 2021-09-08 10:06:18 订单更新时间，非实时场景(首购、结算等)为订单产出时间(天、月) └ tk_paid_time String 2021-09-08 10:06:18 订单付款的时间，该时间同步淘宝，可能会略晚于买家在淘宝的订单支付时间 └ item_link String http://item.taobao.com/item.htm?id=595722551104 商品链接 └ alimama_rate String 10.00 推广者赚取佣金后支付给阿里妈妈的技术服务费用的比率 └ adzone_id Number 123 广告位ID └ income_rate String 20.00 订单结算的佣金比率+平台的补贴比率 └ pub_share_pre_fee String 15.13 付款预估收入=付款金额提成。指买家付款金额为基数，预估您可能获得的收入。因买家退款等原因，可能与结算预估收入不一致 └ subsidy_fee String 0.00 补贴金额=结算金额补贴比率 └ total_commission_fee String 15.13 佣金金额=结算金额佣金比率 └ item_img String //img.alicdn.com/tfscom/i1/1081761928/O1CN01X1GZwR1Q74IrqjH59_!!1081761928.jpg 商品图片 └ pub_share_fee String 15.13 结算预估收入=结算金额提成。以买家确认收货的付款金额为基数，预估您可能获得的收入。因买家退款、您违规推广等原因，可能与您最终收入不一致。最终收入以月结后您实际收到的为准 └ pub_id Number 123 推广者的会员id └ tk_commission_fee_for_media_platform String 0.00 结算内容专项服务费：内容场景专项技术服务费，内容推广者在内容场景进行推广需要支付给阿里妈妈专项的技术服务费用。专项服务费＝结算金额＊专项服务费率 └ marketing_type String 超级红包活动营销类型：该字段中视订单情况有单个或多个值。例如：淘礼金（自助充值），特价版客户端染色，特价版客户端锁粉，特价版客户端推广。 └ click_time String 2021-08-29 04:25:26 通过推广链接达到商品、店铺详情页的点击时间 └ tb_paid_time String 2021-08-29 04:25:58 订单在淘宝拍下付款的时间 └ terminal_type String 无线成交平台 └ item_id String qwdsafda-1da3d 商品id └ alipay_total_price String 75.65 买家拍下付款的金额（不包含运费金额） └ tk_status Number 12 订单状态 └ tk_order_role Number 2 二方：佣金收益的第一归属者；三方：从其他淘宝客佣金中进行分成的推广者 └ unid String 1234 渠道自定义参数 └ item_category_level3_name String 女装商品三级类目名称 └ tk_create_time String 2021-08-29 04:25:43 订单创建的时间，该时间同步淘宝，可能会略晚于买家在淘宝的订单创建时间 └ item_title String 维骨力加钙片 240粒/袋商品标题 └ tk_earning_time String 2021-09-08 10:06:17 订单确认收货后且商家完成佣金支付的时间 └ site_name String 媒体媒体管理下的对应ID的自定义名称 └ item_category_level2_name String 二级类目商品二级类目名称 └ item_num Number 1 商品数量 └ trade_parent_id String 123 买家在淘宝后台显示的订单编号 └ flow_source String -- 产品类型 └ pay_price String 75.65 买家确认收货的付款金额（不包含运费金额） └ tk_total_rate String 20.00 提成=收入比率分成比率。指实际获得收益的比率 └ seller_nick String 掌柜旺旺掌柜旺旺 └ adzone_name String 123 推广位管理下的自定义推广位名称 └ pub_share_rate String 100.00 从结算佣金中分得的收益比率 └ seller_shop_title String 店铺名称店铺名称 └ item_category_name String 一级类目商品所属的一级类目名称 └ relation_id Number 2760431474 渠道关系id └ refund_tag Number 0 维权标签，0 含义为非维权 1 含义为维权订单 service_fee_dto_list ServiceFeeDto [] 服务费信息 └ tk_share_role_type Number 122 专项服务费来源，122-渠道 └ share_pre_fee String 1.51 预估专项服务费 └ share_relative_rate String 10.00 专项服务费率 └ share_fee String 1.51 结算专项服务费 └ tk_commission_rate_for_media_platform String 0.00 内容专项服务费率：内容场景专项技术服务费率，内容推广者在内容场景进行推广需要按结算金额支付一定比例给阿里妈妈作为内容场景专项技术服务费，用于提供与内容平台实现产品技术对接等服务。 └ alimama_share_fee String 1.52 技术服务费=结算金额收入比率*技术服务费率。推广者赚取佣金后支付给阿里妈妈的技术服务费用 └ tk_commission_pre_fee_for_media_platform String 0.00 预估内容专项服务费：内容场景专项技术服务费，内容推广者在内容场景进行推广需要支付给阿里妈妈专项的技术服务费用。专项服务费＝付款金额＊专项服务费率。 └ site_id Number 123 媒体管理下的ID，同时也是pid=mm_1_2_3中的“2”这段数字 └ item_price String 148.00 商品单价 └ total_commission_rate String 20.00 佣金比率 └ trade_id String 3234324 买家通过购物车购买的每个商品对应的订单编号，此订单编号并未在淘宝买家后台透出
page_no	Number	1	页码
page_size	Number	20	分页大小（1～100）
position_index	Number	asdasd	点位，预留
has_pre	Boolean	true	是否有前一页，预留
has_next	Boolean	true	是否有下一页，预留

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
OvsTbkOrderDetailsBatchGetRequest req = new OvsTbkOrderDetailsBatchGetRequest();
req.setOrderType("CPS_EFFECT");
req.setBizType("ALIMAMA");
req.setPageNo(1L);
req.setOrderStatus("12");
req.setPageSize(20L);
req.setStartTime("2021-04-03 01:02:04");
req.setEndTime("2021-04-03 01:02:04");
req.setQueryType(4L);
req.setPositionIndex("asddfsd1");
req.setSandbox(0L);
OvsTbkOrderDetailsBatchGetResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

XML示例
JSON示例

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

<ovs_tbk_order_details_batch_get_response>
    <order_list>
        <tbk_order>
            <modified_time>2021-09-08 10:06:18</modified_time>
            <tk_paid_time>2021-09-08 10:06:18</tk_paid_time>
            <item_link>http://item.taobao.com/item.htm?id=595722551104</item_link>
            <alimama_rate>10.00</alimama_rate>
            <adzone_id>123</adzone_id>
            <income_rate>20.00</income_rate>
            <pub_share_pre_fee>15.13</pub_share_pre_fee>
            <subsidy_fee>0.00</subsidy_fee>
            <total_commission_fee>15.13</total_commission_fee>
            <item_img>//img.alicdn.com/tfscom/i1/1081761928/O1CN01X1GZwR1Q74IrqjH59_!!1081761928.jpg</item_img>
            <pub_share_fee>15.13</pub_share_fee>
            <pub_id>123</pub_id>
            <tk_commission_fee_for_media_platform>0.00</tk_commission_fee_for_media_platform>
            <marketing_type>超级红包活动</marketing_type>
            <click_time>2021-08-29 04:25:26</click_time>
            <tb_paid_time>2021-08-29 04:25:58</tb_paid_time>
            <terminal_type>无线</terminal_type>
            <item_id>qwdsafda-1da3d</item_id>
            <alipay_total_price>75.65</alipay_total_price>
            <tk_status>12</tk_status>
            <tk_order_role>2</tk_order_role>
            <unid>1234</unid>
            <item_category_level3_name>女装</item_category_level3_name>
            <tk_create_time>2021-08-29 04:25:43</tk_create_time>
            <item_title>维骨力加钙片 240粒/袋</item_title>
            <tk_earning_time>2021-09-08 10:06:17</tk_earning_time>
            <site_name>媒体</site_name>
            <item_category_level2_name>二级类目</item_category_level2_name>
            <item_num>1</item_num>
            <trade_parent_id>123</trade_parent_id>
            <flow_source>--</flow_source>
            <pay_price>75.65</pay_price>
            <tk_total_rate>20.00</tk_total_rate>
            <seller_nick>掌柜旺旺</seller_nick>
            <adzone_name>123</adzone_name>
            <pub_share_rate>100.00</pub_share_rate>
            <seller_shop_title>店铺名称</seller_shop_title>
            <item_category_name>一级类目</item_category_name>
            <relation_id>2760431474</relation_id>
            <refund_tag>0</refund_tag>
            <service_fee_dto_list>
                <service_fee_dto>
                    <tk_share_role_type>122</tk_share_role_type>
                    <share_pre_fee>1.51</share_pre_fee>
                    <share_relative_rate>10.00</share_relative_rate>
                    <share_fee>1.51</share_fee>
                </service_fee_dto>
            </service_fee_dto_list>
            <tk_commission_rate_for_media_platform>0.00</tk_commission_rate_for_media_platform>
            <alimama_share_fee>1.52</alimama_share_fee>
            <tk_commission_pre_fee_for_media_platform>0.00</tk_commission_pre_fee_for_media_platform>
            <site_id>123</site_id>
            <item_price>148.00</item_price>
            <total_commission_rate>20.00</total_commission_rate>
            <trade_id>3234324</trade_id>
        </tbk_order>
    </order_list>
    <page_no>1</page_no>
    <page_size>20</page_size>
    <position_index>asdasd</position_index>
    <has_pre>true</has_pre>
    <has_next>true</has_next>
</ovs_tbk_order_details_batch_get_response>

{
    "ovs_tbk_order_details_batch_get_response":{
        "order_list":{
            "tbk_order":[
                {
                    "modified_time":"2021-09-08 10:06:18",
                    "tk_paid_time":"2021-09-08 10:06:18",
                    "item_link":"http:\/\/item.taobao.com\/item.htm?id=595722551104",
                    "alimama_rate":"10.00",
                    "adzone_id":123,
                    "income_rate":"20.00",
                    "pub_share_pre_fee":"15.13",
                    "subsidy_fee":"0.00",
                    "total_commission_fee":"15.13",
                    "item_img":"\/\/img.alicdn.com\/tfscom\/i1\/1081761928\/O1CN01X1GZwR1Q74IrqjH59_!!1081761928.jpg",
                    "pub_share_fee":"15.13",
                    "pub_id":123,
                    "tk_commission_fee_for_media_platform":"0.00",
                    "marketing_type":"超级红包活动",
                    "click_time":"2021-08-29 04:25:26",
                    "tb_paid_time":"2021-08-29 04:25:58",
                    "terminal_type":"无线",
                    "item_id":"qwdsafda-1da3d",
                    "alipay_total_price":"75.65",
                    "tk_status":12,
                    "tk_order_role":2,
                    "unid":"1234",
                    "item_category_level3_name":"女装",
                    "tk_create_time":"2021-08-29 04:25:43",
                    "item_title":"维骨力加钙片 240粒\/袋",
                    "tk_earning_time":"2021-09-08 10:06:17",
                    "site_name":"媒体",
                    "item_category_level2_name":"二级类目",
                    "item_num":1,
                    "trade_parent_id":"123",
                    "flow_source":"--",
                    "pay_price":"75.65",
                    "tk_total_rate":"20.00",
                    "seller_nick":"掌柜旺旺",
                    "adzone_name":"123",
                    "pub_share_rate":"100.00",
                    "seller_shop_title":"店铺名称",
                    "item_category_name":"一级类目",
                    "relation_id":2760431474,
                    "refund_tag":0,
                    "service_fee_dto_list":{
                        "service_fee_dto":[
                            {
                                "tk_share_role_type":122,
                                "share_pre_fee":"1.51",
                                "share_relative_rate":"10.00",
                                "share_fee":"1.51"
                            }
                        ]
                    },
                    "tk_commission_rate_for_media_platform":"0.00",
                    "alimama_share_fee":"1.52",
                    "tk_commission_pre_fee_for_media_platform":"0.00",
                    "site_id":123,
                    "item_price":"148.00",
                    "total_commission_rate":"20.00",
                    "trade_id":"3234324"
                }
            ]
        },
        "page_no":1,
        "page_size":20,
        "position_index":asdasd,
        "has_pre":true,
        "has_next":true
    }
}

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>

错误码	错误描述	解决方案

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

开放平台

海外-淘宝客API

taobao.ovs.tbk.order.details.batch.get (订单详情查询)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ