文档中心 > API类目 > 淘宝客API

taobao.tbk.sc.order.details.legacy.get (淘宝客-服务商-所有订单查询(历史版本))

服务商使用。可通过该接口查询推广者账号下对应的推广订单明细。

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
query_type Number 可选 1
  • 默认值:1
  • 查询时间类型,1:按照订单淘客创建时间查询,2:按照订单淘客付款时间查询,3:按照订单淘客结算时间查询,4:按照订单更新时间;
    position_index String 可选 2222_334666 位点,除第一页之外,都需要传递;前端原样返回。
    page_size Number 可选 20
  • 默认值:20
  • 页大小,默认20,1~100
    member_type Number 可选 2 推广者角色类型,2:二方,3:三方,不传,表示所有角色
    tk_status Number 可选 12 淘客订单状态,12-付款,13-关闭,14-确认收货,3-结算成功;不传,表示所有状态
    end_time String 必须 2019-04-23 12:28:22 订单查询结束时间,订单开始时间至订单结束时间,中间时间段日常要求不超过3个小时,但如618、双11、年货节等大促期间预估时间段不可超过20分钟,超过会提示错误,调用时请务必注意时间段的选择,以保证亲能正常调用!
    start_time String 必须 2019-04-05 12:18:22 订单查询开始时间
    jump_type Number 可选 1
  • 默认值:1
  • 跳转类型,当向前或者向后翻页必须提供,-1: 向前翻页,1:向后翻页
    page_no Number 可选 1
  • 默认值:1
  • 第几页,默认1,1~100
    order_scene Number 可选 1
  • 默认值:1
  • 场景订单场景类型,1:常规订单,2:渠道订单,3:会员运营订单,默认为1

    响应参数

    名称 类型 示例值 描述
    data OrderPage OrderPage PublisherOrderDto
    • results
    • PublisherOrderDto []
    • PublisherOrderDto
    • PublisherOrderDto
    • └ tb_paid_time
    • String
    • 2019-04-22 15:15:05
    • 订单在淘宝拍下付款的时间
    • └ tk_paid_time
    • String
    • 2019-04-22 15:15:05
    • 订单付款的时间,该时间同步淘宝,可能会略晚于买家在淘宝的订单创建时间
    • └ pay_price
    • String
    • 9.11
    • 买家确认收货的付款金额(不包含运费金额)
    • └ pub_share_fee
    • String
    • 0
    • 结算预估收入=结算金额*提成。以买家确认收货的付款金额为基数,预估您可能获得的收入。因买家退款、您违规推广等原因,可能与您最终收入不一致。最终收入以月结后您实际收到的为准
    • └ trade_id
    • String
    • 294159887445064307
    • 买家通过购物车购买的每个商品对应的订单编号,此订单编号并未在淘宝买家后台透出
    • └ tk_order_role
    • Number
    • 2
    • 二方:佣金收益的第一归属者; 三方:从其他淘宝客佣金中进行分成的推广者
    • └ tk_earning_time
    • String
    • 2019-04-22 15:15:05
    • 订单确认收货后且商家完成佣金支付的时间
    • └ adzone_id
    • Number
    • 11
    • 推广位管理下的推广位名称对应的ID,同时也是pid=mm_1_2_3中的“3”这段数字
    • └ pub_share_rate
    • String
    • 100
    • 从结算佣金中分得的收益比率
    • └ refund_tag
    • Number
    • 0
    • 维权标签,0 含义为非维权 1 含义为维权订单
    • └ subsidy_rate
    • String
    • 0
    • 平台给与的补贴比率,如天猫、淘宝、聚划算等
    • └ tk_total_rate
    • String
    • 9.99
    • 提成=收入比率*分成比率。指实际获得收益的比率
    • └ item_category_name
    • String
    • 淘小铺
    • 商品所属的根类目,即一级类目的名称
    • └ seller_nick
    • String
    • --
    • 掌柜旺旺
    • └ pub_id
    • Number
    • 98836808
    • 推广者的会员id
    • └ alimama_rate
    • String
    • 0
    • 推广者赚取佣金后支付给阿里妈妈的技术服务费用的比率
    • └ subsidy_type
    • String
    • --
    • 平台出资方,如天猫、淘宝、或聚划算等
    • └ item_img
    • String
    • //img.alicdn.com/bao/uploaded/i1/2200782262419/O1CN01b5qlop1TjwarUo8fo_!!2200782262419.jpg
    • 商品图片
    • └ pub_share_pre_fee
    • String
    • 0
    • 付款预估收入=付款金额*提成。指买家付款金额为基数,预估您可能获得的收入。因买家退款等原因,可能与结算预估收入不一致
    • └ alipay_total_price
    • String
    • 11.22
    • 买家拍下付款的金额(不包含运费金额)
    • └ item_title
    • String
    • tsh_rj_测试请不要拍_阶佣11.1
    • 商品标题
    • └ site_name
    • String
    • 合伙人
    • 媒体管理下的对应ID的自定义名称
    • └ item_num
    • Number
    • 2
    • 商品数量
    • └ subsidy_fee
    • String
    • 0
    • 补贴金额=结算金额*补贴比率
    • └ alimama_share_fee
    • String
    • 0
    • 技术服务费=结算金额*收入比率*技术服务费率。推广者赚取佣金后支付给阿里妈妈的技术服务费用
    • └ trade_parent_id
    • String
    • 294159887445064307
    • 买家在淘宝后台显示的订单编号
    • └ order_type
    • String
    • 如意淘
    • 订单所属平台类型,包括天猫、淘宝、聚划算等
    • └ tk_create_time
    • String
    • 2019-04-22 15:15:05
    • 订单创建的时间,该时间同步淘宝,可能会略晚于买家在淘宝的订单创建时间
    • └ flow_source
    • String
    • --
    • 产品类型
    • └ terminal_type
    • String
    • 无线
    • 成交平台
    • └ click_time
    • String
    • 2019-04-22 15:14:55
    • 通过推广链接达到商品、店铺详情页的点击时间
    • └ tk_status
    • Number
    • 13
    • 已付款:指订单已付款,但还未确认收货 已收货:指订单已确认收货,但商家佣金未支付 已结算:指订单已确认收货,且商家佣金已支付成功 已失效:指订单关闭/订单佣金小于0.01元,订单关闭主要有:1)买家超时未付款; 2)买家付款前,买家/卖家取消了订单;3)订单付款后发起售中退款成功;3:订单结算,12:订单付款, 13:订单失效,14:订单成功
    • └ item_price
    • String
    • 2.1
    • 商品单价
    • └ item_id
    • String
    • 590141576510
    • 商品id
    • └ adzone_name
    • String
    • 爱分享
    • 推广位管理下的自定义推广位名称
    • └ total_commission_rate
    • String
    • 9.99
    • 佣金比率
    • └ item_link
    • String
    • https://detail.tmall.com/item.htm?id=557017471577
    • 商品链接
    • └ site_id
    • Number
    • 45598009
    • 媒体管理下的ID,同时也是pid=mm_1_2_3中的“2”这段数字
    • └ seller_shop_title
    • String
    • --
    • 店铺名称
    • └ income_rate
    • String
    • 9.99
    • 订单结算的佣金比率+平台的补贴比率
    • └ total_commission_fee
    • String
    • 0
    • 佣金金额=结算金额*佣金比率
    • └ 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
    • 内容专项服务费率:内容场景专项技术服务费率,内容推广者在内容场景进行推广需要按结算金额支付一定比例给阿里妈妈作为内容场景专项技术服务费,用于提供与内容平台实现产品技术对接等服务。
    • └ special_id
    • Number
    • 2323
    • 会员运营id
    • └ relation_id
    • Number
    • 2323
    • 渠道关系id
    • └ tk_deposit_time
    • String
    • 2019-09-09 12:01:01
    • 预售时期,用户对预售商品支付定金的付款时间,可能略晚于在淘宝付定金时间
    • └ tb_deposit_time
    • String
    • 2019-09-09 12:01:01
    • 预售时期,用户对预售商品支付定金的付款时间
    • └ deposit_price
    • String
    • 122.22
    • 预售时期,用户对预售商品支付的定金金额
    • └ app_key
    • String
    • 112121
    • 开发者调用api的appkey
    • └ alsc_id
    • String
    • 2332
    • 口碑子订单号
    • └ alsc_pid
    • String
    • 32324
    • 口碑父订单号
    • service_fee_dto_list
    • ServiceFeeDto []
    • ServiceFeeDto
    • 服务费信息
    • └ share_relative_rate
    • String
    • 0.10
    • 专项服务费率
    • └ share_fee
    • String
    • 11.11
    • 结算专项服务费
    • └ share_pre_fee
    • String
    • 11.11
    • 预估专项服务费
    • └ tk_share_role_type
    • Number
    • 122
    • 专项服务费来源,122-渠道
    • └ lx_rid
    • String
    • 13123
    • 激励池对应的rid
    • └ is_lx
    • String
    • 1
    • 订单是否为激励池订单 1,表征是 0,表征否
    • └ marketing_type
    • String
    • 淘礼金
    • 营销类型:该字段中视订单情况有单个或多个值。 例如:淘礼金(自助充值),特价版客户端染色,特价版客户端锁粉,特价版客户端推广。
    • └ modified_time
    • String
    • 2022-05-12 15:35:59
    • 订单更新时间
    • └ has_pre
    • Boolean
    • false
    • 是否还有上一页
    • └ position_index
    • String
    • 1555904214_lGltNdNvSX2|1555917305_lJfPMeFmdt2
    • 位点字段,由调用方原样传递
    • └ has_next
    • Boolean
    • true
    • 是否还有下一页
    • └ page_no
    • Number
    • 1
    • 页码
    • └ page_size
    • Number
    • 11
    • 页大小

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    TbkScOrderDetailsLegacyGetRequest req = new TbkScOrderDetailsLegacyGetRequest();
    req.setQueryType(1L);
    req.setPositionIndex("2222_334666");
    req.setPageSize(20L);
    req.setMemberType(2L);
    req.setTkStatus(12L);
    req.setEndTime("2019-04-23 12:28:22");
    req.setStartTime("2019-04-05 12:18:22");
    req.setJumpType(1L);
    req.setPageNo(1L);
    req.setOrderScene(1L);
    TbkScOrderDetailsLegacyGetResponse rsp = client.execute(req, sessionKey);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <tbk_sc_order_details_legacy_get_response>
        <data>
            <results>
                <publisher_order_dto>
                    <tb_paid_time>2019-04-22 15:15:05</tb_paid_time>
                    <tk_paid_time>2019-04-22 15:15:05</tk_paid_time>
                    <pay_price>9.11</pay_price>
                    <pub_share_fee>0</pub_share_fee>
                    <trade_id>294159887445064307</trade_id>
                    <tk_order_role>2</tk_order_role>
                    <tk_earning_time>2019-04-22 15:15:05</tk_earning_time>
                    <adzone_id>11</adzone_id>
                    <pub_share_rate>100</pub_share_rate>
                    <refund_tag>0</refund_tag>
                    <subsidy_rate>0</subsidy_rate>
                    <tk_total_rate>9.99</tk_total_rate>
                    <item_category_name>淘小铺</item_category_name>
                    <seller_nick>--</seller_nick>
                    <pub_id>98836808</pub_id>
                    <alimama_rate>0</alimama_rate>
                    <subsidy_type>--</subsidy_type>
                    <item_img>//img.alicdn.com/bao/uploaded/i1/2200782262419/O1CN01b5qlop1TjwarUo8fo_!!2200782262419.jpg</item_img>
                    <pub_share_pre_fee>0</pub_share_pre_fee>
                    <alipay_total_price>11.22</alipay_total_price>
                    <item_title>tsh_rj_测试请不要拍_阶佣11.1</item_title>
                    <site_name>合伙人</site_name>
                    <item_num>2</item_num>
                    <subsidy_fee>0</subsidy_fee>
                    <alimama_share_fee>0</alimama_share_fee>
                    <trade_parent_id>294159887445064307</trade_parent_id>
                    <order_type>如意淘</order_type>
                    <tk_create_time>2019-04-22 15:15:05</tk_create_time>
                    <flow_source>--</flow_source>
                    <terminal_type>无线</terminal_type>
                    <click_time>2019-04-22 15:14:55</click_time>
                    <tk_status>13</tk_status>
                    <item_price>2.1</item_price>
                    <item_id>590141576510</item_id>
                    <adzone_name>爱分享</adzone_name>
                    <total_commission_rate>9.99</total_commission_rate>
                    <item_link>https://detail.tmall.com/item.htm?id=557017471577</item_link>
                    <site_id>45598009</site_id>
                    <seller_shop_title>--</seller_shop_title>
                    <income_rate>9.99</income_rate>
                    <total_commission_fee>0</total_commission_fee>
                    <tk_commission_pre_fee_for_media_platform>1.05</tk_commission_pre_fee_for_media_platform>
                    <tk_commission_fee_for_media_platform>1.05</tk_commission_fee_for_media_platform>
                    <tk_commission_rate_for_media_platform>0.01</tk_commission_rate_for_media_platform>
                    <special_id>2323</special_id>
                    <relation_id>2323</relation_id>
                    <tk_deposit_time>2019-09-09 12:01:01</tk_deposit_time>
                    <tb_deposit_time>2019-09-09 12:01:01</tb_deposit_time>
                    <deposit_price>122.22</deposit_price>
                    <app_key>112121</app_key>
                    <alsc_id>2332</alsc_id>
                    <alsc_pid>32324</alsc_pid>
                    <service_fee_dto_list>
                        <service_fee_dto>
                            <share_relative_rate>0.10</share_relative_rate>
                            <share_fee>11.11</share_fee>
                            <share_pre_fee>11.11</share_pre_fee>
                            <tk_share_role_type>122</tk_share_role_type>
                        </service_fee_dto>
                    </service_fee_dto_list>
                    <lx_rid>13123</lx_rid>
                    <is_lx>1</is_lx>
                    <marketing_type>淘礼金</marketing_type>
                    <modified_time>2022-05-12 15:35:59</modified_time>
                </publisher_order_dto>
            </results>
            <has_pre>false</has_pre>
            <position_index>1555904214_lGltNdNvSX2|1555917305_lJfPMeFmdt2</position_index>
            <has_next>true</has_next>
            <page_no>1</page_no>
            <page_size>11</page_size>
        </data>
    </tbk_sc_order_details_legacy_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

    返回
    顶部