文档中心 > API类目 > 酒店在线预订API

taobao.xhotel.order.search (酒店产品库订单查询)

酒店产品库订单查询功能,查询90天内的订单

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
order_ids String 可选 12313,45632 酒店订单oids列表,多个oid用英文逗号隔开,一次不超过20个。
order_tids String 可选 123,456 酒店订单tids列表,多个tid用英文逗号隔开,一次不超过20个。oids和tids都传的情况下默认使用tids
created_start Date 必须 2015-01-01 00:00:00 订单创建时间查询起始时间,格式为:yyyy-MM-dd HH:mm:ss
created_end Date 必须 2015-01-11 00:00:00 订单创建时间查询结束时间,格式为:yyyy-MM-dd HH:mm:ss。不能早于created_start或者间隔不能大于30
page_no Number 可选 4
  • 默认值:1
  • 分页页码。取值范围,大于零的整数,默认值1,即返回第一页的数据。页面大小为20
    vendor String 可选 alitrip 系统商标识
    out_oids String 可选 123,456 外部订单号out_oids列表,多个oid用英文逗号隔开,一次不超过20个。
    checkin_date_start Date 可选 2021-07-01 00:00:00 入住时间查询起始时间,格式为:yyyy-MM-dd HH:mm:ss
    checkin_date_end Date 可选 2021-07-03 00:00:00 入住时间查询结束时间,格式为:yyyy-MM-dd HH:mm:ss。不能早于checkin_date_start或者间隔不能大于30
    checkout_date_start Date 可选 2021-07-05 00:00:00 离店时间查询起始时间,格式为:yyyy-MM-dd HH:mm:ss
    checkout_date_end Date 可选 2021-07-06 00:00:00 离店时间查询结束时间,格式为:yyyy-MM-dd HH:mm:ss。不能早于checkout_date_start或者间隔不能大于30
    trade_status String 可选 1,2,3 订单状态(可发多个,逗号隔开)
    direct Boolean 可选 true 订单类型(true为直连,false为非直连)

    响应参数

    名称 类型 示例值 描述
    hotel_orders XHotelOrder [] 订单信息
    • └ hid
    • Number
    • 12345
    • 酒店id
    • └ out_oid
    • String
    • foY798
    • 合作方订单号,最长250个字符
    • └ checkout_date
    • Date
    • 2011-01-29 00:00:00
    • 离店时间
    • guests
    • XOrderGuest []
    • 入住人信息
    • └ name
    • String
    • 张三
    • 入住人姓名
    • └ room_pos
    • Number
    • 2
    • 房间序号
    • └ person_pos
    • Number
    • 1
    • 入住人序号
    • └ rpid
    • Number
    • 1000
    • RatePlan 中的 rpid
    • └ type
    • Number
    • 1
    • 支付类型 可选值 1:预付 5:前台面付
    • └ created
    • Date
    • 2000-01-01 00:00:00
    • 订单创建时间
    • └ oid
    • Number
    • 123456
    • 酒店订单id
    • └ tid
    • Number
    • 123
    • tid
    • └ arrive_late
    • Date
    • 2012-06-12 16:00:00
    • 买家最晚到达时间
    • └ contact_name
    • String
    • 张三
    • 联系人姓名
    • └ checkin_date
    • Date
    • 2011-01-28 00:00:00
    • 入住时间
    • └ nights
    • Number
    • 1
    • 天数
    • └ seller_nick
    • String
    • 我是卖家
    • 卖家淘宝账号
    • └ room_number
    • Number
    • 1
    • 房间数
    • └ payment
    • Number
    • 10000
    • 实付款(分)
    • └ contact_phone
    • String
    • 13312345678
    • 联系人电话
    • └ arrive_early
    • Date
    • 2012-06-12 12:00:00
    • 买家最早到达时间
    • └ pay_time
    • Date
    • 2000-01-01 00:00:00
    • 付款时间
    • └ trade_status
    • String
    • WAIT_BUYER_PAY
    • 交易状态。 WAIT_BUYER_PAY:预订中/等待买家付款, WAIT_SELLER_SEND_GOODS:预订中/等待卖家发货(确认), TRADE_CLOSED:结束/预订失败/交易关闭, TRADE_FINISHED:结束/交易成功, TRADE_NO_CREATE_PAY:结束/预订失败/没有创建支付宝交易, TRADE_CLOSED_BY_TAOBAO:结束/预订失败/预订被卖家关闭, TRADE_SUCCESS:交易中/预订成功/卖家已确认, TRADE_CHECKIN:交易中/预定成功/买家入住, TRADE_CHECKOUT:交易中/预定成功/买家离店, TRADE_SETTLEING:交易中/预定成功/结账中, TRADE_SETTLE_SUCCESS:结束/预定成功/结账成功
    • └ modified
    • Date
    • 2000-01-01 00:00:00
    • 订单修改时间
    • └ buyer_nick
    • String
    • 我是买家
    • 买家淘宝账号
    • └ message
    • String
    • 标准间
    • 买家留言
    • └ rid
    • Number
    • 123456
    • 房型id
    • └ end_time
    • Date
    • 2000-01-01 00:00:00
    • 结束时间
    • └ total_room_price
    • Number
    • 10000
    • 总房价(分)
    • └ gid
    • Number
    • 12345
    • 商品id
    • └ prices
    • Number []
    • [15000,18000,18000]
    • 下单时每间夜的价格(分)
    • └ alipay_trade_no
    • String
    • 2012020105065849123454
    • 支付宝交易号,28位字符
    • └ logistics_status
    • String
    • 1
    • 预付订单使用,1未发货,2已发货,3已收货,4已经退货,8还未创建物流订单
    • └ refund_status
    • String
    • 1
    • 预付订单使用,1买家已经申请退款,等待卖家同意,2卖家已经同意退款,等待买家退货,3买家已经退货,等待卖家确认收货,4退款关闭,5退款成功,6卖家拒绝退款,9没有申请退款
    total_results Number 2 符合条件的结果总数

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    XhotelOrderSearchRequest req = new XhotelOrderSearchRequest();
    req.setOrderIds("12313,45632");
    req.setOrderTids("123,456");
    req.setCreatedStart(StringUtils.parseDateTime("2015-01-01 00:00:00"));
    req.setCreatedEnd(StringUtils.parseDateTime("2015-01-11 00:00:00"));
    req.setPageNo(4L);
    req.setVendor("alitrip");
    req.setOutOids("123,456");
    req.setCheckinDateStart(StringUtils.parseDateTime("2021-07-01 00:00:00"));
    req.setCheckinDateEnd(StringUtils.parseDateTime("2021-07-03 00:00:00"));
    req.setCheckoutDateStart(StringUtils.parseDateTime("2021-07-05 00:00:00"));
    req.setCheckoutDateEnd(StringUtils.parseDateTime("2021-07-06 00:00:00"));
    req.setTradeStatus("1,2,3");
    req.setDirect(true);
    XhotelOrderSearchResponse rsp = client.execute(req, sessionKey);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <xhotel_order_search_response>
        <hotel_orders>
            <x_hotel_order>
                <hid>12345</hid>
                <out_oid>foY798</out_oid>
                <checkout_date>2011-01-29 00:00:00</checkout_date>
                <guests>
                    <x_order_guest>
                        <name>张三</name>
                        <room_pos>2</room_pos>
                        <person_pos>1</person_pos>
                    </x_order_guest>
                </guests>
                <rpid>1000</rpid>
                <type>1</type>
                <created>2000-01-01 00:00:00</created>
                <oid>123456</oid>
                <tid>123</tid>
                <arrive_late>2012-06-12 16:00:00</arrive_late>
                <contact_name>张三</contact_name>
                <checkin_date>2011-01-28 00:00:00</checkin_date>
                <nights>1</nights>
                <seller_nick>我是卖家</seller_nick>
                <room_number>1</room_number>
                <payment>10000</payment>
                <contact_phone>13312345678</contact_phone>
                <arrive_early>2012-06-12 12:00:00</arrive_early>
                <pay_time>2000-01-01 00:00:00</pay_time>
                <trade_status>WAIT_BUYER_PAY</trade_status>
                <modified>2000-01-01 00:00:00</modified>
                <buyer_nick>我是买家</buyer_nick>
                <message>标准间</message>
                <rid>123456</rid>
                <end_time>2000-01-01 00:00:00</end_time>
                <total_room_price>10000</total_room_price>
                <gid>12345</gid>
                <prices>
                    <number>[15000</number>
                    <number>18000</number>
                    <number>18000]</number>
                </prices>
                <alipay_trade_no>2012020105065849123454</alipay_trade_no>
                <logistics_status>1</logistics_status>
                <refund_status>1</refund_status>
            </x_hotel_order>
        </hotel_orders>
        <total_results>2</total_results>
    </xhotel_order_search_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>

    错误码解释

    错误码 错误描述 解决方案
    isv.invalid-parameter:NOTNULL 参数不能为空 参考api文档检查入参
    isv.invalid-parameter:NUM 参数应该是数字 参考api文档检查入参
    isv.invalid-parameter:STRING 参数应该是字符串 参考api文档检查入参
    isv.invalid-parameter:DATE_FORMAT_ERROR 参数日期格式不正确 参考api文档检查入参
    isv.invalid-parameter:RANGE_ERROR 参数只能从指定的可选值中选择 参考api文档检查入参
    isv.invalid-parameter:FORMAT_ERROR 参数格式不正确 参考api文档检查入参
    isv.invalid-parameter:LENGTH_OVERRANGE 参数长度不能超过规定值 参考api文档检查入参
    isv.invalid-parameter:BYTES_OVERRANGE 参数字节数不能超过规定值 参考api文档检查入参
    isv.remote-service:CONVERT_ERROR 转换对象时出错 检查入参或者联系技术支持
    isv.permission-error:NO_PERMISSIONS_ERROR 权限不够、非法访问 检查订单id是否输入有误
    isv.invalid-parameter:ORDER_IDS_TOO_LONG 单次酒店订单查询不超过20条 减少查询数量
    isv.invalid-parameter:ORDER_DATE_ERROR 查询起止时间错误 修改查询日期段
    isv.invalid-parameter:ORDER_DATE_BETWEEN_TOO_LONG 查询起止时间30天内 修改查询日期段
    isp.remote-service-error 系统错误 联系技术支持跟进
    isv.invalid-parameter:ERROR 参数不正确 有可能是同时查询的订单超过20条导致的
    isv.biz-error:BIZ_ERROR 业务异常 联系技术支持跟进
    isv.order-error:ORDER_NOT_EXIST 订单不存在 检查订单号或者输入的时间段是否正常

    API工具

    如何获得此API

    FAQ

    返回
    顶部