By Geo-Location
const url = 'https://api.wink.travel/api/public//search/geo?engineConfigurationIdentifier=';const options = { method: 'POST', headers: {'Wink-Version': '2.0', 'Content-Type': 'application/json'}, body: '{"userSession":"","location":"","bounds":"","searchFilters":"","inventoryTypes":["GUEST_ROOM"],"page":0,"size":10}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url 'https://api.wink.travel/api/public//search/geo?engineConfigurationIdentifier=' \ --header 'Content-Type: application/json' \ --header 'Wink-Version: 2.0' \ --data '{ "userSession": "", "location": "", "bounds": "", "searchFilters": "", "inventoryTypes": [ "GUEST_ROOM" ], "page": 0, "size": 10 }'Search for properties near a point or within bounds. Populate either request.userSession.location OR request.userSession.bounds.
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”Managing entity identifier
Query Parameters
Section titled “Query Parameters ”Engine configuration identifier
Header Parameters
Section titled “Header Parameters ”Request Body required
Section titled “Request Body required ”object
User session containing geo-location to search around.
object
Dates and travel info.
object
Start date of itinerary
Example
2024-01-01Optional end date. If endDate is empty, nights needs to be present. If both are present, nights will take precedence.
Example
2024-01-02Optional number of nights. If nights is empty, endDate needs to be present. If both are present, nights will take precedence.
Room configurations
Room Configuration
object
Number of adults
Example
2Children configurations
BookingItineraryRoomConfigurationChild configuration
object
Number of children
Age of children
Number of identical rooms of this configuration being booked
Example
1Number of hours between start and end dates. Used for itineraries that require bookings that occur within hours and not days. E.g. Meeting room reservation.
How many total children for this stay
How many total rooms for this stay
How many total guests for this stay
User’s language preference
Example
enUser’s currency preference
Example
USDUser can pass the current room configuration index to retrieve rates specifically for that room configuration.
The preferred user lifestyle.
User’s last map location
object
Example
{ "type": "POINT", "coordinates": [ 100.5581533, 13.7370197 ]}Map bounds the user is looking. Bounds provided by map provider.
object
object
object
object
Example
{ "type": "Polygon", "coordinates": [ [ [ 103, 1.3 ], [ 104, 1.3 ], [ 104, 1.4 ], [ 103, 1.4 ], [ 103, 1.3 ] ] ]}How user likes to have results displayed
object
A user can query for a property with a name that sounds like
Example
HiltA user can query for blocking that is in a certain proximity to a geo-location. 0 means disabled
Example
1500A user can filter blocking on a lifestyle
Example
LIFESTYLE_RELAXA user can filter on number of hotel stars
Example
4Whether to return blocking that is coming from a supplier with a direct relationship to caller
Example
trueThe page to paginate to. Note: Page uses a 0-based index.
Example
0The result size to return.
Example
10Responses
Section titled “ Responses ”OK
object
object
Property details
object
Unique hotel record identifier.
Hotel trade name
Hotel local name if different from the trade name or if it is the local language.
Name of hotel chain if applicable.
Name of hotel brand
Unique URL-friendly name slug of hotel
Event shorter name
Official or self-designated property star rating. Note that in some regions there are 6-star hotels. They are the same as 5-star hotels everywhere else.
Number of bookings for this property on the wink.travel platform.
Aggregate score based on all current user reviews.
Geo-location
object
Short and long welcome text
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Aggregate Green Index score if the property has answered our questionnaire available in the Extranet.
Count of total reviews left by users at this property.
Contact details for reservations desk
object
Contact first name
Contact last name
Contact E-mail
Contact secondary Email
Contact phone number
First and last name
Summary
Property’s social network accounts
Social network
object
Type of social network.
URL or social network identifier to social network profile
Property images.
Multimedia that contains less information than Multimedia object
object
Document identifier
Use this identifier to communicate with Cloudinary.
Whether Cloudinary media is a VIDEO or IMAGE.
Currently ONLY using Cloudinary to store all image / video assets.
Sort allows you to control how you want to sort this record in a list of media records.
Media angle
Media width in pixels.
Media height in pixels.
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Whether image has attribution properties
object
URL to contributor
Name of contributor
True if media width is greater or equal to height
Property videos.
Multimedia that contains less information than Multimedia object
object
Document identifier
Use this identifier to communicate with Cloudinary.
Whether Cloudinary media is a VIDEO or IMAGE.
Currently ONLY using Cloudinary to store all image / video assets.
Sort allows you to control how you want to sort this record in a list of media records.
Media angle
Media width in pixels.
Media height in pixels.
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Whether image has attribution properties
object
URL to contributor
Name of contributor
True if media width is greater or equal to height
Basic property policy record.
object
Indicates whether property allows children
When a property allows children, it can also indicate what the minimum age is for children to be allowed.
Indicates the availability of internet on the property.
Indicates how guests can access the Internet on the property.
Indicates where internet is available in and around the property.
Indicates whether parking is available at the property.
Indicates what type of parking is available at the property.
Indicates whether pets are allowed on the property. Note: There are thousand different kinds of pets. Just because the property allows small dogs does not mean the guest can bring a python. Always best to check with property.
If pets are allowed, property can further limit on weight.
If pets are allowed, property can tell travelers if there is a charge applicable for the pet.
object
When the guest has to check out.
When the guest can check in.
Array of awards and third party reviews given to property by certified / non-certified providers.
Recognition for the ancillary blocking.
object
Recognition identifier.
Recognition category.
Type of rating system the recognition operated on. This allows us to display the score properly.
The name of the entity that administers this recognition.
The actual award or rating received by the hotel facility.
Use this to let hotels indicate what the total score for this award is.
The date the award was received
When true, this indicates the property has received official permission from the award provider to use the rating in publications and marketing materials; when false this permission has not been granted.
Provides the symbol used in the rating. Used in conjunction with the Rating.
Number of attractions property has listed on its profile.
Number of activites property has listed on its profile.
Number of places property has listed on its profile.
Number of restaurants property has on its profile.
Number of meeting rooms property has on its profile.
Number of spas property has on its profile.
Number of add-ons property has on its profile.
General manager related data.
object
Name of GM currently managing the property.
Cloudinary image identifier of GM currently managing the property.
object
Document identifier
Use this identifier to communicate with Cloudinary.
Whether Cloudinary media is a VIDEO or IMAGE.
Currently ONLY using Cloudinary to store all image / video assets.
Sort allows you to control how you want to sort this record in a list of media records.
Media angle
Media width in pixels.
Media height in pixels.
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Whether image has attribution properties
object
URL to contributor
Name of contributor
True if media width is greater or equal to height
Localized welcome message from GM.
object
Longer text description
Indicate which language this description is written in.
Supported OTA specification LOC code. See OTA geoname data
Supported OTA specification SEG code. See OTA geoname data
Supported OTA specification PCT code. See OTA geoname data
Supported OTA specification ARC code. See OTA geoname data
Year the property was constructed.
Currency code for property.
A property’s price score is based on calculating historical pricing data. Each property receives a unique score. There is no max score; it’s there to compare it against other properties.
A property’s price score is based on calculating historical pricing data. Each property receives a unique score. There is no max score; it’s there to compare it against other properties.
A property’s perk score is based on the type of perks that is offered to the guests across all master rates. There is no max score; it’s there to compare it against other properties.
A property’s package score is based on general availability and price for all packages and add-ons offered by the property. There is no max score; it’s there to compare it against other properties.
A property’s loyalty score is based on calculating how many available rate plans honor loyalty points. There is no max score; it’s there to compare it against other properties.
A property’s popular score is based on calculating number of bookings across room types. There is no max score; it’s there to compare it against other properties.
A property’s experience score is based on how calculating how many types of experiences are available and at what price ranges. There is no max score; it’s there to compare it against other properties.
Supported OTA specification HAC code. See OTA geoname data
Supported OTA specification PHY code. See OTA geoname data
Supported OTA specification SEC code. See OTA geoname data
Number of rooms / keys for this property.
Property address.
object
Address line 1
Address line 2
State
Postal / zip code
County
City name
Country
Country
Address 1, Address 2, City, State, Postal / Zip code, Country
Whether property is active
Best-priced room at property
object
Room type identifier.
Price details for this room type configuration.
object
Sales channel inventory identifier
This is one localized bookable item that can stand alongside a restaurant / meeting room etc.
object
Unique transactional identifier
Internal name of transactional blocking.
Localized descriptions describing inventory.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
How this blocking item should be priced.
Localized price
object
Hotel to user currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Hotel to wink currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Base total in user specified currency.
object
Base total in hotel currency.
object
Base total in wink currency.
object
Promotional modifiers in user specified currency
Promotional modifiers in hotel currency
Promotional modifiers in wink currency
Premium modifiers in user specified currency
Premium modifiers in hotel currency
Premium modifiers in wink currency
Channel / Membership modifier in user specified currency
Channel / Membership modifier in hotel currency
Channel / Membership modifier in wink currency
How many of this item is included in this price
Promotional discount percent
Channel discount percent
Premium percent
object
object
object
List of images / videos of item.
Multimedia that contains less information than Multimedia object
object
Document identifier
Use this identifier to communicate with Cloudinary.
Whether Cloudinary media is a VIDEO or IMAGE.
Currently ONLY using Cloudinary to store all image / video assets.
Sort allows you to control how you want to sort this record in a list of media records.
Media angle
Media width in pixels.
Media height in pixels.
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Whether image has attribution properties
object
URL to contributor
Name of contributor
True if media width is greater or equal to height
Whether there is a limit to minimum group size.
Whether there is a limit to maximum group size.
Localized offer details if rate plan discount applies.
object
Longer text description
Indicate which language this description is written in.
If a package is linked to a rate plan the user could be entitled to a promotional discount if she enters a code. When this field is populated, it means the discount was applied to the package.
Whether this package is commissionable based on the incoming sales channel.
The commission percentage.
Indicates whether the blocking from sales channel is direct or not. If you are a travel agent doing your own acquiring, this flag has to be true to make a booking.
The actual amount of adults as determined by the hotel’s policy
The actual amount of children as determined by the hotel’s policy
SimpleDateTimeItinerary startDate
SimpleDateTimeItinerary endDate
Specified master rate identifier
Specified master rate internal name
Specified rate plan
object
Rate plan identifier
Provides the name of the rate plan.
When true, indicates breakfast is included.
When true, indicates brunch is included.
When true, indicates lunch is included.
When true, indicates dinner is included.
Everything included except alcohol
Everything included with alcohol
Perks that accompany the master rate
object
Enum identifier identifier for this perk. Makes the persistent version backwards compatible.
Whether perk is guaranteed or not.
The platform value of this perk.
Localized description for this perk
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
This is how perks get sorted when in a list
Calculated price
object
Base total in user specified currency.
object
Base total in hotel’s currency.
object
Base total in wink currency.
object
Extra person modifier in hotel currency.
Extra person modifier in wink currency
Extra person modifier in user specified currency
Extra child modifier in hotel currency
Extra child modifier in wink currency
Extra child modifier in user specified currcency
Single occupant modifier in hotel currency
Singe occupant modifier in wink currency
Single occupant modifier in user specified currency
Rate discount modifiers in hotel currency
Rate discount modifiers in wink currency
Rate discount modifiers in user specified currency
Rate premiums modifiers in hotel currency
Rate premiums modifiers in wink currency
Rate premiums modifiers in user specified currency
Channel / Membership modifier in hotel currency
Channel / Membership modifier in wink currency
Channel / Membership modifier in user specified currency
Quantity
Minimum occupancy
Maximum occupancy
Source
Promotional discount percent
Chanel discount percent
Premium percent
Available
Hotel to user currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Hotel to wink currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Localized text of the discount
object
Longer text description
Indicate which language this description is written in.
Promotional codes
User-defined currency final price.
object
Source currency final price.
object
Internal currency final price.
object
object
object
object
Per rate plan level extra charges with localized prices
object
List of extra charges that applies to the rate plan.
object
What the guest is paying extra for
object
List of localized descriptions for this fee.
object
Longer text description
Indicate which language this description is written in.
Rate plan level fixed fee amount in property currency
object
Rate plan fee type
The localized unit price of the extra charge
object
Hotel to user currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Hotel to wink currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Base total in user specified currency.
object
Base total in hotel currency.
object
Base total in wink currency.
object
Promotional modifiers in user specified currency
Promotional modifiers in hotel currency
Promotional modifiers in wink currency
Premium modifiers in user specified currency
Premium modifiers in hotel currency
Premium modifiers in wink currency
Channel / Membership modifier in user specified currency
Channel / Membership modifier in hotel currency
Channel / Membership modifier in wink currency
How many of this item is included in this price
Promotional discount percent
Channel discount percent
Premium percent
object
object
object
The localized price of the extra charge
object
Hotel to user currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Hotel to wink currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Base total in user specified currency.
object
Base total in hotel currency.
object
Base total in wink currency.
object
Promotional modifiers in user specified currency
Promotional modifiers in hotel currency
Promotional modifiers in wink currency
Premium modifiers in user specified currency
Premium modifiers in hotel currency
Premium modifiers in wink currency
Channel / Membership modifier in user specified currency
Channel / Membership modifier in hotel currency
Channel / Membership modifier in wink currency
How many of this item is included in this price
Promotional discount percent
Channel discount percent
Premium percent
object
object
object
object
object
object
The selected room configuration that created this record
object
Number of adults
Children configurations
BookingItineraryRoomConfigurationChild configuration
object
Number of children
Age of children
Number of identical rooms of this configuration being booked
Add-ons that are available with this room configuration
object
The original add-on record created by the property.
object
Unique record identifier
Hotel identifier.
Indicates whether this inventory is featured. Use this flag as a way to signify that this inventory is special.
Indicate the type of lifestyle this blocking should be associated with.
Geo-location point where blocking takes place. Defaults to location of property.
object
Localized descriptions describing inventory.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
List of images / videos of blocking.
Multimedia that contains less information than Multimedia object
object
Document identifier
Use this identifier to communicate with Cloudinary.
Whether Cloudinary media is a VIDEO or IMAGE.
Currently ONLY using Cloudinary to store all image / video assets.
Sort allows you to control how you want to sort this record in a list of media records.
Media angle
Media width in pixels.
Media height in pixels.
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Whether image has attribution properties
object
URL to contributor
Name of contributor
True if media width is greater or equal to height
Associate a contact person for this blocking (if applicable).
object
Contact first name
Contact last name
Contact E-mail
Contact secondary Email
Contact phone number
First and last name
Summary
Defaults to property address.
object
Address line 1
Address line 2
State
Postal / zip code
County
City name
Country
Country
Address 1, Address 2, City, State, Postal / Zip code, Country
Indicate whether sales channels receive commission for selling this blocking.
Internal name of inventory.
Supported OTA specification PRX code. See OTA geoname data
Use this property to sort an blocking in a list of activities.
Supported OTA specification AQC code. See OTA geoname data
Indicates if this blocking can be added to a booking or if it is read-only marketing material only.
Modify blocking availability with this flag.
Supported OTA specification PHY code. See OTA geoname data
Supported OTA specification SEC code. See OTA geoname data
Social network accounts for blocking (if applicable).
Social network
object
Type of social network.
URL or social network identifier to social network profile
Level of expensiveness.
Inventory-level recognition.
Recognition for the ancillary blocking.
object
Recognition identifier.
Recognition category.
Type of rating system the recognition operated on. This allows us to display the score properly.
The name of the entity that administers this recognition.
The actual award or rating received by the hotel facility.
Use this to let hotels indicate what the total score for this award is.
The date the award was received
When true, this indicates the property has received official permission from the award provider to use the rating in publications and marketing materials; when false this permission has not been granted.
Provides the symbol used in the rating. Used in conjunction with the Rating.
Start month and day or date for which the attraction (e.g. the start of a season) is available. This date property signifies that the blocking is recurring and / or seasonal. If the date is in the past, only day and month will be used to infer seasonality. If the date is a future date, it will be interpreted as a starting date.
End month and day or date for which the attraction (e.g. the start of a season) is available. This date property signifies that the blocking is recurring and / or seasonal. If the date is in the past, only day and month will be used to infer seasonality. If the date is a future date, it will be interpreted as a ending date.
Indicates whether a reservation is required to participate in this blocking.
Opening time of blocking (if applicable). Leave empty if blocking is always available.
Closing time of blocking (if applicable). Leave empty if blocking is always available.
Indicate which days this blocking is open.
object
Set to true to enable Monday.
Set to true to enable Tuesday.
Set to true to enable Wednesday.
Set to true to enable Thursday.
Set to true to enable Friday.
Set to true to enable Saturday.
Set to true to enable Sunday.
Convenience property to quickly determine if this existing object has any active days enabled.
Total number of add-ons available to purchase.
Make this add-on mandatory for all guests by enabling this flag.
Optional restriction on rate plan.
Localized transactional blocking
object
Unique transactional identifier
Internal name of transactional blocking.
Localized descriptions describing inventory.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
How this blocking item should be priced.
Localized price
object
Hotel to user currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Hotel to wink currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Base total in user specified currency.
object
Base total in hotel currency.
object
Base total in wink currency.
object
Promotional modifiers in user specified currency
Promotional modifiers in hotel currency
Promotional modifiers in wink currency
Premium modifiers in user specified currency
Premium modifiers in hotel currency
Premium modifiers in wink currency
Channel / Membership modifier in user specified currency
Channel / Membership modifier in hotel currency
Channel / Membership modifier in wink currency
How many of this item is included in this price
Promotional discount percent
Channel discount percent
Premium percent
object
object
object
List of images / videos of item.
Multimedia that contains less information than Multimedia object
object
Document identifier
Use this identifier to communicate with Cloudinary.
Whether Cloudinary media is a VIDEO or IMAGE.
Currently ONLY using Cloudinary to store all image / video assets.
Sort allows you to control how you want to sort this record in a list of media records.
Media angle
Media width in pixels.
Media height in pixels.
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Whether image has attribution properties
object
URL to contributor
Name of contributor
True if media width is greater or equal to height
Whether there is a limit to minimum group size.
Whether there is a limit to maximum group size.
Localized offer details if rate plan discount applies.
object
Longer text description
Indicate which language this description is written in.
If a package is linked to a rate plan the user could be entitled to a promotional discount if she enters a code. When this field is populated, it means the discount was applied to the package.
Channel inventory identifier referencing this record.
Whether this package is commissionable based on the incoming sales channel.
The commission percentage.
Indicates whether the blocking from sales channel is direct or not. If you are a travel agent doing your own acquiring, this flag has to be true to make a booking.
The combined value of these perkTypes
The active / selected cancellation policy for this room configuration
object
Unique cancellation policy identifier
Property this cancellation is associated with
Whether this cancellation policy is refundable or not
When the cancellation policy is refundable, this flag can be set and indicates there is more rules involved than just a no-questions-asked refundable.
If advanceCancellationFreeOfCharge rules is not honored, this property explains what the guest will be charged.
In case the ‘Refundable cancellation charge’ is set, a different no show charge can be applied.
When the cancellation policy is non-refundable, this flag can be set and indicates there is more rules involved to calculate what the guest will owe in case of a cancellation.
The non-refundable charge might can have a deadline. If that deadline passes, the guest might be charged more.
If the guest does not honor the non-refundable deadline rule, this charge dictates what she owes after the deadline passes.
Number of nights the guests will be staying
Localized transactional blocking
object
Unique transactional identifier
Internal name of transactional blocking.
Localized descriptions describing inventory.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
How this blocking item should be priced.
Localized price
object
Hotel to user currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Hotel to wink currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Base total in user specified currency.
object
Base total in hotel currency.
object
Base total in wink currency.
object
Promotional modifiers in user specified currency
Promotional modifiers in hotel currency
Promotional modifiers in wink currency
Premium modifiers in user specified currency
Premium modifiers in hotel currency
Premium modifiers in wink currency
Channel / Membership modifier in user specified currency
Channel / Membership modifier in hotel currency
Channel / Membership modifier in wink currency
How many of this item is included in this price
Promotional discount percent
Channel discount percent
Premium percent
object
object
object
List of images / videos of item.
Multimedia that contains less information than Multimedia object
object
Document identifier
Use this identifier to communicate with Cloudinary.
Whether Cloudinary media is a VIDEO or IMAGE.
Currently ONLY using Cloudinary to store all image / video assets.
Sort allows you to control how you want to sort this record in a list of media records.
Media angle
Media width in pixels.
Media height in pixels.
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Whether image has attribution properties
object
URL to contributor
Name of contributor
True if media width is greater or equal to height
Whether there is a limit to minimum group size.
Whether there is a limit to maximum group size.
Localized offer details if rate plan discount applies.
object
Longer text description
Indicate which language this description is written in.
If a package is linked to a rate plan the user could be entitled to a promotional discount if she enters a code. When this field is populated, it means the discount was applied to the package.
object
object
object
The sum of all perks the master rate had made available.
Whether this room type is available with this configuration
When this room type is displayed in conjunction with many others, this sort property will often times be populated to indicate how the room types should be sorted and displayed.
Unique property room types
object
Unique record identifier
Hotel identifier.
Indicates whether this inventory is featured. Use this flag as a way to signify that this inventory is special.
Indicate the type of lifestyle this blocking should be associated with.
Geo-location point where blocking takes place. Defaults to location of property.
object
Localized descriptions describing inventory.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
List of images / videos of blocking.
Multimedia that contains less information than Multimedia object
object
Document identifier
Use this identifier to communicate with Cloudinary.
Whether Cloudinary media is a VIDEO or IMAGE.
Currently ONLY using Cloudinary to store all image / video assets.
Sort allows you to control how you want to sort this record in a list of media records.
Media angle
Media width in pixels.
Media height in pixels.
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Whether image has attribution properties
object
URL to contributor
Name of contributor
True if media width is greater or equal to height
Associate a contact person for this blocking (if applicable).
object
Contact first name
Contact last name
Contact E-mail
Contact secondary Email
Contact phone number
First and last name
Summary
Defaults to property address.
object
Address line 1
Address line 2
State
Postal / zip code
County
City name
Country
Country
Address 1, Address 2, City, State, Postal / Zip code, Country
Indicate whether sales channels receive commission for selling this blocking.
Internal name of inventory.
Supported OTA specification PRX code. See OTA geoname data
Use this property to sort an blocking in a list of activities.
Supported OTA specification AQC code. See OTA geoname data
Indicates if this blocking can be added to a booking or if it is read-only marketing material only.
Modify blocking availability with this flag.
Supported OTA specification PHY code. See OTA geoname data
Supported OTA specification SEC code. See OTA geoname data
Social network accounts for blocking (if applicable).
Social network
object
Type of social network.
URL or social network identifier to social network profile
Level of expensiveness.
Inventory-level recognition.
Recognition for the ancillary blocking.
object
Recognition identifier.
Recognition category.
Type of rating system the recognition operated on. This allows us to display the score properly.
The name of the entity that administers this recognition.
The actual award or rating received by the hotel facility.
Use this to let hotels indicate what the total score for this award is.
The date the award was received
When true, this indicates the property has received official permission from the award provider to use the rating in publications and marketing materials; when false this permission has not been granted.
Provides the symbol used in the rating. Used in conjunction with the Rating.
Maximum number of guest allowed in a room type.
Minimum number of guests allowed in a room type.
Defines the number of rooms of this type
Non-smoking indicator
A room type can have more than one bed configuration.
object
Unique identifier
Name of layout
A room type can have more than one bedroom configuration.
object
Type of bedroom
A bedroom can have more than one bed type.
object
Indicates the type of bed(s) found in the room. Typical values would be Double, Twin, Queen, or King. Supported OTA specification BED code. See OTA geoname data.
Number of beds for this bed type.
Number of square meters that defines the size of this room type.
Maximum number of adults allowed in a room type.
Maximum number of children allowed in a room type.
Number of bathrooms
Number of living rooms
Maximum number of rollaway beds allowed in this room type.
Indicates the category of the room. Typical values would be Moderate, Standard, or Deluxe. Supported OTA specification SEG code. See OTA geoname data
Floor an which a room is located
Indicates the location of the room within the hotel structure. Typical values would be “Near Exit”,“Close to elevator”, “Low Floor” or “High Floor”. Supported OTA specification RLT code. See OTA geoname data
Indicates the view of the room. Typical values would be “Ocean view”, “Pool view” or “Garden View”. Supported OTA specification RVT code. See OTA geoname data
Indicates that the room (suite) is a composite of smaller units.
Number of rooms of this room type that makes up a larger unit (composite) such as a two bedroom suite could be comprised of two king rooms plus other room types. A 0 means disabled.
Specifies the room classification (e.g., cabin, apartment). Supported OTA specification GRI code. See OTA geoname data
Specifies the architectural style of a room. Supported OTA specification ARC code. See OTA geoname data
Used to request or specify a gender assignment for a room. Note: Typically used by Hosteliers.
If TRUE, the room requires or has sharing available. Note: Typically used by Hosteliers.
Maximum number of cribs allowed in a room type.
Collection of room amenity items available to the guest. Supported OTA specification RMA code. See OTA geoname data
The number of pax the room price was meant for
The number of children the room price was meant for
Best-priced room types
object
Room type identifier.
Price details for this room type configuration.
object
Sales channel inventory identifier
This is one localized bookable item that can stand alongside a restaurant / meeting room etc.
object
Unique transactional identifier
Internal name of transactional blocking.
Localized descriptions describing inventory.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
How this blocking item should be priced.
Localized price
object
Hotel to user currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Hotel to wink currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Base total in user specified currency.
object
Base total in hotel currency.
object
Base total in wink currency.
object
Promotional modifiers in user specified currency
Promotional modifiers in hotel currency
Promotional modifiers in wink currency
Premium modifiers in user specified currency
Premium modifiers in hotel currency
Premium modifiers in wink currency
Channel / Membership modifier in user specified currency
Channel / Membership modifier in hotel currency
Channel / Membership modifier in wink currency
How many of this item is included in this price
Promotional discount percent
Channel discount percent
Premium percent
object
object
object
List of images / videos of item.
Multimedia that contains less information than Multimedia object
object
Document identifier
Use this identifier to communicate with Cloudinary.
Whether Cloudinary media is a VIDEO or IMAGE.
Currently ONLY using Cloudinary to store all image / video assets.
Sort allows you to control how you want to sort this record in a list of media records.
Media angle
Media width in pixels.
Media height in pixels.
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Whether image has attribution properties
object
URL to contributor
Name of contributor
True if media width is greater or equal to height
Whether there is a limit to minimum group size.
Whether there is a limit to maximum group size.
Localized offer details if rate plan discount applies.
object
Longer text description
Indicate which language this description is written in.
If a package is linked to a rate plan the user could be entitled to a promotional discount if she enters a code. When this field is populated, it means the discount was applied to the package.
Whether this package is commissionable based on the incoming sales channel.
The commission percentage.
Indicates whether the blocking from sales channel is direct or not. If you are a travel agent doing your own acquiring, this flag has to be true to make a booking.
The actual amount of adults as determined by the hotel’s policy
The actual amount of children as determined by the hotel’s policy
SimpleDateTimeItinerary startDate
SimpleDateTimeItinerary endDate
Specified master rate identifier
Specified master rate internal name
Specified rate plan
object
Rate plan identifier
Provides the name of the rate plan.
When true, indicates breakfast is included.
When true, indicates brunch is included.
When true, indicates lunch is included.
When true, indicates dinner is included.
Everything included except alcohol
Everything included with alcohol
Perks that accompany the master rate
object
Enum identifier identifier for this perk. Makes the persistent version backwards compatible.
Whether perk is guaranteed or not.
The platform value of this perk.
Localized description for this perk
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
This is how perks get sorted when in a list
Calculated price
object
Base total in user specified currency.
object
Base total in hotel’s currency.
object
Base total in wink currency.
object
Extra person modifier in hotel currency.
Extra person modifier in wink currency
Extra person modifier in user specified currency
Extra child modifier in hotel currency
Extra child modifier in wink currency
Extra child modifier in user specified currcency
Single occupant modifier in hotel currency
Singe occupant modifier in wink currency
Single occupant modifier in user specified currency
Rate discount modifiers in hotel currency
Rate discount modifiers in wink currency
Rate discount modifiers in user specified currency
Rate premiums modifiers in hotel currency
Rate premiums modifiers in wink currency
Rate premiums modifiers in user specified currency
Channel / Membership modifier in hotel currency
Channel / Membership modifier in wink currency
Channel / Membership modifier in user specified currency
Quantity
Minimum occupancy
Maximum occupancy
Source
Promotional discount percent
Chanel discount percent
Premium percent
Available
Hotel to user currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Hotel to wink currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Localized text of the discount
object
Longer text description
Indicate which language this description is written in.
Promotional codes
User-defined currency final price.
object
Source currency final price.
object
Internal currency final price.
object
object
object
object
Per rate plan level extra charges with localized prices
object
List of extra charges that applies to the rate plan.
object
What the guest is paying extra for
object
List of localized descriptions for this fee.
object
Longer text description
Indicate which language this description is written in.
Rate plan level fixed fee amount in property currency
object
Rate plan fee type
The localized unit price of the extra charge
object
Hotel to user currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Hotel to wink currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Base total in user specified currency.
object
Base total in hotel currency.
object
Base total in wink currency.
object
Promotional modifiers in user specified currency
Promotional modifiers in hotel currency
Promotional modifiers in wink currency
Premium modifiers in user specified currency
Premium modifiers in hotel currency
Premium modifiers in wink currency
Channel / Membership modifier in user specified currency
Channel / Membership modifier in hotel currency
Channel / Membership modifier in wink currency
How many of this item is included in this price
Promotional discount percent
Channel discount percent
Premium percent
object
object
object
The localized price of the extra charge
object
Hotel to user currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Hotel to wink currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Base total in user specified currency.
object
Base total in hotel currency.
object
Base total in wink currency.
object
Promotional modifiers in user specified currency
Promotional modifiers in hotel currency
Promotional modifiers in wink currency
Premium modifiers in user specified currency
Premium modifiers in hotel currency
Premium modifiers in wink currency
Channel / Membership modifier in user specified currency
Channel / Membership modifier in hotel currency
Channel / Membership modifier in wink currency
How many of this item is included in this price
Promotional discount percent
Channel discount percent
Premium percent
object
object
object
object
object
object
The selected room configuration that created this record
object
Number of adults
Children configurations
BookingItineraryRoomConfigurationChild configuration
object
Number of children
Age of children
Number of identical rooms of this configuration being booked
Add-ons that are available with this room configuration
object
The original add-on record created by the property.
object
Unique record identifier
Hotel identifier.
Indicates whether this inventory is featured. Use this flag as a way to signify that this inventory is special.
Indicate the type of lifestyle this blocking should be associated with.
Geo-location point where blocking takes place. Defaults to location of property.
object
Localized descriptions describing inventory.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
List of images / videos of blocking.
Multimedia that contains less information than Multimedia object
object
Document identifier
Use this identifier to communicate with Cloudinary.
Whether Cloudinary media is a VIDEO or IMAGE.
Currently ONLY using Cloudinary to store all image / video assets.
Sort allows you to control how you want to sort this record in a list of media records.
Media angle
Media width in pixels.
Media height in pixels.
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Whether image has attribution properties
object
URL to contributor
Name of contributor
True if media width is greater or equal to height
Associate a contact person for this blocking (if applicable).
object
Contact first name
Contact last name
Contact E-mail
Contact secondary Email
Contact phone number
First and last name
Summary
Defaults to property address.
object
Address line 1
Address line 2
State
Postal / zip code
County
City name
Country
Country
Address 1, Address 2, City, State, Postal / Zip code, Country
Indicate whether sales channels receive commission for selling this blocking.
Internal name of inventory.
Supported OTA specification PRX code. See OTA geoname data
Use this property to sort an blocking in a list of activities.
Supported OTA specification AQC code. See OTA geoname data
Indicates if this blocking can be added to a booking or if it is read-only marketing material only.
Modify blocking availability with this flag.
Supported OTA specification PHY code. See OTA geoname data
Supported OTA specification SEC code. See OTA geoname data
Social network accounts for blocking (if applicable).
Social network
object
Type of social network.
URL or social network identifier to social network profile
Level of expensiveness.
Inventory-level recognition.
Recognition for the ancillary blocking.
object
Recognition identifier.
Recognition category.
Type of rating system the recognition operated on. This allows us to display the score properly.
The name of the entity that administers this recognition.
The actual award or rating received by the hotel facility.
Use this to let hotels indicate what the total score for this award is.
The date the award was received
When true, this indicates the property has received official permission from the award provider to use the rating in publications and marketing materials; when false this permission has not been granted.
Provides the symbol used in the rating. Used in conjunction with the Rating.
Start month and day or date for which the attraction (e.g. the start of a season) is available. This date property signifies that the blocking is recurring and / or seasonal. If the date is in the past, only day and month will be used to infer seasonality. If the date is a future date, it will be interpreted as a starting date.
End month and day or date for which the attraction (e.g. the start of a season) is available. This date property signifies that the blocking is recurring and / or seasonal. If the date is in the past, only day and month will be used to infer seasonality. If the date is a future date, it will be interpreted as a ending date.
Indicates whether a reservation is required to participate in this blocking.
Opening time of blocking (if applicable). Leave empty if blocking is always available.
Closing time of blocking (if applicable). Leave empty if blocking is always available.
Indicate which days this blocking is open.
object
Set to true to enable Monday.
Set to true to enable Tuesday.
Set to true to enable Wednesday.
Set to true to enable Thursday.
Set to true to enable Friday.
Set to true to enable Saturday.
Set to true to enable Sunday.
Convenience property to quickly determine if this existing object has any active days enabled.
Total number of add-ons available to purchase.
Make this add-on mandatory for all guests by enabling this flag.
Optional restriction on rate plan.
Localized transactional blocking
object
Unique transactional identifier
Internal name of transactional blocking.
Localized descriptions describing inventory.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
How this blocking item should be priced.
Localized price
object
Hotel to user currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Hotel to wink currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Base total in user specified currency.
object
Base total in hotel currency.
object
Base total in wink currency.
object
Promotional modifiers in user specified currency
Promotional modifiers in hotel currency
Promotional modifiers in wink currency
Premium modifiers in user specified currency
Premium modifiers in hotel currency
Premium modifiers in wink currency
Channel / Membership modifier in user specified currency
Channel / Membership modifier in hotel currency
Channel / Membership modifier in wink currency
How many of this item is included in this price
Promotional discount percent
Channel discount percent
Premium percent
object
object
object
List of images / videos of item.
Multimedia that contains less information than Multimedia object
object
Document identifier
Use this identifier to communicate with Cloudinary.
Whether Cloudinary media is a VIDEO or IMAGE.
Currently ONLY using Cloudinary to store all image / video assets.
Sort allows you to control how you want to sort this record in a list of media records.
Media angle
Media width in pixels.
Media height in pixels.
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Whether image has attribution properties
object
URL to contributor
Name of contributor
True if media width is greater or equal to height
Whether there is a limit to minimum group size.
Whether there is a limit to maximum group size.
Localized offer details if rate plan discount applies.
object
Longer text description
Indicate which language this description is written in.
If a package is linked to a rate plan the user could be entitled to a promotional discount if she enters a code. When this field is populated, it means the discount was applied to the package.
Channel inventory identifier referencing this record.
Whether this package is commissionable based on the incoming sales channel.
The commission percentage.
Indicates whether the blocking from sales channel is direct or not. If you are a travel agent doing your own acquiring, this flag has to be true to make a booking.
The combined value of these perkTypes
The active / selected cancellation policy for this room configuration
object
Unique cancellation policy identifier
Property this cancellation is associated with
Whether this cancellation policy is refundable or not
When the cancellation policy is refundable, this flag can be set and indicates there is more rules involved than just a no-questions-asked refundable.
If advanceCancellationFreeOfCharge rules is not honored, this property explains what the guest will be charged.
In case the ‘Refundable cancellation charge’ is set, a different no show charge can be applied.
When the cancellation policy is non-refundable, this flag can be set and indicates there is more rules involved to calculate what the guest will owe in case of a cancellation.
The non-refundable charge might can have a deadline. If that deadline passes, the guest might be charged more.
If the guest does not honor the non-refundable deadline rule, this charge dictates what she owes after the deadline passes.
Number of nights the guests will be staying
Localized transactional blocking
object
Unique transactional identifier
Internal name of transactional blocking.
Localized descriptions describing inventory.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
How this blocking item should be priced.
Localized price
object
Hotel to user currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Hotel to wink currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Base total in user specified currency.
object
Base total in hotel currency.
object
Base total in wink currency.
object
Promotional modifiers in user specified currency
Promotional modifiers in hotel currency
Promotional modifiers in wink currency
Premium modifiers in user specified currency
Premium modifiers in hotel currency
Premium modifiers in wink currency
Channel / Membership modifier in user specified currency
Channel / Membership modifier in hotel currency
Channel / Membership modifier in wink currency
How many of this item is included in this price
Promotional discount percent
Channel discount percent
Premium percent
object
object
object
List of images / videos of item.
Multimedia that contains less information than Multimedia object
object
Document identifier
Use this identifier to communicate with Cloudinary.
Whether Cloudinary media is a VIDEO or IMAGE.
Currently ONLY using Cloudinary to store all image / video assets.
Sort allows you to control how you want to sort this record in a list of media records.
Media angle
Media width in pixels.
Media height in pixels.
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Whether image has attribution properties
object
URL to contributor
Name of contributor
True if media width is greater or equal to height
Whether there is a limit to minimum group size.
Whether there is a limit to maximum group size.
Localized offer details if rate plan discount applies.
object
Longer text description
Indicate which language this description is written in.
If a package is linked to a rate plan the user could be entitled to a promotional discount if she enters a code. When this field is populated, it means the discount was applied to the package.
object
object
object
The sum of all perks the master rate had made available.
Whether this room type is available with this configuration
When this room type is displayed in conjunction with many others, this sort property will often times be populated to indicate how the room types should be sorted and displayed.
The potential discount the user is entitled to if user is a member / authenticated.
Exchange rate quote between the property’s source currency and the user’s desired currency that was used to populate price.
object
Source
Target
Exchange rate
Timestamp
Exchange rate quote between the property’s source currency and the user’s currency that was used to populate price.
object
Source
Target
Exchange rate
Timestamp
Flag to indicate whether this blocking is available or not. This data point is identifier to the available flag on the price child data point.
object
object
object
Example
{ "content": [ { "hotel": "", "lowestPrice": "", "roomTypeList": "", "priceList": "", "potentialChannelDiscountPercent": "", "sourceToUserCurrencyQuote": "", "sourceToInternalCurrencyQuote": "", "available": false } ]}Bad Request
object
object
Example generated
{ "type": "https://example.com", "title": "example", "status": 1, "detail": "example", "instance": "https://example.com", "properties": { "additionalProperty": "example" }}object
object
object
object
object
object
object
object
Unauthorized
object
object
Forbidden
object
object
Internal Server Error
object
Example generated
{}