注意:以下文档只适用于TOP接口,请谨慎使用!

文档中心 > API类目 > 天猫家装API

taobao.jzfx.orders.query (天猫淘宝家装家居分销订单查询)

天猫淘宝家装家居分销订单查询

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
tc_order_id Number 可选 3438500868015245550 消费者交易单号(采购单下游买家订单id)。 当在代销、寄售交易中,此单号存在。
time_type String 可选 trade_time_type 时间类型: trade_time_type(默认类型,按照采购单创建时间范围查询,推荐按照此时间类型查询) update_time_type(采购单按照更新时间范围查询)
page_size Number 可选 50
  • 默认值:50
  • 每页条数。(每页条数不超过50条)
    page_no Number 可选 1
  • 默认值:1
  • 页码。(大于0的整数。默认为1)
    purchase_order_id Number 可选 1680825885556350977 采购单编号或分销流水号。 当指定此参数后,其他可选参数可以为空
    start_created Date 可选 2000-01-01 00:00:00 起始时间,格式 yyyy-MM-dd HH:mm:ss 支持到秒的查询。若不传时分秒,默认为0时0分0秒。当指定了purchase_order_id或者tc_order_id时,此值可选,否则此参数必传。 结束时间和开始时间的时间间隔不能超过7天,精确到秒。
    end_created Date 可选 2000-01-01 23:59:59 结束时间,格式 yyyy-MM-dd HH:mm:ss 支持到秒的查询。若不传时分秒,默认为0时0分0秒。当指定了purchase_order_id或者tc_order_id时,此值可选,否则此参数必传。 结束时间和开始时间的时间间隔不能超过7天,精确到秒。
    status String 可选 WAIT_BUYER_PAY 交易状态:WAIT_SELLER_SEND_GOODS(等待发货) WAIT_SELLER_SEND_GOODS(待确认收款) WAIT_BUYER_PAY(等待付款) WAIT_BUYER_CONFIRM_GOODS(已发货) TRADE_REFUNDING(退款中) TRADE_FINISHED(交易成功) TRADE_CLOSED(已关闭) TRADE_REFUNDED(已退款)

    响应参数

    名称 类型 示例值 描述
    total_results Number 9999 查询到的采购单记录总数
    purchase_orders TopDpOrderDo [] 采购单及子采购单信息。 返回 PurchaseOrder 包含的字段信息。
    • └ logistics_id
    • String
    • 123123
    • 运单号
    • └ distributor_username
    • String
    • zhangsan
    • 分销商昵称(在来源网站的帐号名)。
    • └ supplier_from
    • String
    • values: taobao
    • 供应商来源网站。 入驻时定义供应商来源的外部系统编码, values: taobao, alibaba
    • └ pay_time
    • Date
    • 2000-01-01 00:00:00
    • 采购单付款时间。格式:yyyy-MM-dd HH:mm:ss
    • └ tc_order_id
    • Number
    • 157026218599994214
    • 消费者主订单ID (经销模式下,不存在该单号)
    • └ memo
    • String
    • 留言。
    • 采购单留言,默认是分销商留言。在代销模式下信息包括消费者(买家)留言和分销商留言信息
    • └ supplier_flag
    • Number
    • 1
    • 供应商备注旗帜vlaue在1-5之间。 非1-5之间,都采用1作为默认。 1:红色 2:黄色 3:绿色 4:蓝色 5:粉红色 供应商角色查询返回
    • └ buyer_payment
    • String
    • 200.07
    • 消费者(买家)支付给分销商的主单的实际总金额。 注意买家购买的商品可能不是全部来自同一供货商,所以此金额不代表供应商销售商品消费者的实付款。请同时参考子单上的相关金额。(精确到2位小数;单位:元。如:200.07,表示:200元7分)
    • └ distributor_from
    • String
    • taobao
    • 建议废弃: 分销商来源网站。 入驻时定义分销商来源的外部系统编码, 目前固定值: taobao
    • └ consign_time
    • Date
    • 2000-01-01 00:00:00
    • 采购单物流发货时间。格式:yyyy-MM-dd HH:mm:ss
    • └ pay_type
    • String
    • ALIPAY_SURETY
    • 支付方式:ALIPAY_SURETY(支付宝担保交易)、ALIPAY_CHAIN(分账交易)、TRANSFER(线下转账)、PREPAY(预存款)、IMMEDIATELY(即时到账)、CASHGOODS(先款后货)、ACCOUNT_PERIOD(账期支付)
    • └ shipping
    • String
    • FAST
    • 物流配送方式,发货后有此数据。 对应的值:FAST(快速)、EMS、ORDINARY(平邮)、SELLER(卖家包邮)
    • └ logistics_company_name
    • String
    • EMS
    • 物流公司名称
    • └ modified
    • Date
    • 2000-01-01 00:00:00
    • 采购单最后修改时间(包括订单状态变更和订单操作)。格式:yyyy-MM-dd HH:mm:ss
    • └ confirm_paid_fee_yuan
    • String
    • 22.22
    • 已执行确认收货的金额,单位:元
    • └ id
    • Number
    • 555
    • 废弃:如果是担保交易此值是TP800的交易单号,其他情况是采购单单号
    • sub_purchase_orders
    • SubOrderDetail []
    • 子订单的详细信息列表
    • └ refund_fee
    • String
    • 12.23
    • 退款金额,单位元。(精确到2位小数;单位:元。如:12.23,表示:12元2角3分)
    • └ discount_fee
    • String
    • 11.11
    • 消费者订单优惠金额,始终为正数
    • └ tc_order_id
    • Number
    • 157026218599994214
    • 消费者订单子订单ID(经销模式下不存在该值)
    • └ num
    • Number
    • 50
    • 产品的采购数量。取值范围:大于零的整数
    • └ order_200_status
    • String
    • PAID_SEND_GOODS
    • 消费者的交易订单状态(代销采购单对应下游200订单状态)。 可选值: WAIT_SELLER_SEND_GOODS(已付款,待发货) WAIT_BUYER_CONFIRM_GOODS(已付款,已发货) TRADE_CLOSED(已退款成功) TRADE_REFUNDING(退款中) TRADE_FINISHED(交易成功) TRADE_CLOSED_BY_TAOBAO(交易关闭)
    • └ buyer_payment
    • String
    • 200.07
    • 买家订单上对应的子单零售金额。 计算公式:消费者订单的成交价 * 购买数量 + 调整金额 - 优惠折扣(精确到2位小数;单位:元。如:200.07,表示:200元7分)
    • └ title
    • String
    • 裙子
    • 采购的产品标题。
    • └ bill_fee
    • String
    • 100.10
    • 发票应开金额。 子单的消费者实付分摊金额。根据买家实际付款去除邮费后,按各个子单(商品)金额比例进行分摊后的金额,仅供开发票时做票面金额参考。
    • └ price
    • String
    • 50
    • 产品的采购价格。(精确到2位小数;单位:元。如:200.07,表示:200元7分)
    • └ tc_discount_fee
    • Number
    • 1000
    • 优惠金额,始终为正数,单位是分,不带小数
    • └ item_outer_id
    • String
    • OUT00001
    • 商品商家编码,供应商发布产品是定义的产品编码
    • └ id
    • Number
    • 5552
    • 建议废弃:只有当担保交易支付时存在,为TP800的订单编号 子采购单id,淘宝交易主键,采购单未付款时为0.(只有支付宝 付款才有这个id,其余付款形式该字段为0)
    • └ sku_id
    • Number
    • 555
    • 分销产品的SKU ID。 当存在时才会有值,建议使用sku_outer_id,sku_properties这两个值
    • └ sku_outer_id
    • String
    • 5555
    • SKU商家编码,供应商发布产品SKU是定义的编码
    • └ fenxiao_id
    • Number
    • 46467999930382
    • 子采购单编号
    • └ created
    • Date
    • 2000-01-01 00:00:00
    • 子单创建时间。格式 yyyy-MM-dd HH:mm:ss 。
    • └ sc_item_id
    • Number
    • 100000000
    • 后端商品id
    • └ tc_adjust_fee
    • Number
    • 1000
    • 商品的卖出金额调整,金额增加时为正数,金额减少时为负数,单位是分,不带小数
    • └ distributor_payment
    • String
    • 200.07
    • 分销商应付金额。 计算公式:num(采购数量)*price(采购价) - 折扣。(精确到2位小数;单位:元。如:200.07,表示:200元7分)
    • └ auction_id
    • Number
    • 100
    • 消费者购买宝贝ID,不存在时为0。 2015年4月15日之前创建的采购单该字段都是0。
    • └ item_id
    • Number
    • 620019999537
    • 分销平台上的产品id
    • └ sku_properties
    • String
    • 颜色:红色
    • SKU属性值。如: 颜色:红色:别名;尺码:L:别名
    • └ auction_sku_id
    • Number
    • 100
    • 消费者购买宝贝SKU ID,不存在时为0。 2015年3月15日之前创建的采购单该字段都是0。
    • └ total_fee
    • String
    • 200.07
    • 分销商应付金额。 计算公式:num(采购数量)*price(采购价) - 折扣。(精确到2位小数;单位:元。如:200.07,表示:200元7分)
    • └ auction_price
    • String
    • 100.10
    • 分销商店铺中宝贝一口价,消费者看见的宝贝价格。单位元 代销场景下存在,此价格不是实付款的价格。
    • └ status
    • String
    • WAIT_BUYER_PAY(等待买家付款)
    • 采购单状态:WAIT_BUYER_PAY(待付款) WAIT_SELLER_SEND_GOODS(待发货) WAIT_BUYER_CONFIRM_GOODS(待收货确认) WAIT_SETTLE(已收货待结算) SETTLE_IN_PROGRESS(结算中) TRADE_FINISHED(交易成功) TRADE_CLOSED(已关闭)
    • └ auction_pict_url
    • String
    • //img.alicdn.com/xxxx
    • 商品主图片URL
    • └ trade_type
    • String
    • AGENT
    • 交易模式(分销方式):AGENT(代销)、DEALER(经销)、INSTEAD_SALE(代售)、CONSIGNMENT(自营寄售)、PLATFORM_CONSIGNMENT(平台寄售)
    • └ fenxiao_id
    • Number
    • 1001
    • 分销采购单号(分销流水号)
    • └ open_buyer_uid
    • String
    • 44544541165
    • 消费者淘宝id被加密后的唯一标识
    • receiver
    • TopReceiverDo
    • 买家详细信息
    • └ zip
    • String
    • 310000
    • 邮政编码
    • └ oaid
    • String
    • xxxx
    • 收件人ID (Open Addressee ID),长度在128个字符之内。
    • └ address
    • String
    • 文一西路969号
    • 收货人的详细地址信息
    • └ mobile_phone
    • String
    • 13812345678
    • 移动电话
    • └ phone
    • String
    • 57188155188
    • 固定电话
    • └ city
    • String
    • 杭州市
    • 收货人的城市
    • └ district
    • String
    • 余杭区
    • 区/县
    • └ name
    • String
    • zhangsan
    • 收货人全名
    • └ state
    • String
    • 浙江省
    • 收货人所在省份
    • └ created
    • Date
    • 2000-01-01 00:00:00
    • 采购单创建时间。格式:yyyy-MM-dd HH:mm:ss
    • └ post_fee
    • String
    • 200.07
    • 采购单邮费。(改价后最新邮费,精确到2位小数;单位:元。如:8.07,表示:8元7分 )
    • └ distributor_payment
    • String
    • 200.07
    • 分销商实付金额。(精确到2位小数;单位:元。如:208.14,表示:208元1角4分 )
    • └ supplier_username
    • String
    • zhangsan
    • 供应商昵称(在来源网站的帐号名)
    • └ total_fee
    • String
    • 200.07
    • 应付采购单总额(不含邮费,精确到2位小数;单位:元。如:200.07,表示:200元7分 ) 计算公式: SUM(子单采购价 * 子单采购数量 - 子单折扣)+ 主单调整金额 - 主单折扣
    • order_messages
    • OrderMessages []
    • 采购单留言列表,如果是代销,包含消费者留言。
    • └ message_time
    • Date
    • 2000-01-01 00:00:00
    • 留言时间
    • └ pic_url
    • String
    • 1
    • 留言时的图片地址
    • └ message_title
    • String
    • 分销商留言
    • 留言标题,例如:分销商留言,供应商留言,买家留言
    • └ message_content
    • String
    • 留言内容
    • 留言内容
    • └ end_time
    • Date
    • 2000-01-01 00:00:00
    • 交易结束时间。 如果交易成功此时间表示交易成功时间,如果交易关闭,此时间表示交易关闭时间。
    • └ status
    • String
    • TRADE_FINISHED(交易成功)
    • 采购单状态:WAIT_BUYER_PAY(待付款) WAIT_SELLER_SEND_GOODS(待发货) WAIT_BUYER_CONFIRM_GOODS(待收货确认) WAIT_SETTLE(已收货待结算) SETTLE_IN_PROGRESS(结算中) TRADE_FINISHED(交易成功) TRADE_CLOSED(已关闭)
    • └ warehouse_type
    • Number
    • 0
    • 0: 商家仓; 1: 鸟仓
    • └ sn_code
    • String
    • 111111
    • 国补sn码值
    • └ sn_tag_value
    • String
    • a_b_c
    • 国补订单sn码标值
    • └ need_imei
    • Boolean
    • true
    • 是否存在imei码
    • └ imei_code
    • String
    • 11111
    • 国补imei码值

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    JzfxOrdersQueryRequest req = new JzfxOrdersQueryRequest();
    req.setTcOrderId(3438500868015245550L);
    req.setTimeType("trade_time_type");
    req.setPageSize(50L);
    req.setPageNo(1L);
    req.setPurchaseOrderId(1680825885556350977L);
    req.setStartCreated(StringUtils.parseDateTime("2000-01-01 00:00:00"));
    req.setEndCreated(StringUtils.parseDateTime("2000-01-01 23:59:59"));
    req.setStatus("WAIT_BUYER_PAY");
    JzfxOrdersQueryResponse rsp = client.execute(req, sessionKey);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <jzfx_orders_query_response>
        <total_results>9999</total_results>
        <purchase_orders>
            <top_dp_order_do>
                <logistics_id>123123</logistics_id>
                <distributor_username>zhangsan</distributor_username>
                <supplier_from>values: taobao</supplier_from>
                <pay_time>2000-01-01 00:00:00</pay_time>
                <tc_order_id>157026218599994214</tc_order_id>
                <memo>留言。</memo>
                <supplier_flag>1</supplier_flag>
                <buyer_payment>200.07</buyer_payment>
                <distributor_from>taobao</distributor_from>
                <consign_time>2000-01-01 00:00:00</consign_time>
                <pay_type>ALIPAY_SURETY</pay_type>
                <shipping>FAST</shipping>
                <logistics_company_name>EMS</logistics_company_name>
                <modified>2000-01-01 00:00:00</modified>
                <confirm_paid_fee_yuan>22.22</confirm_paid_fee_yuan>
                <id>555</id>
                <sub_purchase_orders>
                    <sub_order_detail>
                        <refund_fee>12.23</refund_fee>
                        <discount_fee>11.11</discount_fee>
                        <tc_order_id>157026218599994214</tc_order_id>
                        <num>50</num>
                        <order_200_status>PAID_SEND_GOODS</order_200_status>
                        <buyer_payment>200.07</buyer_payment>
                        <title>裙子</title>
                        <bill_fee>100.10</bill_fee>
                        <price>50</price>
                        <tc_discount_fee>1000</tc_discount_fee>
                        <item_outer_id>OUT00001</item_outer_id>
                        <id>5552</id>
                        <sku_id>555</sku_id>
                        <sku_outer_id>5555</sku_outer_id>
                        <fenxiao_id>46467999930382</fenxiao_id>
                        <created>2000-01-01 00:00:00</created>
                        <sc_item_id>100000000</sc_item_id>
                        <tc_adjust_fee>1000</tc_adjust_fee>
                        <distributor_payment>200.07</distributor_payment>
                        <auction_id>100</auction_id>
                        <item_id>620019999537</item_id>
                        <sku_properties>颜色:红色</sku_properties>
                        <auction_sku_id>100</auction_sku_id>
                        <total_fee>200.07</total_fee>
                        <auction_price>100.10</auction_price>
                        <status>WAIT_BUYER_PAY(等待买家付款)</status>
                        <auction_pict_url>//img.alicdn.com/xxxx</auction_pict_url>
                    </sub_order_detail>
                </sub_purchase_orders>
                <trade_type>AGENT</trade_type>
                <fenxiao_id>1001</fenxiao_id>
                <open_buyer_uid>44544541165</open_buyer_uid>
                <receiver>
                    <zip>310000</zip>
                    <oaid>xxxx</oaid>
                    <address>文一西路969号</address>
                    <mobile_phone>13812345678</mobile_phone>
                    <phone>57188155188</phone>
                    <city>杭州市</city>
                    <district>余杭区</district>
                    <name>zhangsan</name>
                    <state>浙江省</state>
                </receiver>
                <created>2000-01-01 00:00:00</created>
                <post_fee>200.07</post_fee>
                <distributor_payment>200.07</distributor_payment>
                <supplier_username>zhangsan</supplier_username>
                <total_fee>200.07</total_fee>
                <order_messages>
                    <order_messages>
                        <message_time>2000-01-01 00:00:00</message_time>
                        <pic_url>1</pic_url>
                        <message_title>分销商留言</message_title>
                        <message_content>留言内容</message_content>
                    </order_messages>
                </order_messages>
                <end_time>2000-01-01 00:00:00</end_time>
                <status>TRADE_FINISHED(交易成功)</status>
                <warehouse_type>0</warehouse_type>
                <sn_code>111111</sn_code>
                <sn_tag_value>a_b_c</sn_tag_value>
                <need_imei>true</need_imei>
                <imei_code>11111</imei_code>
            </top_dp_order_do>
        </purchase_orders>
    </jzfx_orders_query_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>

    错误码解释

    错误码 错误描述 解决方案
    CHECK:COMMON:CHECK_UNAUTHORIZED 未授权 不调用

    API工具

    如何获得此API

    FAQ

    返回
    顶部