接口地址:http://api.tkurl.top/tbk_order
返回格式:json
请求方式:GET
Session获取地址:http://api.tkurl.top/authorize?appkey=
请求示例:http://api.tkurl.top/tbk_order?appkey=&start_time=2018-08-11 12:18:22&span=1200&session=session
请求参数说明:
名称 | 类型 | 是否必须 | 示例值 | 描述 |
---|---|---|---|---|
appkey | String | 必填 | 123456 | appkey |
session | String | 必填 | 授权后,再授权页面获取 。(有效期30天) | |
start_time | String | 必填 | 2018-08-11 12:18:22 | 订单查询开始时间,需进行urlencode编码 |
span | String | 选填 | 60 | 订单查询时间范围,单位:秒,最小60,最大1200,默认60 仅当查询常规订单,及三方订单时需要设置此参数,渠道,及会员订单不需要设置此参数,直接通过设置page_size,page_no 翻页查询数据即可 |
page_no | String | 选填 | 1 | 第几页,默认1,1~100 |
page_size | String | 选填 | 20 | 页大小,默认20,1~100 |
tk_status | String | 选填 | 1 | 订单状态,1: 全部订单,3:订单结算,12:订单付款, 13:订单失效,14:订单成功; 订单查询类型为‘结算时间’时,只能查订单结算状态 |
order_query_type | String | 选填 | create_time | 订单查询类型,创建时间"create_time",或结算时间"settle_time",默认create_time |
order_scene | Number | 选填 | 1 | 订单场景类型,1:常规订单,2:渠道订单,3:会员运营订单,默认为1,通过设置订单场景类型,媒体可以查询指定场景下的订单信息,例如不设置,或者设置为1,表示查询常规订单,常规订单包含淘宝客所有的订单数据,含渠道,及会员运营订单,但不包含3方分成,及维权订单 |
order_count_type | String | 选填 | 1 | 订单数据统计类型,1: 2方订单,2: 3方订单,如果不设置,或者设置为1,表示2方订单 |
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
trade_parent_id | Number | 123 | 淘宝父订单号 |
trade_id | Number | 123 | 淘宝订单号 |
num_iid | Number | 123 | 商品ID |
item_title | String | 女装 | 商品标题 |
item_num | String | 123 | 商品数量 |
price | String | 88.00 | 单价 |
pay_price | String | 85.00 | 实际支付金额 |
seller_nick | String | 我是卖家 | 卖家昵称 |
seller_shop_title | String | XX旗舰店 | 卖家店铺名称 |
commission | String | 5.00 | 推广者获得的收入金额,对应联盟后台报表"预估收入" |
commission_rate | String | 20.00 | 推广者获得的分成比率,对应联盟后台报表"分成比率" |
unid | String | demo | 推广者unid(已废弃) |
create_time | Date | 2015-03-05 10:37:48 | 淘客订单创建时间 |
earning_time | Date | 2015-03-05 10:37:48 | 淘客订单结算时间 |
tk_status | String | 1 | 淘客订单状态,3:订单结算,12:订单付款, 13:订单失效,14:订单成功 |
tk3rd_type | String | 爱淘宝 | 第三方服务来源,没有第三方服务,取值为"--" |
tk3rd_pub_id | String | 123 | 第三方推广者ID |
order_type | int | 天猫 | 订单类型,如天猫,淘宝 |
income_rate | String | 0.008 | 收入比率,卖家设置佣金比率+平台补贴比率 |
pub_share_pre_fee | String | 0.03 | 效果预估,付款金额*(佣金比率+补贴比率)*分成比率 |
subsidy_rate | String | 0.003 | 补贴比率 |
subsidy_type | String | 1 | 补贴类型,天猫:1,聚划算:2,航旅:3,阿里云:4 |
terminal_type | String | 2 | 成交平台,PC:1,无线:2 |
auction_category | String | 办公设备/耗材 | 类目名称 |
site_id | String | 123 | 来源媒体ID |
site_name | String | 返利推广 | 来源媒体名称 |
adzone_id | String | 123 | 广告位ID |
adzone_name | String | 右下广告位 | 广告位名称 |
alipay_total_price | String | 3.6 | 付款金额 |
total_commission_rate | String | 0.005 | 佣金比率 |
total_commission_fee | String | 0.02 | 佣金金额 |
subsidy_fee | String | 0.01 | 补贴金额 |
relation_id | Number | 3223 | 渠道关系ID |
special_id | Number | 1122 | 会员运营id |
click_time | Date | 2015-03-05 10:37:48 | 跟踪时间 |
tk_commission_pre_fee_for_media_platform | String | 1.05 | 预估专项服务费:内容场景专项技术服务费,内容推广者在内容场景进行推广需要支付给阿里妈妈专项的技术服务费用。专项服务费=付款金额*专项服务费率。 |
tk_commission_fee_for_media_platform | String | 1.05 | 结算专项服务费:内容场景专项技术服务费,内容推广者在内容场景进行推广需要支付给阿里妈妈专项的技术服务费用。专项服务费=结算金额*专项服务费率 |
tk_commission_rate_for_media_platform | String | 0.01 | 专项服务费率:内容场景专项技术服务费率,内容推广者在内容场景进行推广需要按结算金额支付一定比例给阿里妈妈作为内容场景专项技术服务费,用于提供与内容平台实现产品技术对接等服务。 |
{ "tbk_sc_order_get_response": { "results": { "n_tbk_order": [{ "adzone_id": "380161111", "adzone_name": "来源媒体名称", "alipay_total_price": "0", "auction_category": "女装", "commission": "0.00", "commission_rate": "1.0000", "create_time": "2018-08-11 03:26:57", "income_rate": "0.1300", "item_num": 1, "item_title": "胖mm加肥加大码女装夏季短袖t恤200斤雪纺显瘦民族风宽松休闲上衣", "num_iid": 567824400146, "order_type": "淘宝", "pay_price": "0.00", "price": "29.00", "pub_share_pre_fee": "0", "seller_nick": "欢子大码女装批发", "seller_shop_title": "欢子大码女装", "site_id": "41670342", "site_name": "来源媒体名称", "subsidy_fee": "0", "subsidy_rate": "0.0000", "subsidy_type": "-1", "terminal_type": "1", "total_commission_fee": "0", "total_commission_rate": "0.1300", "trade_id": 201665183131441111, "trade_parent_id": 201665183131441111 }, { "adzone_id": "380161111", "adzone_name": "来源媒体名称", "alipay_total_price": "0", "auction_category": "女装", "commission": "0.00", "commission_rate": "1.0000", "create_time": "2018-08-11 03:22:02", "income_rate": "0.2000", "item_num": 1, "item_title": "2018夏装新款女装韩版纯色时尚宽松大码胖mm休闲中长款T恤夏天潮", "num_iid": 520397809058, "order_type": "天猫", "pay_price": "0.00", "price": "318.00", "pub_share_pre_fee": "0", "seller_nick": "lfu旗舰店", "seller_shop_title": "lfu旗舰店", "site_id": "41670342", "site_name": "来源媒体名称", "subsidy_fee": "0", "subsidy_rate": "0.0000", "subsidy_type": "-1", "terminal_type": "1", "total_commission_fee": "0", "total_commission_rate": "0.2000", "trade_id": 201462770730441111, "trade_parent_id": 201462770730441111 }] }, "request_id": "4ag55ctuke5h" } }
{ "error_response":{ "sub_msg":"非法参数", "code":50, "sub_code":"isv.invalid-parameter", "msg":"Remote service error" } }
错误码 | 错误描述 | 解决方案 |
---|---|---|
isv.invalid-parameter:tk_status/td> | 输入tk_status非法 | 参考文档 |
isv.invalid-parameter:order_query_type | 输入order_query_type非法 | 参考文档 |
isv.invalid-parameter:span | 输入参数非法 | 参考文档 |
isv.invalid-parameter:start_time | 输入参数非法 | 参考文档 |
602 | 权限到期 | 联系管理员开通 |
603 | 未找到用户或该用户未注册 | 请输入正确的appkey |
604 | 未知参数错误 | 建议加入重试机制 |
404 | 参数传入错误_未知参数 | 检查参数类型是否正确 |