文档中心 > API类目 > 酒店API(新)

taobao.xhotel.order.alipayface.update (酒店信用住订单状态更新)

完成对信用住或者面付订单的状态的更新。包含订单状态的确认,入离店状态的更新等等。(不适用于预付订单)

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
tid Number 可选 100100100 淘宝订单号,必填
opt_type Number 必须 1 操作的类型:12.补录确认号,11.多间房确认无房,10.多间房确认有房,8.取消订单(cancel)酒店端发起取消,必须在和买家协商通过的情况下操作,否则有法务风险; 5.买家未入住(noshow),如果该单有担保,会收取买家的担保金额; 3.核实入住(checkIn); 4.核实离店(checkOut); 1.确认无房(直连卖家禁止该操作),2.确认有房(直连卖家禁止该操作)
reason_type Number 可选 1
  • 最大长度:1
  • 无房原因分类:1.无房, 2.价格变动, 3.买家原因, 4.其它原因,opt_type=1时必填
    reason_text String 可选 无房
  • 最大长度:500
  • 无房原因描述:opt_type=1时必填
    out_room_number String 可选 2022 入住房间号
    checkin_date String 可选 2014-12-10
  • 最大长度:10
  • 客人实际入住日期,opt_type=3/4时必填
    checkout_date String 可选 2014-12-13
  • 最大长度:10
  • 客人实际离店日期,opt_type=4时必填
    rooms Number 可选 1 客人实际预定房间数
    out_id String 可选 R12345678
  • 最大长度:100
  • 外部订单号
    tids String 可选 12322,323333 opt_type为10,11启用,多间房订单号列表,逗号间隔
    cancel_type Number 可选 1 opt_type为11启用,多间房订单取消原因类型,逗号间隔
    operator String 可选 小红 opt_type为10,11,12启用,真实操作人
    confirm_code String 可选 1121132 opt_type为12, 订单确认号
    self_checkin Boolean 可选 true 是否自助入住
    sync_to_hotel String 可选 Y 是否把代理直签的订单同步到酒店,Y为同步,N不同步

    响应参数

    名称 类型 示例值 描述
    result String "success" 返回提示信息

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    XhotelOrderAlipayfaceUpdateRequest req = new XhotelOrderAlipayfaceUpdateRequest();
    req.setTid(100100100L);
    req.setOptType(1L);
    req.setReasonType(1L);
    req.setReasonText("无房");
    req.setOutRoomNumber("2022");
    req.setCheckinDate("2014-12-10");
    req.setCheckoutDate("2014-12-13");
    req.setRooms(1L);
    req.setOutId("R12345678");
    req.setTids("12322,323333");
    req.setCancelType(1L);
    req.setOperator("小红");
    req.setConfirmCode("1121132");
    req.setSelfCheckin(true);
    req.setSyncToHotel("Y");
    XhotelOrderAlipayfaceUpdateResponse rsp = client.execute(req, sessionKey);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <xhotel_order_alipayface_update_response>
        <result>&quot;success&quot;</result>
    </xhotel_order_alipayface_update_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:GET_ORDER_IDS_ALL_NULL_ERROR 参数oid,tid不能都为空 淘宝订单号和卖家订单号必须至少传入一个
    isv.order-error:ORDER_STATUS_MISMATCHING 订单当前状态不允许进行该操作 核实订单状态
    isv.order-error:ORDER_NOT_EXIST 未查询到订单数据 检查订单id是否输入正确
    isv.invalid-parameter:ORDER_UPDATE_CHECKINOUTDATE_ERROR 入住时间或离店时间不正确 检查一下checkIn和checkOut是否正确
    isp.remote-service-error 系统错误 联系技术支持跟进
    isv.invalid-parameter:ERROR 参数不正确 参考api文档检查入参
    isv.biz-error:BIZ_ERROR 业务异常 联系技术支持跟进
    isv.order-error:ORDER_CANNOT_CANCEL 当前订单状态禁止取消 不能进行该操作
    isv.order-error:CANNOT_CANCEL_GUARANTEE_ORDER 订单是担保订单,禁止取消 不能进行该操作
    isv.order-error:ORDER_CANNOT_CANCEL_BEFORE_CHECKIN_TIME 还未到最晚到店时间,订单禁止取消 不能进行该操作
    isv.order-error:NOT_SUPPORT_OPT_TYPE 当前订单不支持该操作类型 该接口不支持预付订单操作,请核实一下。同时核实传入的optType是否合理
    isv.order-error:ORDER_CANCEL_ERROR 订单取消失败 联系技术
    isv.invalid-parameter 参数不合法 检查参数
    isv.biz-error 未知业务错误 联系阿里技术支持
    isp.system-error 系统错误 联系阿里技术支持
    isv.order-error:ERROR_XIAOER_CANCEL_ORDER_OPERROR 小二订单取消操作 订单已被小二取消,不能操作

    API工具

    如何获得此API

    FAQ

    返回
    顶部