Skip to main content

酒店商品

获取指定酒店下的可售商品列表,返回结果为数组,数组顺序与日期对应

请求方式#

POST

uri: /ari/products

Content-Type:application/json


请求参数说明#

RequestHeader#

公共请求头[引用]

RequestBody#

参数类型是否必填最大长度示例描述
hotelIdStringY3212**567华住酒店ID

响应参数说明#

公共响应参数[引用]

响应码-code[引用]

content#

参数类型是否必填最大长度示例描述
hotelIdStringY3212**567华住酒店ID
productsList<Product >N-商品信息列表

Product#

参数类型是否必填最大长度示例描述
roomTypeCodeStringY64DR1房型Code
roomTypeNameStringY200高级大床房房型名称
rateCodeStringY64Base-NTR房价码
rateCodeNameStringN500早定早惠房价码名称
checkinTypeStringY16DAY入住类型,区分大小写,取值参考枚举
stayWindowStayWindowN-入住窗口属性,此范围内的ARI数据需要同步落地,为null表示不限制(90天可订,每天预订时间不限),失效日期对应报价接口返回销售限制为关房
bookWindowBookWindowN-预订窗口属性,提示用户注意可订时间范围,或非此时间范围内不展示该报价,为null表示不限制(90天可订,每天预订时间不限),失效日期对应报价接口返回销售限制为关房
hourageIntegerN-2时租房小时数,当入住类型为时租房时有值,目前支持2 4 6小时
tagsList<String>N-["NS"]标签:标签取值,参考枚举

StayWindow#

参数类型是否必填最大长度示例描述
startDateDateN-2021-10-01生效日期,格式 yyyy-MM-dd,为null表示不限制(90天可订)
endDateDateN-2021-10-02失效日期,格式 yyyy-MM-dd,包含这一天,为null表示不限制(90天可订)
excludedDateList<String>N-移除的日期,startDate和endDate期间失效的日期,格式 yyyy-MM-dd
weekControlStringN71111111周控,从星期天开始,1表示生效,0表示失效,空表示均生效
eachDayCheckinStartTimeStringN808:00每天最早入住时间,格式:HH:mm,包含mm这一分钟,默认为null表示不限制
eachDayCheckinEndTimeStringN818:00每天最晚入住时间,格式:HH:mm,包含mm这一分钟,默认为null表示不限制
eachDayCheckoutEndTimeStringN818:00每天最晚离店时间,格式:HH:mm,包含mm这一分钟,默认为null表示不限制

BookWindow#

参数类型是否必填最大长度示例描述
startDateDateN-2021-10-01针对入住首日可订开始日期,格式 yyyy-MM-dd,为null表示不限制(90天可订)
endDateDateN-2021-10-02针对入住首日可订结束日期,格式 yyyy-MM-dd,包含这一天,为null表示不限制(90天可订)
excludedDateList<String>N-移除的日期,startDate和endDate间不可订的日期,格式 yyyy-MM-dd
eachDayStartTimeStringN808:00每天最早预订时间,格式:HH:mm,包含mm这一分钟,默认为null表示不限制
eachDayEndTimeStringN818:00每天最晚预订时间,格式:HH:mm,包含mm这一分钟,默认为null表示不限制

响应码#

异常码异常类型说明
1000Success
4101Invalid hotel Id酒店Id不存在
4102Hotel is closed酒店停业
4103No match found未找到与条件匹配的数据
其他全局异常码全局异常[引用]

报文示例#

Case1: 查询某家酒店商品#

请求示例#
{    "hotelId":"12**567"}
响应成功示例#
{    "code":1000,    "content":{        "hotelId":"12**567",        "products":[            {                "rateCode":"B10A7NBF",                "roomTypeCode":"DR1",                "rateCodeName":"正价房价码返回",                "roomTypeName":"大床房",                "checkinType":"DAY"            },            {                "rateCode":"HOUR10A8",                "roomTypeCode":"TR1",                "rateCodeName":"时租房价码返回",                "roomTypeName":"高级大床房",                "checkinType":"HOUR",                "hourage":2,                "stayWindow":{                    "startDate":"2021-11-01",                    "endDate":"2022-11-02",                    "eachDayCheckinStartTime":"08:00",                    "eachDayCheckinEndTime": "18:00",                    "eachDayCheckoutEndTime":"22:00"                },                "bookingWindow":{                    "startDate":"2021-11-01",                    "endDate":"2022-10-07",                    "excludedDate":[                        "2022-10-01"                    ],                    "eachDayStartTime":"08:00",                    "eachDayEndTime":"18:00"                }            },            {                "rateCode":"PROA766NBF",                "roomTypeCode":"TR1",                "rateCodeName":"促销房价码返回",                "roomTypeName":"高级大床房",                "checkinType":"DAY",                "tags":[                    "NS"                ]            }        ]    }}
响应成功示例#
{    "code":4103,    "message":"No match found"}