Room Rates (push)
Overview
This documentation provides details on how the Push service sends hotel rate information to the client when there are changes in the rates. The client needs to provide a Push URL and an API key for authentication.
Client Information
- Push URL: Provided by the client.
- API Key: Provided by the client.
Push Service
How it Works
The service will push data to the client-provided URL whenever there are changes in hotel rates. The data is sent in a JSON format, and the request includes the API key in the headers for authentication.
Payload
The payload is a JSON object containing hotel rate details. Below is the structure of the payload.
stringalphanumericrequiredhotelIdThe unique identifier for the hotel. Max length 200 characters.
Example:
hotelId: 'HOTEL123'
stringYYYY-MM-DDrequiredcheckInThe check-in date formatted as YYYY-MM-DD.
Example:
checkIn: '2024-06-15'
integerrequirednightsThe number of nights for the stay, minimum value is 1.
Default:
1Example:
nights: 3
numberoptionalguestsThe number of guests, default value is 2.
Default:
2Example:
guests: 4
arrayrequiredroomsAn array of room details, each object contains specific information about the room.
Example:
rooms: [{"name": "Deluxe Suite", "id": "DS101", "description": "A spacious room with a beautiful sea view.", "capacity": 4, "occupancy": 2}]
stringrequirednameThe name of the rate, as presented to users. Max length 200 characters.
Example:
name: 'Summer Special Offer'
stringrequiredruleA rate rule ID, currently only 'member' or 'default'.
Example:
rule: 'member'
stringrequireddescriptionDescription of the rate.
Example:
description: 'Includes free breakfast, Wi-Fi and parking.'
integerrequiredoccupancyThe number of guests that the rate is intended for.
Example:
occupancy: 2
booleanoptionalbreakfastIncludedIndicates if breakfast is included.
Example:
breakfastIncluded: true
booleanoptionallunchIncludedIndicates if lunch is included.
Example:
lunchIncluded: false
booleanoptionaldinnerIncludedIndicates if dinner is included.
Example:
dinnerIncluded: true
booleanoptionalallInclusiveIndicates if all-inclusive service is provided.
Example:
allInclusive: true
booleanoptionalparkingIncludedIndicates if parking is included.
Example:
parkingIncluded: true
booleanoptionalinternetIncludedIndicates if internet access is included.
Example:
internetIncluded: true
booleanoptionalrefundableIndicates if the rate is refundable.
Example:
refundable: true
stringISO 4217requiredcurrencyCodeISO 4217 Currency Code.
Example:
currencyCode: 'USD'
integerrequiredvalueAn integer in the smallest currency unit.
Example:
value: 100
arrayrequiredtaxesAn array of tax objects, each specifying details about a specific tax.
Example:
taxes: [{"type": "NamedPrice", "name": "City Tax", "code": "city-tax", "price": {"currencyCode": "USD", "value": 100}}]