ALADIN OTA API(阿里信用住篇)

aladinApi aladinOTAApi

版本号:1.6.0
部门:研发部
岗位:服务端开发人员
姓名:杨松
建立日期:2016-6-7
更新日期:2016-6-17 14：10

POSTMAN 测试接口：https://www.getpostman.com/collections/2971e0c220a3d570580a

DOMAIN 主机域名定义 env

{{ALDOTA}}

TEST =
DEVE = http://aladinsrv.dev.dlhis.com
PREPRO = http://api.aladin.dlhis.com
PRODUCTION

其他业务接口文档连接

基础数据推送，用于初始化OTA信息

API.IT02、推送酒店信息到OTA

• 请求类型：POST
• 请求地址（url）：{{ALDOTA}}/otacdata/hotelpush
• 接口参数：RequestBody json型
  
  • htiId：酒店id
  • otaCode：OTA服务商代码【信用住：QUA，携程：Ctrip等】

{
    "htiId":47,
    "otaCode":"QUA"
}

• 返回值
  
  • 返回值类型：json
  • 返回值结构： 例：

{
  "data": {},
  "err": "HOTELID_NOT_EXISTS",
  "msg": "此HOTELID不存在!",
  "re": {},
  "reErr": {},
  "statusNo": 400,
  "version": "1.6.0"
}

• • 返回值说明：
    
    • 参数：
      
      1. data：
      2. err：错误消息
      3. msg：错误说明 当msg为“success”才表示成功
      4. re：
      5. reErr：
      6. statusNo：响应状态码 只有为200才表示成功
      7. version：版本

API.IT04、推送Rp信息到OTA

• 请求类型：POST
• 请求地址（url）：{{ALDOTA}}/otacdata/rateplan
• 接口参数：RequestBody json型
  
  • rpId：房价计划rpId
  • otaCode：OTA服务商代码【信用住：QUA，携程：Ctrip等】

{
    "rpId":1,
    "otaCode":"QUA"
}

• 返回值
  
  • 返回值类型：json
  • 返回值结构： 例：

{
  "data": {},
  "err": "RATEPLANCODE_IS_NOT_EXISTS",
  "msg": "此RATEPLANCODE不存在!",
  "re": {},
  "reErr": {},
  "statusNo": 400,
  "version": "1.6.0"
}

• • 返回值说明：
    
    • 参数：
      
      1. data：
      2. err：错误消息
      3. msg：错误说明 当msg为“success”才表示成功
      4. re：
      5. reErr：
      6. statusNo：响应状态码 只有为200才表示成功
      7. version：版本

API.IT05、推送Rm信息到OTA

• 请求类型：POST
• 请求地址（url）：{{ALDOTA}}/otacdata/roomtype
• 接口参数：RequestBody json型
  
  • rmiId：房型信息rmiId
  • otaCode：OTA服务商代码【信用住：QUA，携程：Ctrip等】

{
    "rmiId":103,
    "otaCode":"QUA"
}

• 返回值
  
  • 返回值类型：json
  • 返回值结构： 例：

{
  "data": {},
  "err": "RMIID_IS_NOT_EXISTS",
  "msg": "此RMIID不存在!请检查后重试!",
  "re": {},
  "reErr": {},
  "statusNo": 400,
  "version": "1.6.0"
}

• • 返回值说明：
    
    • 参数：
      
      1. data：
      2. err：错误消息
      3. msg：错误说明 当msg为“success”才表示成功
      4. re：
      5. reErr：
      6. statusNo：响应状态码 只有为200才表示成功
      7. version：版本

业务操作接口，对订单状态更新

接口错误代码说明文档

API.DR01、撤销结账

• 请求类型：POST
• 请求地址（url）：{{ALDOTA}}/otabzprocess/cancelpayment
• 接口参数：RequestBody json型

{
    "dogNo": "6XFM",
    "orderId" : 1,
    "cancelReason":"退款理由",
    "remark":"这是退款操作说明",
    "operator":110
}

• 返回值
  
  • 返回值类型：json
  • 返回值结构： 以订单状态值不符与订单ID不存在为例：

{
  "data": {},
  "err": "THE_MSTORDER_STATUS_NOT_MATCH",
  "msg": "订单当前状态值不符,撤销结账操作失败!",
  "re": {},
  "reErr": {},
  "statusNo": 400,
  "version": "1.6.0"
}
{
  "data": {},
  "err": "ORDERID_IS_NOT_EXISTS",
  "msg": "当前本地订单号不存在!",
  "re": {},
  "reErr": {},
  "statusNo": 400,
  "version": "1.6.0"
}

• • 返回值说明：

API.DR02、结账操作

• 请求类型：POST
• 请求地址（url）：{{ALDOTA}}/otabzprocess/payment
• 接口参数：RequestBody json型

{
    "dogNo": "6XFM",
    "orderId" : 1,
    "checkinRmiNo": "1401",
    "otherFee" : 11288,
    "dailyPrice" : {},
    "otherFeeDetail" : {"洗衣费":1288,"水电费":10000},
    "remark":"这是退款说明",
    "operator":110
}

• 返回值
  
  • 返回值类型：json
  • 返回值结构： 以订单状态值不符与订单ID不存在为例：

{
  "data": {},
  "err": "THE_MSTORDER_STATUS_NOT_MATCH",
  "msg": "订单当前状态值不符,结账操作失败!",
  "re": {},
  "reErr": {},
  "statusNo": 400,
  "version": "1.6.0"
}
{
  "data": {},
  "err": "OTHERFEE_NOT_MATCH_OTHERFEEDETAIL",
  "msg": "杂费金额与杂费明细不符!",
  "re": {},
  "reErr": {},
  "statusNo": 400,
  "version": "1.6.0"
}

• • 返回值说明：

API.DR03、业务进度操作

• 请求类型：POST
• 请求地址（url）：{{ALDOTA}}/otabzprocess/operate
• 接口参数：RequestBody json型

{
    "dogNo": "6XFM",
    "orderId": 1,
    "checkinRmiNo": "1401",
    "action": "CHECKIN",
    "remark": "这是操作备注",
    "operator": 110
}

• 返回值
  
  • 返回值类型：json
  • 返回值结构： 以订单状态值不符与订单ID不存在为例：

{
  "data": {},
  "err": "THE_MSTORDER_STATUS_NOT_MATCH",
  "msg": "订单当前状态值不符,入住操作失败!",
  "re": {},
  "reErr": {},
  "statusNo": 400,
  "version": "1.6.0"
}
{
  "data": {},
  "err": "ORDERID_IS_NOT_EXISTS",
  "msg": "当前本地订单号不存在!",
  "re": {},
  "reErr": {},
  "statusNo": 400,
  "version": "1.6.0"
}

• • 返回值说明：

API.DR04、库存上传

• 请求类型：POST
• 请求地址（url）：{{ALDOTA}}/otabzprocess/pushstore
• 接口参数：RequestBody json型

{
    "htiId":"47",
    "otaSrvCode":"QUA",
    "startDay":"2016-6-2",
    "endDay":"2016-8-31"
}

• 返回值
  
  • 返回值类型：json
  • 返回值结构：
    
    • 成功结果

{
  "data": {},
  "err": "nothing",
  "msg": "success",
  "re": {},
  "reErr": {},
  "statusNo": 200,
  "version": "1.6.0"
}

• • • 失败结果：以酒店ID不存在为例

{
  "data": {},
  "err": "HTIID_IS_NOT_EXISTS",
  "msg": "酒店ID不存在!",
  "re": {},
  "reErr": {},
  "statusNo": 400,
  "version": "1.6.0"
}

• • 返回值说明：

API.DE01、更新本地RP退订政策信息

• 请求类型：POST
• 请求地址（url）：{{ALDOTA}}/localdata/rpcancelpolicy
• 接口参数：RequestBody json型

{
    "rpId": 1,
    "otaCode": "QUA",
    "cancelPolicy": "1",
    "timeBefore": "00:00"
}

• 返回值
  
  • 返回值类型：json
  • 返回值结构：
    
    • 成功结果

{
  "data": {},
  "err": "nothing",
  "msg": "success",
  "re": {},
  "reErr": {},
  "statusNo": 200,
  "version": "1.6.0"
}

• • • 失败结果：退订政策和退订时间不匹配为例

{
  "data": {},
  "err": "SOMTHING_ERR",
  "msg": "退订政策类型RPCANCELPOLICY与退订截止时间不匹配",
  "re": {},
  "reErr": {},
  "statusNo": 400,
  "version": "1.6.0"
}

• • 返回值说明：

尾房促销模块

API.PMS01、尾房促销上架接口

应用场景:
PMS信用住酒店用户使用阿拉丁收益模块,获得尾房促销建议,酒店进行尾房促销时调用此接口

• 请求类型：POST
• 请求地址（url）：{{ALDOTA}}/pomotion/commit
• 接口参数：RequestBody json型
• 参数说明

• 请求参数示例:

{
    "otacHotelid": "HD103332",
    "pomotionCount": 1,
    "pomotionPrice": 32500,
    "rmiCode": "BJ",
    "roomName": "景观标准房",
    "stopTime": "2016-08-21 23:00:00"
}

• 返回参数示例:

{
    "resCode": "01a46e219e488f69",
    "statusNo": 200,
    "err": "nothing",
    "msg": "success",
    "actionCode": "",
    "re": {},
    "data": {},
    "reErr": {},
    "version": "1.6.9"
}

• 返回值说明：

API.PMS02、尾房促销下架接口[自动下架调用接口]

应用场景:
此接口仅供自动下架尾房促销任务调度使用,无需手动调用

• 请求类型：POST
• 请求地址（url）：{{ALDOTA}}/pomotion/stop
• 接口参数：RequestBody json型
• 参数说明

• 请求参数示例:

{
    "RpCode": "RP106087",
    "PmsPomotionReq": {
        "otacHotelid": "HD103332",
        "pomotionCount": 1,
        "pomotionPrice": 32500,
        "rmiCode": "BJ",
        "roomName": "景观标准房",
        "stopTime": "2016-08-21 23:00:00"
    }
}

• 返回参数示例:

{
    "resCode": "01a46e219e488f69",
    "statusNo": 200,
    "err": "nothing",
    "msg": "success",
    "actionCode": "",
    "re": {},
    "data": {},
    "reErr": {},
    "version": "1.6.9"
}

• 返回值说明：