文档中心 > API类目 > 海外-淘宝客API

taobao.ovs.tbk.order.details.get (海外淘宝客-推广者-所有订单查询)

海外淘客订单查询

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
order_type String 可选 CPS_EFFECT
  • 默认值:CPS_EFFECT
  • 订单类型,枚举值。"CPS_EFFECT": CPS效果口径订单;"CPA_THIRD_EFFECT": CPA首购效果订单; 必传
    biz_type String 可选 ALIMAMA
  • 默认值:ALIMAMA
  • 订单业务类型,枚举值。"PANAMA": 巴拿马订单;"ALIMAMA": 阿里妈妈订单
    page_no Number 可选 1
  • 默认值:1
  • 页码,默认1
    order_status String 可选 12 订单状态,不传默认所有状态
    page_size Number 可选 20
  • 默认值:20
  • 页大小,不传默认20
    start_time String 必须 2021-04-03 01:02:04 查询开始时间
    end_time String 必须 2021-04-03 01:02:08 查询结束时间
    query_type Number 可选 4
  • 默认值:4
  • 查询时间类型。准实时订单:1:按照订单淘客创建时间查询,2:按照订单淘客付款时间查询,3:按照订单淘客结算时间查询,4:按照订单更新时间;T+N订单只支持 4: 按照订单更新时间查

    响应参数

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

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    OvsTbkOrderDetailsGetRequest req = new OvsTbkOrderDetailsGetRequest();
    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:08");
    req.setQueryType(4L);
    OvsTbkOrderDetailsGetResponse rsp = client.execute(req);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <ovs_tbk_order_details_get_response>
        <result>
            <order_list>
                <tbk_order_d_t_o>
                    <tk_order_role>2</tk_order_role>
                    <modified_time>2021-09-08 10:06:18</modified_time>
                    <tk_paid_time>2021-08-29 04:26:08</tk_paid_time>
                    <unid>123</unid>
                    <tk_create_time>2021-08-29 04:25:43</tk_create_time>
                    <item_category_level3_name>level3 name</item_category_level3_name>
                    <item_title>维骨力加钙片  240粒/袋</item_title>
                    <item_link>http://item.taobao.com/item.htm?id=595722551104</item_link>
                    <tk_earning_time>2021-09-08 10:06:17</tk_earning_time>
                    <alimama_rate>10.00</alimama_rate>
                    <site_name>name</site_name>
                    <adzone_id>123</adzone_id>
                    <item_category_level2_name>level2 name</item_category_level2_name>
                    <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_num>1</item_num>
                    <trade_parent_id>123</trade_parent_id>
                    <item_img>//img.alicdn.com/tfscom/i1/1081761928/O1CN01X1GZwR1Q74IrqjH59_!!1081761928.jpg</item_img>
                    <pub_share_fee>15.13</pub_share_fee>
                    <flow_source>--</flow_source>
                    <pay_price>75.65</pay_price>
                    <tk_total_rate>20.00</tk_total_rate>
                    <pub_id>123</pub_id>
                    <tk_commission_fee_for_media_platform>0.00</tk_commission_fee_for_media_platform>
                    <seller_nick>医食同源中国</seller_nick>
                    <adzone_name>134</adzone_name>
                    <marketing_type>23</marketing_type>
                    <pub_share_rate>100.00</pub_share_rate>
                    <seller_shop_title>官方直销店</seller_shop_title>
                    <item_category_name>保健食品/膳食营养补充食品</item_category_name>
                    <click_time>2021-08-29 04:25:26</click_time>
                    <relation_id>2760431474</relation_id>
                    <tb_paid_time>2021-08-29 04:25:58</tb_paid_time>
                    <refund_tag>0</refund_tag>
                    <terminal_type>无线</terminal_type>
                    <tk_commission_rate_for_media_platform>0.00</tk_commission_rate_for_media_platform>
                    <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>
                    <item_id>595722551104</item_id>
                    <alipay_total_price>75.65</alipay_total_price>
                    <tk_commission_pre_fee_for_media_platform>0.00</tk_commission_pre_fee_for_media_platform>
                    <alimama_share_fee>1.52</alimama_share_fee>
                    <site_id>123</site_id>
                    <item_price>148.00</item_price>
                    <total_commission_rate>20.00</total_commission_rate>
                    <tk_status>3</tk_status>
                    <trade_id>1234</trade_id>
                </tbk_order_d_t_o>
            </order_list>
        </result>
    </ovs_tbk_order_details_get_response>

    异常示例

    • 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工具

    如何获得此API

    FAQ

    返回
    顶部