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

taobao.xhotel.order.alipayface.cancelsettle (信用住订单取消结算接口)

信用住订单由于客人为出现等原因,最终取消结算,一定要在结算后2个小时之内调用,否则不会成功。

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
tid Number 特殊可选 100100100
  • 最小值:0
  • 阿里旅行订单号,淘宝订单号或外部订单号二选一必填
    reason String 可选 "价格输入有误"
  • 最大长度:250
  • 取消结账的原因
    out_id String 特殊可选 R12345678
  • 最大长度:100
  • 外部订单号,和tid二选一必填

    响应参数

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

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    XhotelOrderAlipayfaceCancelsettleRequest req = new XhotelOrderAlipayfaceCancelsettleRequest();
    req.setTid(100100100L);
    req.setReason("\"价格输入有误\"");
    req.setOutId("R12345678");
    XhotelOrderAlipayfaceCancelsettleResponse rsp = client.execute(req, sessionKey);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <xhotel_order_alipayface_cancelsettle_response>
        <result>&quot;success&quot;</result>
    </xhotel_order_alipayface_cancelsettle_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_CANNOT_CANCEL_SETTLE 取消结账失败,结账超过两个小时,不允许取消 不允许进行该操作
    isv.order-error:ORDER_NOT_EXIST 未查询到订单数据 检查tid是否输入正确
    isp.remote-service-error 系统错误 联系技术支持跟进
    isv.invalid-parameter:ERROR 参数不正确 参考api文档检查入参
    isv.biz-error:BIZ_ERROR 业务异常 联系技术支持跟进

    API工具

    如何获得此API

    FAQ

    返回
    顶部