# API接口
注:以下接口中$API_HOST对应值
- 线下环境 $API_HOST = https://inf-openapi.apigw.test.meituan.com/api/sqt/openapi
- 线上环境 $API_HOST = https://bep-openapi.meituan.com/api/sqt/openapi
# 2.1 目的地补齐接口
# 接口说明:
名称 | 描述 |
---|---|
功能 | 用于获取与用户输入关键字匹配的目的地列表,目的地可以是城市、行政区、酒店、医院等 |
HTTP方法 | POST |
请求方 | 第三方平台 |
响应方 | 商企通平台 |
url | $API_HOST/hotel/destination |
method | hotel.destination |
# 接口入参:
参数名称 | 参数类型 | 是否必填 | 示例 | 参数描述 |
---|---|---|---|---|
cityCode | String | 是 | "110000" | 城市code 国标码 |
# 返回参数:
参数名称 | 参数类型 | 是否必填 | 示例 | 参数描述 |
---|---|---|---|---|
selectKey | String | 是 | "areaId" | 目的地一级标签 |
desc | String | 是 | "行政区/商圈" | 目的地一级标签的描述 |
selectData | List<Address> | 是 | {"selectData": [{ "addressName": "朝阳区", "addressValue": [{ "areaName": "大望路", "areaCode":1111}, {"areaName": "双井", "areaCode": 1472}] }] } | 目的地一级标签的内容,包含了目的地二级标签、目的地二级标签的内容 |
# Address:
参数名称 | 参数类型 | 是否必填 | 示例 | 参数描述 |
---|---|---|---|---|
addressName | String | 是 | "朝阳区" | 目的地二级标签 |
addressValue | List<Area> | 是 | { "addressValue": [ {"areaName": "大望路", "areaCode": 1111 } ] } | 目的地二级标签的内容,包含了三级标签、三级标签的ID |
# Area:
参数名称 | 参数类型 | 是否必填 | 示例 | 参数描述 |
---|---|---|---|---|
areaName | String | 是 | "大望路" | 目的地三级标签 |
areaCode | Integer | 是 | 1162 | 目的地三级标签的ID |
# 响应示例:
请求
{
"data": [
{
"selectKey":"areaId",
"desc":"行政区/商圈",
"selectData":[
{
"addressName": "朝阳区",
"addressValue": [
{
"areaName": "大望路",
"areaCode": 1111
},
{
"areaName":"双井",
"areaCode":2222
}
]
}
]
},
{
"selectKey":"college",
"desc":"高校",
"selectData":[
{
"addressName": "北方工业大学",
"addressValue": [
{
"areaName":"北方工业大学",
"areaCode":1
}
]
},
{
"addressName": "清华大学",
"addressValue": [
{
"areaName":"清华大学",
"areaCode":2
}
]
}
]
}
]
}
# 2.2 筛选项接口
# 接口说明:
名称 | 描述 |
---|---|
功能 | 用于获取与目的地或关键字关联的筛选项信息,比如选择目的地北京后,可以通过本接口获取北京酒店的房型、类型、品牌等 |
HTTP方法 | POST |
请求方 | 第三方平台 |
响应方 | 商企通 |
url | $API_HOST/hotel/filter |
method | hotel.filter |
# 接口入参:
参数名称 | 参数类型 | 是否必填 | 示例 | 参数描述 |
---|---|---|---|---|
cityCode | String | 是 | "110000" | 城市code 国标码 |
# 返回参数:
参数名称 | 参数类型 | 是否必填 | 示例 | 参数描述 |
---|---|---|---|---|
selectkey | String | 是 | "poi_attr_20022" | 选择模块 |
name | String | 是 | "酒店类型" | 选择模块的名称 |
values | List<SelectData> | 是 | {"values":[{ "filterId": "20244 ", "filterName": "民宿"}, {"filterId": "20036 ", "filterName": "经济型酒店"}]} | 选择模块的内容 |
# SelectData:
参数名称 | 参数类型 | 是否必填 | 示例 | 参数描述 |
---|---|---|---|---|
filterId | String | 是 | "20244" | 模块下的选择项key |
filterName | String | 是 | "民宿" | 模块下的选择项value |
# 响应示例:
{
"data": [
{
"name": "酒店类型",
"selectkey": "poi_attr_20022",
"values": [
{
"filterId": "20244 ",
"filterName": "民宿"
},
{
"filterId": "20036 ",
"filterName": "经济型酒店"
}
]
},
{
"name": "房型",
"selectkey": "poi_attr_20021",
"values": [
{
"filterId": "20031 ",
"filterName": "单人房"
},
{
"filterId": "20032 ",
"filterName": "大床房"
}
]
}
]
}
# 2.3 酒店搜索列表接口
# 接口说明:
名称 | 描述 |
---|---|
功能 | 用于获取符合搜索条件的酒店列表(可搜索180天内的可卖酒店数据)。可以通过指定城市、坐标、价格范围等条件实时搜索、过滤可卖酒店的列表,并排序。 P.S. 同时可以下载静态信息存储到本地,减少每次调用返回的数据包大小,提升性能 |
HTTP方法 | POST |
请求方 | 第三方平台 |
响应方 | 商企通 |
url | $API_HOST/hotel/poi/list |
method | hotel.poi.list |
# 接口入参:
参数名称 | 参数类型 | 是否必填 | 示例 | 参数描述 |
---|---|---|---|---|
q | String | 否 | 全季酒店 | 搜索关键字 |
limit | Integer | 否 | 20 | 每页大小,最大传100,默认20 |
offset | Integer | 否 | 0 | 每偏移量,上次请求返回的条数 |
cityCode | String | 是 | 10000 | 住宿城市code |
startDay | String | 是 | 2021-09-30 | 查询开始日期,字符串格式,yyyy-MM-dd |
endtDay | String | 是 | 2021-10-30 | 查询结束日期,字符串格式,yyyy-MM-dd |
minimumPrice | Integer | 否 | 0 | 最低价格,默认为0 |
maximumPrice | Integer | 否 | 9999900 | 最高价格,默认为9999900 |
myPos | String | 否 | 22.666814,122.666814 | 用户当前经纬对,维度在前经度在后,使用英文逗号隔开字符串 |
userIp | String | 是 | 127.0.0.1 | 当前访问ip,IpV4格式 |
sort | String | 否 | smart | 排序规则,默认为smart,详见附录 |
filter | Map<String,List<Integer>> | 否 | { "poi_attr_20022":[20038,142435], "poi_attr_20021":[20032] } | 筛选项集合 筛选项接口返回的selectKey及对应value |
destination | Destination | 否 | 目的地 | |
tmcTagType | List<Integer> | 否 | [3] | 筛选标签 |
# destination字段说明:
参数名称 | 参数类型 | 是否必填 | 示例 | 参数描述 |
---|---|---|---|---|
selectKey | String | 是 | college | 目的地类型 |
valueId | Integer | 是 | 715 | 目的地id |
# 返回参数:
参数名称 | 参数类型 | 是否必填 | 示例 | 参数描述 |
---|---|---|---|---|
count | Integer | 是 | 20 | 结果总数 |
offset | Integer | 是 | 0 | 页数 |
searchresult | List<SearchPoi> | 否 | 搜索结果列表 | |
recommend | List<SearchPoi> | 否 | 结果为空推荐列表 |
# SearchPoi:
参数名称 | 参数类型 | 是否必填 | 示例 | 参数描述 |
---|---|---|---|---|
historySaleCount | string | 非必须 | 5000+人消费 | 历史销售量 |
frontImg | String | 非必须 | http://p1.meituan.net/240.0/tdchoteldark/b21baf82fd47315b95658c296fa9e1375010826.jpg | 酒店首图url |
addr | string | 非必须 | 深圳北站清湖地铁站 | 地址 |
poiId | Long | 非必须 | 12345 | 酒店id |
areaName | string | 非必须 | 深圳北站 | 商圈名称 |
name | string | 非必须 | 麗枫酒店(深圳北站清湖地铁站店) | 酒店名称 |
lat | String | 非必须 | 22.666814 | 纬度 |
lng | String | 非必须 | 122.666814 | 经度 |
lowestPrice | Integer | 非必须 | 82800 | 最低价格 |
hotelStar | string | 非必须 | 高档型 | 酒店星级 |
posdescr | string | 非必须 | 近龙华汽车站 · 深圳北站,龙华汽车站附近 | 地址描述 |
brandId | Integer | 非必须 | 131980 | 品牌id |
poiLastOrderTime | string | 非必须 | 3小时前有人预订 | 最近售卖时间 |
scoreIntro | string | 非必须 | 5.0分 很好 | poi评分信息 |
priceType | Integer | 非必须 | 1 | 价格类型:1:表示正常最低价 -1:表示暂无报价 |
hotelAppointmentExtType | Integer | 必须 | 2 | 是否满房 0 满房 2 有房 |
tmcHotelType | Integer | 非必须 | 1 | 酒店类型 0非协议酒店 1协议酒店 |
memberLevel | integer | 非必须 | 1 | 会员等级 |
lowerLimit | integer | 非必须 | 95 | 折扣 |
# 响应示例:
{
"count":20,
"offset":0,
"recommend":[],
"searchresult":[{
"historySaleCount": "5000+人消费",
"frontImg": "http://p1.meituan.net/400.0/tdchoteldark/b21baf82fd47315b95658c296fa9e1375010826.jpg",
"addr": "龙华区三联路与清龙路交叉口兴万和商业中心旁",
"poiid": 73586499,
"areaName": "深圳北站",
"name": "麗枫酒店(深圳北站清湖地铁站店)",
"lat": 22.666814,
"lng": 114.03503,
"lowestPrice": 28200,
"hotelStar": "高档型",
"posdescr": "近龙华汽车站 · 深圳北站,龙华汽车站附近",
"brandId": 1936490,
"poiLastOrderTime": "3小时前有人预订",
"scoreIntro": "5.0分 很好",
"hotelAppointmentExtType":2,
"priceType": 1,
"originalPrice": 293,
"isCooperated": 1,
"commentsCountDesc": "2979条评论",
"tmcHotelType": 1,
"memberLevel": 1,
"lowerLimit":95
}]
}
# 2.4 酒店详情接口
# 接口说明:
名称 | 描述 |
---|---|
功能 | 本接口用于获取酒店的静态信息(酒店简介、图片等) |
HTTP方法 | POST |
请求方 | 第三方平台 |
响应方 | 商企通 |
url | $API_HOST/hotel/detail |
method | hotel.detail |
# 接口入参:
参数名称 | 参数类型 | 是否必填 | 示例 | 参数描述 |
---|---|---|---|---|
checkinTime | String | 是 | 2020-09-04 | 入住时间,yyyy-MM-dd型字符串 |
checkoutTime | String | 是 | 2020-09-07 | 离店时间,yyyy-MM-dd型字符串 |
poiId | Long | 是 | 117714762 | 酒店ID |
# 返回参数:
参数名称 | 参数类型 | 是否必填 | 示例 | 参数描述 |
---|---|---|---|---|
name | String | 是 | 南京南站美居酒店 | 酒店名称 |
address | String | 否 | 江宁区天元西路199号 | 酒店地址 |
areaName | String | 否 | 江宁开发区 | 区域名称 |
fullAreaName | String | 否 | 南京 天元西路199号 | 地址全称 |
avgScore | String | 否 | 5.0 | 评分 |
hotelStar | String | 否 | 豪华型 | 酒店类型(星级) |
frontImg | String | 否 | http://p0.meituan.net/440.0/tdchotel/9e3edaed1b6ff8b44df5b5675026c10a79942.jpg | 酒店展示图 |
phone | String | 否 | 025-86189555 | 联系方式 |
phoneInfo | List<PhoneInfo> | 否 | [{ "phone":"025-66669266", "name":"酒店电话" }] | 酒店联系方式列表 |
poiAttrTagList | List<String> | 否 | ["近地铁", "有湖景房"] | 酒店标签类型 |
introduction | String | 否 | 本酒店环境优美,温馨舒适,欢迎入住! | 介绍 |
hotelIntroInfo | List<HotelIntroInfo> | 是 | [{ "attrValue":"2020年", "attrDesc":"开业时间" },{ "attrValue":"2020年", "attrDesc":"装修时间" },{ "attrValue":"5层", "attrDesc":"楼层高度" },{ "attrValue":"116间", "attrDesc":"客房总量" }] | 酒店基本信息 |
serviceIconsInfo | List<ServiceIconsInfo> | 是 | [{ "imgUrl":"http://p0.meituan.net/codeman/0e59ed6fea38fea5beaf4e9719950b1f1869.png", "attrDesc":"无线上网" },{ "imgUrl": "http://p1.meituan.net/codeman/aec15480c0dae9a1f7ab12aa68737c422029.png", "attrDesc":"免费停车" }] | 可提供的服务 |
imageInfo | List<ImageInfo> | 是 | [{ "imgs":[{ "urls":[ "https://p0.meituan.net/400.0/tdchoteldark/6585110463be8ea41647eb9877d021b85812516.jpg"], "imgDesc":"院子" },{ "urls":[ "https://p0.meituan.net/400.0/tdchoteldark/265deeca733018c7101559ad6ce5c4eb7914874.jpg", "https://p1.meituan.net/400.0/tdchotel/552eb6ffdf6f113aa25ce631fb80aeeb503760.jpg"], "imgDesc":"外观" }], "typeName":"外观" },{ "imgs":[{ "urls":["https://p0.meituan.net/400.0/tdchoteldark/7f6451a4e7533ad8849d4e69f3e119061937855.jpg", "https://p0.meituan.net/400.0/tdchotel/c2b354a8aad9f6d3e4f7f09d920c80ac268410.jpg"], "imgDesc":"大厅" }], "typeName":"大厅" }] | 酒店图片列表 |
# PhoneInfo:
参数名称 | 参数类型 | 是否必填 | 示例 | 参数描述 |
---|---|---|---|---|
phone | String | 是 | 025-66669266 | 酒店联系方式 |
name | String | 否 | 酒店电话 | 联系方式描述 |
# HotelIntroInfo:
参数名称 | 参数类型 | 是否必填 | 示例 | 参数描述 |
---|---|---|---|---|
attrValue | String | 是 | 2020年 | 酒店信息内容 |
attrDesc | String | 是 | 开业时间 | 酒店信息描述 |
# ServiceIconsInfo
参数名称 | 参数类型 | 是否必填 | 示例 | 参数描述 |
---|---|---|---|---|
imgUrl | String | 是 | http://p0.meituan.net/codeman/0e59ed6fea38fea5beaf4e9719950b1f1869.png | 酒店服务图标 |
attrDesc | String | 是 | 无线上网 | 酒店服务内容 |
# ImageInfo
参数名称 | 参数类型 | 是否必填 | 示例 | 参数描述 |
---|---|---|---|---|
imgs | List<Img> | 是 | [{ "urls":[ "https://p0.meituan.net/400.0/tdchoteldark/6585110463be8ea41647eb9877d021b85812516.jpg"], "imgDesc":"院子"},{ "urls":[ "https://p0.meituan.net/400.0/tdchoteldark/265deeca733018c7101559ad6ce5c4eb7914874.jpg", "https://p1.meituan.net/400.0/tdchotel/552eb6ffdf6f113aa25ce631fb80aeeb503760.jpg"], "imgDesc":"外观" }] | 图片列表 |
typeName | String | 是 | 外观 | 图片类型描述 |
# Img
参数名称 | 参数类型 | 是否必填 | 示例 | 参数描述 |
---|---|---|---|---|
urls | List<String> | 是 | ["https://p0.meituan.net/400.0/tdchoteldark/265deeca733018c7101559ad6ce5c4eb7914874.jpg", "https://p1.meituan.net/400.0/tdchotel/552eb6ffdf6f113aa25ce631fb80aeeb503760.jpg"] | 酒店信息内容 |
attrDesc | imgDesc | 是 | 开业时间 | 图片描述 |
# 响应示例:
{
"name":"南京南站美居酒店",
"address":"江宁区天元西路199号",
"areaName":"江宁开发区",
"fullAreaName":"南京 天元西路199号",
"avgScore":"5.0",
"hotelStar":"豪华型",
"phone":"025-86189555",
"phoneInfo":[
{
"phone":"025-66669266",
"name":"酒店电话"
}
],
"poiAttrTagList":[
"近地铁",
"有湖景房"
],
"introduction":"本酒店环境优美,温馨舒适,欢迎入住!",
"hotelIntroInfo":[
{
"attrValue":"2020年",
"attrDesc":"开业时间"
},
{
"attrValue":"2020年",
"attrDesc":"装修时间"
},
{
"attrValue":"5层",
"attrDesc":"楼层高度"
},
{
"attrValue":"116间",
"attrDesc":"客房总量"
}
],
"serviceIconsInfo":[
{
"imgUrl":"http://p0.meituan.net/codeman/0e59ed6fea38fea5beaf4e9719950b1f1869.png",
"attrDesc":"无线上网"
},
{
"imgUrl":"http://p1.meituan.net/codeman/aec15480c0dae9a1f7ab12aa68737c422029.png",
"attrDesc":"免费停车"
}
],
"imageInfo":[
{
"imgs":[
{
"urls":[
"https://p0.meituan.net/400.0/tdchoteldark/6585110463be8ea41647eb9877d021b85812516.jpg"
],
"imgDesc":"院子"
},
{
"urls":[
"https://p0.meituan.net/400.0/tdchoteldark/265deeca733018c7101559ad6ce5c4eb7914874.jpg",
"https://p1.meituan.net/400.0/tdchotel/552eb6ffdf6f113aa25ce631fb80aeeb503760.jpg"
],
"imgDesc":"外观"
}
],
"typeName":"外观"
},
{
"imgs":[
{
"urls":[
"https://p0.meituan.net/400.0/tdchoteldark/7f6451a4e7533ad8849d4e69f3e119061937855.jpg",
"https://p0.meituan.net/400.0/tdchotel/c2b354a8aad9f6d3e4f7f09d920c80ac268410.jpg"
],
"imgDesc":"大厅"
}
],
"typeName":"大厅"
}
]
}
# 2.5 产品详情接口
# 接口说明:
名称 | 描述 |
---|---|
功能 | 本接口用于获取酒店房型信息(、房型简介、图片等),产品动态信息(库存、价格、早餐政策、预订规则、取消规则等) |
HTTP方法 | POST |
请求方 | 第三方平台 |
响应方 | 商企通 |
url | $API_HOST/hotel/room/detail |
method | hotel.room.detail |
# 接口入参:
参数名称 | 参数类型 | 是否必填 | 示例 | 参数描述 |
---|---|---|---|---|
startTime | String | 是 | 2020-09-04 | 入住时间,yyyy-MM-dd型字符串 |
endTime | String | 是 | 2020-09-07 | 离店时间,yyyy-MM-dd型字符串 |
poiId | Long | 是 | 117714762 | 酒店ID |
# 返回参数:
参数名称 | 参数类型 | 是否必填 | 示例 | 参数描述 |
---|---|---|---|---|
roomList | List<Room> | 是 | 房型信息列表 | |
goodsList | List<Goods> | 是 | 产品信息列表 |
# Room:
参数名称 | 参数类型 | 是否必填 | 示例 | 参数描述 |
---|---|---|---|---|
RoomId | Long | 是 | 123 | 房型id |
RoomName | String | 是 | 大床房 | 房型名称 |
oomBaseInfos | Map<String,String> | 是 | { 上网:WIFI, 卫浴:独立 } | 房型基本信息 |
roomPhotos | List<String> | 是 | ["http://p0.meituan.net/400.0/tdchotel/446d4f2cae2f177bdb20c2c3c6fe19171510889.jpg"] | 房型图片列表 |
# Goods:
参数名称 | 参数类型 | 是否必填 | 示例 | 参数描述 |
---|---|---|---|---|
roomId | Long | 是 | 1 | 房型id |
goodsId | Long | 是 | 123 | 产品id |
goodsName | String | 是 | 大床房 | 产品名称 |
goodsPrice | List<Price> | 是 | 价格日历 | |
goodsStatus | Integer | 是 | 0 | 产品状态 0:满房 1:可定 2:不可定 3:不展示 |
breakfastInfo | List<BreakfastInfo> | 是 | 早餐信息 | |
notNeedInvoice | Integer | 是 | 0 | 是否无需取票 0需要 1无需 |
isAgreementGoods | Integer | 是 | 0 | 是否员工协议价 0非协议价 1协议价 |
cancelRule | tmc消化转换为一个后返回给客户 | CancelRule | 否 | 取消规则 |
needIdentityCard | Integer | 否 | 0 | 是否需要身份证 1:需要,0:不需要 |
# BreakfastInfo
参数名称 | 参数类型 | 是否必填 | 示例 | 参数描述 |
---|---|---|---|---|
breakfastType | Integer | 是 | 1 | 是否含早 0不含早,1含早 |
breakfastNum | Integer | 否 | 2 | 早餐份数 |
inStartDate | Integer | 是 | 2019-02-09 | 早餐规则生效开始日期,0表示默认生效规则;字符串格式,yyyy-MM-dd,表示该规则2019年2月9号开始生效 |
inEndDate | String | 是 | 2019-02-10 | 早餐规则生效结束日期,0表示默认生效规则;字符串格式,yyyy-MM-dd,表示该规则2019年2月10号结束 |
# CancelRule:
参数名称 | 参数类型 | 是否必填 | 示例 | 参数描述 |
---|---|---|---|---|
cancelType | Integer | 是 | 1 | 取消规则: 0 不可取消 1 可以取消 |
aheadCancelDays | Integer | 否 | 0 | 提前取消天数,aheadCancelDays=0表示入住当日取消。 |
deductType | Integer | 否 | 0 | 提前取消时间类型: 0 时间 1 时间量 |
aheadCancelHours | String | 否 | 18:00:00 | 提前取消的时间值或时间量值 deductType=0 格式为"HH:mm:ss", 例如: deductType=0,aheadCancelDays=0,aheadCancelHours="18:00:00",表示入住日18:00前可以取消; deductType=1 格式为"数字", 例如: deductType=1,aheadCancelDays=0,aheadCancelHours=4表示入住日20:00前可以取消(提前4小时即24 - 4 = 20:00点)。 |
# Price:
参数名称 | 参数类型 | 是否必填 | 示例 | 参数描述 |
---|---|---|---|---|
originalPrice | Integer | 是 | 10000 | 原价 |
salePrice | Integer | 是 | 8000 | 售价 |
disCountPrice | Integer | 是 | 2000 | 优惠金额 |
date | String | 是 | 2021-03-23 | 价格日期时间,格式为yyyy-MM-dd |
# 响应示例:
{
"roomList": [
{
"roomId": 1,
"roomName": "大床房",
"roomStatus": 0,
"roomStatusDesc": "满房",
"roomBaseInfos": {
"卫浴": "独立",
"上网": "wifi"
},
"roomPhotos": []
}
],
"goodsList": [
{
"roomId": 1,
"goodsId": 6370427,
"goodsName": "标准双人房",
"goodsStatus": 1,
"breakfast": [
{
"breakfastType": 1,
"breakfastNum": 2
}
],
"cancelRule": {
"cancelType": 1,
"aheadCancelDays": 0,
"deductType": 0,
"aheadCancelHours": "18:00:00"
},
"priceModels": [
{
"date": "2021-03-23",
"salePrice": 70000,
"subPrice": 3500,
"subRatio": 500,
"dayType": 0
}
],
"notNeedInvoice": 0,
"isAgreementGoods": 0,
"UsageRuleDes": [
"直接消费,无需美团券,携带所有入住人的有效身份证办理入住,入住必须按照一人一证",
"请在14:00之后入住并于次日13:00之前退房;如需提前入住或延时退房,请咨询商家",
"入住需要押金,金额以前台为准",
"下单后,您可以在订单详情页预约酒店开发票,退房时直接在前台领取,节省您宝贵的时间"
]
}
]
}
# 2.6 预订前校验接口
# 接口说明:
名称 | 描述 |
---|---|
功能 | 下单前用户进入填写订单页,调用此接口进行是否可预订校验、库存校验,校验成功时会返回最新价格。 |
HTTP方法 | POST |
请求方 | 第三方平台 |
响应方 | 商企通 |
url | $API_HOST/hotel/order/check |
method | hotel.order.check |
# 接口入参:
参数名称 | 参数类型 | 是否必填 | 示例 | 参数描述 |
---|---|---|---|---|
checkinTime | String | 是 | 2020-09-04 | 入住时间,yyyy-MM-dd型字符串 |
checkoutTime | String | 是 | 2020-09-07 | 离店时间,yyyy-MM-dd型字符串 |
poiId | Long | 是 | 117714762 | 酒店ID |
goodsId | Long | 是 | 78203421 | 产品ID |
roomNum | Integer | 是 | 3 | 预订间数 |
totalPrice | Integer | 是 | 120000 | 订单总价(单位:分) |
# 返回参数:
参数名称 | 参数类型 | 是否必填 | 示例 | 参数描述 |
---|---|---|---|---|
code | Integer | 是 | 0 | 校验结果码 0 校验成功 1 校验失败 2 产品变价 |
desc | String | 是 | 校验成功 | 校验失败原因描述 |
priceModels | List<PriceModels> | 否 | [{date:"2021-03-01",salePrice:20000 }] | 最新价格信息列表 |
remainRoomNum | Integer | 否 | 2 | 库存 |
# PriceModels
参数名称 | 参数类型 | 是否必填 | 示例 | 参数描述 |
---|---|---|---|---|
date | String | 是 | 2021-03-01 | 日期 |
salePrice | Integer | 是 | 20000 | 金额(单位:分) |
# 响应示例:
{
"code":0,
"desc":"校验成功",
"priceModels":[
{
"date":"2021-03-01",
"salePrice":20000
}
],
"remainRoomNum":1
}
# 2.7 生单接口
# 接口说明:
名称 | 描述 |
---|---|
功能 | 用户提交下单请求生成订单,并返回用户 |
HTTP方法 | POST |
请求方 | 第三方平台 |
响应方 | 商企通 |
url | $API_HOST/hotel/order/booking |
method | hotel.order.booking |
# 接口入参:
参数名称 | 参数类型 | 是否必填 | 示例 | 参数描述 |
---|---|---|---|---|
checkinTime | String | 是 | 2020-09-04 | 入住时间,yyyy-MM-dd型字符串 |
checkoutTime | String | 是 | 2020-09-07 | 离店时间,yyyy-MM-dd型字符串 |
poiId | Long | 是 | 117714762 | 酒店ID |
goodsId | Long | 是 | 78203421 | 产品ID |
roomNum | Integer | 是 | 3 | 预订间数 |
totalPrice | Integer | 是 | 120000 | 订单总价(单位:分) |
thirdOrderId | String | 是 | 23958274352 | 合作方订单号 |
bookInfoList | List<BookInfo> | 是 | [{ "roomIndex":0, "personInfos":[{ "cardNum":"110000199901010000", "cardType":0, "uniqueNo":"123", "name":"张某" },{ "cardNum":"110000199901010001", "cardType":0, "uniqueNo":"124", "name":"李某" }]},{ "roomIndex":1, "personInfos":[{ "cardNum":"110000199901010002", "cardType":0, "uniqueNo":"125", "name":"赵某" }] }] | 入住人信息列表 当产品需要传递身份证号时身份证号必传 一间房最多住2人 房间数应等于预订间数 |
contactName | String | 是 | 李某 | 联系人姓名 |
contactPhone | String | 是 | 15212312345 | 联系人电话号码 |
invoiceTitle | String | 否 | 北京xx科技有限公司 | 发票抬头 |
###BookInfo
参数名称 | 参数类型 | 是否必填 | 示例 | 参数描述 |
---|---|---|---|---|
roomIndex | Integer | 是 | 0 | 日期 |
personInfos | List<PersonInfo> | 是 | [{ "cardNum":"110000199901010000", "cardType":0, "uniqueNo":"124", "name":"张某" },{ "cardNum":"110000199901010001", "cardType":0, "uniqueNo":"124", "name":"李某" }] | 入住人信息 |
###PersonInfo
参数名称 | 参数类型 | 是否必填 | 示例 | 参数描述 |
---|---|---|---|---|
cardNum | String | 是 | 110000199901010000 | 证件号 |
name | String | 是 | 张某 | 入住人姓名 |
cardType | Integer | 是 | 0 | 证件类型 0 身份证 1 护照 |
uniqueNo | String | 是 | 15200012345 | 唯一识别号 |
# 返回参数:
参数名称 | 参数类型 | 是否必填 | 示例 | 参数描述 |
---|---|---|---|---|
code | Integer | 是 | 0 | 状态码 0 创建成功 1 创建失败 2 身份证未填写或格式不正确 |
desc | String | 是 | 创建成功 | 校验失败原因描述 |
orderId | String | 是 | 783249232 | 商企通酒店订单号 |
sqtBizOrderId | String | 是 | 5679530459252902 | 商企通订单ID |
payTradeNo | String | 是 | 2353577456768 | 支付序列号 |
# 响应示例:
{
"code":0,
"desc":"创建成功",
"orderId":"783249232",
"sqtBizOrderId":"3562233463567"
}
# 2.8 支付预订接口
# 接口说明:
名称 | 描述 |
---|---|
功能 | 调商企通收银台API完成企业账户扣款,并且发起预订 |
HTTP方法 | POST |
请求方 | 第三方平台 |
响应方 | 商企通 |
url | $API_HOST/hotel/order/pay |
method | hotel.pay.order |
# 接口入参:
参数名称 | 参数类型 | 是否必填 | 示例 | 参数描述 |
---|---|---|---|---|
orderId | String | 是 | 123456 | 商企通酒店订单id |
sqtBizOrderId | String | 是 | 123456 | 商企通订单ID |
payTradeNo | String | 是 | 1234567 | 支付序列号 |
# 返回参数:
参数名称 | 参数类型 | 是否必填 | 示例 | 参数描述 |
---|---|---|---|---|
code | Integer | 是 | 0 | 下单结果码 详见附录 |
desc | String | 是 | 下单成功 | 状态描述 |
mtOrderId | String | 否 | 123456 | 美团酒店订单id (目前为空,需要收到预订成功或预订失败的订单状态变更推送后调用订单查询接口获取) |
# 响应示例:
{
"code":0,
"desc":"下单成功",
"mtOrderId":""
}
# 2.9 订单取消接口
# 接口说明:
名称 | 描述 |
---|---|
功能 | 取消订单,并发起退款 |
HTTP方法 | POST |
请求方 | 第三方平台 |
响应方 | 商企通 |
url | $API_HOST/hotel/hotel/order/cancel |
method | hotel.order.cancel |
# 接口入参:
参数名称 | 参数类型 | 是否必填 | 示例 | 参数描述 |
---|---|---|---|---|
orderId | String | 是 | 123456 | 商企通酒店订单id |
sqtBizOrderId | String | 是 | 123456 | 商企通订单ID |
# 返回参数:
参数名称 | 参数类型 | 是否必填 | 示例 | 参数描述 |
---|---|---|---|---|
code | Integer | 是 | 0 | 取消结果码,详见附录 |
desc | String | 是 | 取消成功 | 结果描述 |
# 响应示例:
{
"code":0,
"desc":"取消成功"
}