Resolve property
const url = 'https://api.wink.travel/api/public/d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69/inventory?customizationIdentifier=2c5b9e3a-7f1d-4a8c-b6e2-0d4f1a9b3c72&images=20&videos=1';const options = { method: 'POST', headers: { 'Wink-Version': '2.0', Authorization: 'Bearer <token>', 'Content-Type': 'application/json' }, body: '{"hotelIdentifier":"e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18","showActivities":true,"showAddOnOffers":true,"showAggregateGreenIndexScores":true,"showAnnouncements":true,"showAttractions":true,"showHotel":true,"showImages":true,"showMeetingRooms":true,"showMetadata":true,"showPlaces":true,"showRecognition":true,"showRestaurants":true,"showReviews":true,"showRoomTypes":true,"showSpas":true,"showVideos":true,"urlName":"the-siam-residences-bangkok-thailand","userSession":{"currency":"USD","itinerary":{"children":4,"endDate":"2026-07-18","guests":4,"hours":72,"items":[{"adults":2,"children":[{"age":7,"quantity":2}],"quantity":2}],"nights":3,"room":{"adults":2,"children":[{"age":7,"quantity":2}],"quantity":2},"rooms":2,"startDate":"2026-07-15"},"language":"en","lifestyle":"LIFESTYLE_RELAX","promotionalCodes":["SUMMER2026"],"selectedRoomConfigurationIndex":0}}'};
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/d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69/inventory?customizationIdentifier=2c5b9e3a-7f1d-4a8c-b6e2-0d4f1a9b3c72&images=20&videos=1' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --header 'Wink-Version: 2.0' \ --data '{ "hotelIdentifier": "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "showActivities": true, "showAddOnOffers": true, "showAggregateGreenIndexScores": true, "showAnnouncements": true, "showAttractions": true, "showHotel": true, "showImages": true, "showMeetingRooms": true, "showMetadata": true, "showPlaces": true, "showRecognition": true, "showRestaurants": true, "showReviews": true, "showRoomTypes": true, "showSpas": true, "showVideos": true, "urlName": "the-siam-residences-bangkok-thailand", "userSession": { "currency": "USD", "itinerary": { "children": 4, "endDate": "2026-07-18", "guests": 4, "hours": 72, "items": [ { "adults": 2, "children": [ { "age": 7, "quantity": 2 } ], "quantity": 2 } ], "nights": 3, "room": { "adults": 2, "children": [ { "age": 7, "quantity": 2 } ], "quantity": 2 }, "rooms": 2, "startDate": "2026-07-15" }, "language": "en", "lifestyle": "LIFESTYLE_RELAX", "promotionalCodes": [ "SUMMER2026" ], "selectedRoomConfigurationIndex": 0 } }'Return one property’s content, availability and rates for the requested dates, pruned to the caller’s language and image/video limits.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Managing entity identifier
Example
d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69Query Parameters
Section titled “Query Parameters”Booking engine customization identifier; when omitted the managing entity’s default configuration is used
Example
2c5b9e3a-7f1d-4a8c-b6e2-0d4f1a9b3c72Number of images to return for inventory
Example
20Number of videos to return for inventory
Example
1Header Parameters
Section titled “Header Parameters”Request Bodyrequired
Section titled “Request Bodyrequired”Property inventory request containing the hotel identifier, user session context, occupancy and desired stay dates
object
Unique property identifier to retrieve inventory for. Either the hotelIdentifier or urlName property is required.
Example
e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18Flag to indicate whether to return property activity data. This field populates activities data in response.
Example
trueFlag to indicate whether to return property add-on data. This field populates roomTypes.priceConfigurations.addOnOffers data in response.
Example
trueFlag to indicate whether to return property green index score data. This field populates greenIndexScores data in response. Note: You only need to return hotel data to get the overall aggregate Green Index score and not detailed category scores.
Example
trueFlag to indicate whether to return property announcement data. Announcements are messages the property wishes to convey to travelers for certain dates. This field populates announcements data in response.
Example
trueFlag to indicate whether to return property attraction data. This field populates attractions data in response.
Example
trueFlag to indicate whether to return basic property data. If you are loading up property for the first time, this data would be good to include. But there is no need to load that a second time if you are only going for availability data. This field populates hotel data in response.
Example
trueFlag to indicate whether to return property image data. This field populates images data in response.
Example
trueFlag to indicate whether to return property meeting room data. This field populates meetingRooms data in response.
Example
trueFlag to indicate whether to return property meta data. This field populates metadata data in response.
Example
trueFlag to indicate whether to return property place data. This field populates places data in response.
Example
trueFlag to indicate whether to return property recognition data. This field populates recognitions data in response.
Example
trueFlag to indicate whether to return property restaurant data. This field populates restaurants data in response.
Example
trueFlag to indicate whether to return property review data. Note: You only need to return hotel data to get the overall aggregate review score and not the entire list of reviews. This field populates reviews data in response.
Example
trueFlag to indicate whether to return property room type data. This field populates roomType, cheapesRoomTypes and available data in response.
Example
trueFlag to indicate whether to return property spa data. This field populates spas data in response.
Example
trueFlag to indicate whether to return property video data. This field populates videos data in response.
Example
trueUnique url-friendly record identifier of property. Either the hotelIdentifier or urlName property is required.
Example
the-siam-residences-bangkok-thailandReturns the same user session that was sent by the caller.
object
User’s currency preference (ISO 4217 code)
Example
USDDates and travel info.
object
Total number of children across all rooms
Example
4Check-out date (alternative to nights; nights takes precedence if both provided)
Example
2026-07-18Total number of adult guests across all rooms
Example
4Duration in hours (rounded up) between check-in and check-out. Used for hourly bookings; e.g., meeting rooms or day-use venues.
Example
72DEPRECATED pre-collapse room list, accepted for backwards compatibility and never returned. Send room instead. Only the first entry is used and any others are ignored: this API searches one room configuration per request. Use room.quantity to book several identical rooms.
Room occupancy and guest composition for a single or multiple identical rooms
object
Number of adult guests in this room type
Example
2Child guests in this room, with age groups
Child guest with age and quantity in a room configuration
object
Age of each child in this group (years)
Example
7Count of children of this age group in the room
Example
2Example
{ "age": 7, "quantity": 2}Number of identical rooms with this configuration
Example
2Example
{ "adults": 2, "children": [ { "age": 7, "quantity": 2 } ], "quantity": 2}Number of nights for the stay (alternative to endDate; takes precedence if both provided)
Example
3The room configuration being booked, and how many identical rooms of it
object
Number of adult guests in this room type
Example
2Child guests in this room, with age groups
Child guest with age and quantity in a room configuration
object
Age of each child in this group (years)
Example
7Count of children of this age group in the room
Example
2Example
{ "age": 7, "quantity": 2}Number of identical rooms with this configuration
Example
2Example
{ "adults": 2, "children": [ { "age": 7, "quantity": 2 } ], "quantity": 2}Total number of rooms in this itinerary
Example
2Check-in date (must be today or in the future)
Example
2026-07-15Example
{ "children": 4, "endDate": "2026-07-18", "guests": 4, "hours": 72, "items": [ { "adults": 2, "children": [ { "age": 7, "quantity": 2 } ], "quantity": 2 } ], "nights": 3, "room": { "adults": 2, "children": [ { "age": 7, "quantity": 2 } ], "quantity": 2 }, "rooms": 2, "startDate": "2026-07-15"}User’s language preference (ISO 639-1 code)
Example
enPreferred lifestyle category to filter accommodations
Example
LIFESTYLE_RELAXIndex of the currently selected room configuration for rate retrieval
Example
0Example
{ "currency": "USD", "itinerary": { "children": 4, "endDate": "2026-07-18", "guests": 4, "hours": 72, "items": [ { "adults": 2, "children": [ { "age": 7, "quantity": 2 } ], "quantity": 2 } ], "nights": 3, "room": { "adults": 2, "children": [ { "age": 7, "quantity": 2 } ], "quantity": 2 }, "rooms": 2, "startDate": "2026-07-15" }, "language": "en", "lifestyle": "LIFESTYLE_RELAX", "promotionalCodes": [ "SUMMER2026" ], "selectedRoomConfigurationIndex": 0}Example
{ "hotelIdentifier": "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "showActivities": true, "showAddOnOffers": true, "showAggregateGreenIndexScores": true, "showAnnouncements": true, "showAttractions": true, "showHotel": true, "showImages": true, "showMeetingRooms": true, "showMetadata": true, "showPlaces": true, "showRecognition": true, "showRestaurants": true, "showReviews": true, "showRoomTypes": true, "showSpas": true, "showVideos": true, "urlName": "the-siam-residences-bangkok-thailand", "userSession": { "currency": "USD", "itinerary": { "children": 4, "endDate": "2026-07-18", "guests": 4, "hours": 72, "items": [ { "adults": 2, "children": [ { "age": 7, "quantity": 2 } ], "quantity": 2 } ], "nights": 3, "room": { "adults": 2, "children": [ { "age": 7, "quantity": 2 } ], "quantity": 2 }, "rooms": 2, "startDate": "2026-07-15" }, "language": "en", "lifestyle": "LIFESTYLE_RELAX", "promotionalCodes": [ "SUMMER2026" ], "selectedRoomConfigurationIndex": 0 }}Responses
Section titled “Responses”OK
API response containing property inventory with multi-currency pricing and localized content.
object
List of property activities on and off the premises.
object
Inventory data object
object
Modify blocking availability with this flag.
Defaults to property address.
object
Address line 1
Address line 2
City name
Country
Country
County
Address 1, Address 2, City, State, Postal / Zip code, Country
Postal / zip code
State
Supported OTA specification REC code. See OTA geoname data.
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.
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.
Indicates if this inventory can be added to a booking or if it is read-only marketing material only.
Closing time of blocking (if applicable). Leave empty if blocking is always available.
Indicate whether sales channels receive commission for selling this inventory.
Associate a contact person for this inventory (if applicable).
object
Contact E-mail
Contact first name
First and last name
Contact last name
Contact phone number
Contact secondary Email
Summary
Datetime this record was first created
Indicate which days this inventory is open.
object
Convenience property to quickly determine if this existing object has any active days enabled.
Set to true to enable Friday.
Set to true to enable Monday.
Set to true to enable Saturday.
Set to true to enable Sunday.
Set to true to enable Thursday.
Set to true to enable Tuesday.
Set to true to enable Wednesday.
Localized descriptions describing inventory.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Supported OTA specification PHY code. See OTA geoname data
Indicates whether this inventory is featured. Use this flag as a way to signify that this inventory is special.
Hotel identifier.
Unique identifier for this record.
Datetime this record was last updated
Indicate the type of lifestyle this inventory should be associated with.
Geo-location point where blocking takes place. Defaults to location of property.
object
Supported OTA specification AQC code. See OTA geoname data
List of images / videos of blocking.
Multimedia that contains less information than Multimedia object
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Internal name of inventory.
Opening time of blocking (if applicable). Leave empty if blocking is always available.
Level of expensiveness.
Supported OTA specification PRX code. See OTA geoname data
Publish lifecycle state: DRAFT (incomplete, not announced) or PUBLISHED (complete/live).
Inventory-level recognition.
Recognition for the ancillary blocking.
object
Recognition category.
The date the award was received
Recognition identifier.
Use this to let hotels indicate what the total score for this award is.
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.
The name of the entity that administers this recognition.
The actual award or rating received by the hotel facility.
Provides the symbol used in the rating. Used in conjunction with the Rating.
Type of rating system the recognition operated on. This allows us to display the score properly.
Supported OTA specification RST code. See OTA geoname data
Indicates whether a reservation is required to participate in this inventory.
Supported OTA specification SEC code. See OTA geoname data
Social network accounts for blocking (if applicable).
Social network
object
URL or social network identifier to social network profile
Type of social network.
Use this property to sort an blocking in a list of activities.
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
Channel inventory identifier referencing this record.
The commission percentage.
Whether this package is commissionable based on the incoming sales channel.
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.
This is one localized bookable item that can stand alongside a restaurant / meeting room etc.
object
Localized descriptions describing inventory.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Unique transactional identifier
Whether there is a limit to maximum group size.
Whether there is a limit to minimum group size.
List of images / videos of item.
Multimedia that contains less information than Multimedia object
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Internal name of transactional blocking.
Localized offer details if rate plan discount applies.
Simplified localized description containing text content and its language code.
object
Longer text description
Indicate which language this description is written in.
Localized price
object
Channel discount percent
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in wink currency
Premium modifiers in wink currency
Promotional modifiers in wink currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Premium percent
Promotional discount percent
How many of this item is included in this price
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in hotel currency
Premium modifiers in hotel currency
Promotional modifiers in hotel currency
Hotel to wink currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Hotel to user currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in user specified currency
Premium modifiers in user specified currency
Promotional modifiers in user specified currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
How this inventory item should be priced.
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.
Localized transactional blocking
object
Localized descriptions describing inventory.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Unique transactional identifier
Whether there is a limit to maximum group size.
Whether there is a limit to minimum group size.
List of images / videos of item.
Multimedia that contains less information than Multimedia object
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Internal name of transactional blocking.
Localized offer details if rate plan discount applies.
Simplified localized description containing text content and its language code.
object
Longer text description
Indicate which language this description is written in.
Localized price
object
Channel discount percent
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in wink currency
Premium modifiers in wink currency
Promotional modifiers in wink currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Premium percent
Promotional discount percent
How many of this item is included in this price
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in hotel currency
Premium modifiers in hotel currency
Promotional modifiers in hotel currency
Hotel to wink currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Hotel to user currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in user specified currency
Premium modifiers in user specified currency
Promotional modifiers in user specified currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
How this inventory item should be priced.
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.
List of property announcements
Lightweight projection of an announcement, containing localized content and display configuration for use in traveler-facing views.
object
Datetime this record was first created
List of all localized announcements.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Date when this announcement expires and is no longer displayed.
Unique identifier of the property (managing entity) for which this announcement is configured.
Unique identifier for this record.
Datetime this record was last updated
When true, the announcement is always visible regardless of booking dates; when false, visibility is restricted to the configured start and end dates.
When true, the announcement title is displayed to travelers; when false, only the description content is shown.
Date when this announcement becomes active and visible to travelers.
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
List of property attractions on and off the premises.
object
Inventory data object
object
Modify blocking availability with this flag.
Defaults to property address.
object
Address line 1
Address line 2
City name
Country
Country
County
Address 1, Address 2, City, State, Postal / Zip code, Country
Postal / zip code
State
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.
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.
Supported OTA specification ACC code. See OTA geoname data
Indicates if this inventory can be added to a booking or if it is read-only marketing material only.
Closing time of blocking (if applicable). Leave empty if blocking is always available.
Indicate whether sales channels receive commission for selling this inventory.
Associate a contact person for this inventory (if applicable).
object
Contact E-mail
Contact first name
First and last name
Contact last name
Contact phone number
Contact secondary Email
Summary
Whether or not a courtesy phone for contacting the hotel is available at the attraction (e.g. often times these are available in airports). When true, the phone is available.
Datetime this record was first created
Indicate which days this inventory is open.
object
Convenience property to quickly determine if this existing object has any active days enabled.
Set to true to enable Friday.
Set to true to enable Monday.
Set to true to enable Saturday.
Set to true to enable Sunday.
Set to true to enable Thursday.
Set to true to enable Tuesday.
Set to true to enable Wednesday.
Localized descriptions describing inventory.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Supported OTA specification PHY code. See OTA geoname data
Indicates whether this inventory is featured. Use this flag as a way to signify that this inventory is special.
Hotel identifier.
Unique identifier for this record.
Datetime this record was last updated
Indicate the type of lifestyle this inventory should be associated with.
Geo-location point where blocking takes place. Defaults to location of property.
object
Supported OTA specification AQC code. See OTA geoname data
List of images / videos of blocking.
Multimedia that contains less information than Multimedia object
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Internal name of inventory.
Opening time of blocking (if applicable). Leave empty if blocking is always available.
Level of expensiveness.
Supported OTA specification PRX code. See OTA geoname data
Publish lifecycle state: DRAFT (incomplete, not announced) or PUBLISHED (complete/live).
Inventory-level recognition.
Recognition for the ancillary blocking.
object
Recognition category.
The date the award was received
Recognition identifier.
Use this to let hotels indicate what the total score for this award is.
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.
The name of the entity that administers this recognition.
The actual award or rating received by the hotel facility.
Provides the symbol used in the rating. Used in conjunction with the Rating.
Type of rating system the recognition operated on. This allows us to display the score properly.
Indicates whether a reservation is required to participate in this inventory.
Supported OTA specification SEC code. See OTA geoname data
Social network accounts for blocking (if applicable).
Social network
object
URL or social network identifier to social network profile
Type of social network.
Use this property to sort an blocking in a list of activities.
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
Channel inventory identifier referencing this record.
The commission percentage.
Whether this package is commissionable based on the incoming sales channel.
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.
This is one localized bookable item that can stand alongside a restaurant / meeting room etc.
object
Localized descriptions describing inventory.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Unique transactional identifier
Whether there is a limit to maximum group size.
Whether there is a limit to minimum group size.
List of images / videos of item.
Multimedia that contains less information than Multimedia object
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Internal name of transactional blocking.
Localized offer details if rate plan discount applies.
Simplified localized description containing text content and its language code.
object
Longer text description
Indicate which language this description is written in.
Localized price
object
Channel discount percent
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in wink currency
Premium modifiers in wink currency
Promotional modifiers in wink currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Premium percent
Promotional discount percent
How many of this item is included in this price
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in hotel currency
Premium modifiers in hotel currency
Promotional modifiers in hotel currency
Hotel to wink currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Hotel to user currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in user specified currency
Premium modifiers in user specified currency
Promotional modifiers in user specified currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
How this inventory item should be priced.
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.
Localized transactional blocking
object
Localized descriptions describing inventory.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Unique transactional identifier
Whether there is a limit to maximum group size.
Whether there is a limit to minimum group size.
List of images / videos of item.
Multimedia that contains less information than Multimedia object
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Internal name of transactional blocking.
Localized offer details if rate plan discount applies.
Simplified localized description containing text content and its language code.
object
Longer text description
Indicate which language this description is written in.
Localized price
object
Channel discount percent
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in wink currency
Premium modifiers in wink currency
Promotional modifiers in wink currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Premium percent
Promotional discount percent
How many of this item is included in this price
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in hotel currency
Premium modifiers in hotel currency
Promotional modifiers in hotel currency
Hotel to wink currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Hotel to user currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in user specified currency
Premium modifiers in user specified currency
Promotional modifiers in user specified currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
How this inventory item should be priced.
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.
Uses the content from roomTypes and displays the lowest price for each room type that is available.
object
Price if available
object
The active / selected cancellation policy for this room configuration
object
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.
Datetime this record was first created
Property this cancellation is associated with
Unique identifier for this record.
Datetime this record was last updated
In case the ‘Refundable cancellation charge’ is set, a different no show charge can be applied.
If the guest does not honor the non-refundable deadline rule, this charge dictates what she owes after the deadline passes.
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.
Whether this cancellation policy is refundable or not
If advanceCancellationFreeOfCharge rules is not honored, this property explains what the guest will be charged.
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
Add-ons that are available with this room configuration
object
The original add-on record created by the property.
object
Modify blocking availability with this flag.
Defaults to property address.
object
Address line 1
Address line 2
City name
Country
Country
County
Address 1, Address 2, City, State, Postal / Zip code, Country
Postal / zip code
State
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.
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.
Indicates if this inventory can be added to a booking or if it is read-only marketing material only.
Closing time of blocking (if applicable). Leave empty if blocking is always available.
Indicate whether sales channels receive commission for selling this inventory.
Associate a contact person for this inventory (if applicable).
object
Contact E-mail
Contact first name
First and last name
Contact last name
Contact phone number
Contact secondary Email
Summary
Datetime this record was first created
Optional list of date ranges restricting add-on availability to specific periods. Mutually exclusive with ratePlan.
object
Retrieve data range ending with and including this end date
Retrieve data range starting with and including this start date
Indicate which days this inventory is open.
object
Convenience property to quickly determine if this existing object has any active days enabled.
Set to true to enable Friday.
Set to true to enable Monday.
Set to true to enable Saturday.
Set to true to enable Sunday.
Set to true to enable Thursday.
Set to true to enable Tuesday.
Set to true to enable Wednesday.
Localized descriptions describing inventory.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Supported OTA specification PHY code. See OTA geoname data
Indicates whether this inventory is featured. Use this flag as a way to signify that this inventory is special.
Hotel identifier.
Unique identifier for this record.
Datetime this record was last updated
Indicate the type of lifestyle this inventory should be associated with.
Geo-location point where blocking takes place. Defaults to location of property.
object
Make this add-on mandatory for all guests by enabling this flag.
Supported OTA specification AQC code. See OTA geoname data
List of images / videos of blocking.
Multimedia that contains less information than Multimedia object
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Internal name of inventory.
Total number of add-ons available to purchase.
Opening time of blocking (if applicable). Leave empty if blocking is always available.
Level of expensiveness.
Supported OTA specification PRX code. See OTA geoname data
Publish lifecycle state: DRAFT (incomplete, not announced) or PUBLISHED (complete/live).
An optional rate plan can be applied to the add-on. The rate plan can help to create availability restrictions.
object
Everything included except alcohol
Everything included with alcohol
Days of the week on which guests are allowed to check in. If null, arrivals are permitted on any day.
object
Convenience property to quickly determine if this existing object has any active days enabled.
Set to true to enable Friday.
Set to true to enable Monday.
Set to true to enable Saturday.
Set to true to enable Sunday.
Set to true to enable Thursday.
Set to true to enable Tuesday.
Set to true to enable Wednesday.
Days of the week when this rate plan is available for booking. If null, the rate plan is available on all days.
object
Convenience property to quickly determine if this existing object has any active days enabled.
Set to true to enable Friday.
Set to true to enable Monday.
Set to true to enable Saturday.
Set to true to enable Sunday.
Set to true to enable Thursday.
Set to true to enable Tuesday.
Set to true to enable Wednesday.
When true, indicates breakfast is included.
When true, indicates brunch is included.
The cancellation policy that governs refunds and cancellations for this rate plan.
object
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.
Datetime this record was first created
Property this cancellation is associated with
Unique identifier for this record.
Datetime this record was last updated
In case the ‘Refundable cancellation charge’ is set, a different no show charge can be applied.
If the guest does not honor the non-refundable deadline rule, this charge dictates what she owes after the deadline passes.
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.
Whether this cancellation policy is refundable or not
If advanceCancellationFreeOfCharge rules is not honored, this property explains what the guest will be charged.
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
Optional overrides of the cancellation policy for specific date ranges. Allows a property to apply different cancellation terms during peak seasons, events, or special periods. Leave null for no date-specific exceptions.
object
List of cancellation policy exceptions
object
Cancellation policy details for this exception
object
Advance notice window within which a cancellation is free of charge
Fee structure applied when a guest fails to show up without cancelling
Penalty charge applied when a non-refundable booking is cancelled after the deadline
Charge applied for cancelling a non-refundable rate
Deadline before arrival after which a booking becomes non-refundable
Charge retained when a refundable booking is cancelled
Cancellation policy identifier
End date for when this cancellation policy should end overriding the default cancellation policy.
Start date for when this cancellation policy should start to override the default cancellation policy.
Datetime this record was first created
Days of the week on which guests are allowed to check out. If null, departures are permitted on any day.
object
Convenience property to quickly determine if this existing object has any active days enabled.
Set to true to enable Friday.
Set to true to enable Monday.
Set to true to enable Saturday.
Set to true to enable Sunday.
Set to true to enable Thursday.
Set to true to enable Tuesday.
Set to true to enable Wednesday.
When true, indicates dinner is included.
A pricing modifier for guests checking in early. May include a surcharge or credit. If null, no early check-in charge applies.
The property (managing entity) that owns this rate plan.
Unique identifier for this record.
Datetime this record was last updated
A pricing modifier for guests staying late after standard checkout time. May include a surcharge or credit. If null, no late check-out charge applies.
When true, guests earn loyalty points toward the property’s loyalty program with this rate plan. When false, this rate plan does not accrue points.
When true, indicates lunch is included.
Maximum number of days in advance a guest may book this rate plan. For example, 180 allows bookings up to 6 months ahead.
Maximum guest age allowed for this rate plan, typically used for family or age-restricted rates.
Maximum consecutive nights allowed for a booking under this rate plan. For example, 30 caps bookings at 30 nights.
Maximum number of guests allowed under this rate plan.
Minimum number of days in advance a guest must book this rate plan. For example, 3 requires booking at least 3 days before arrival.
Minimum guest age required to book this rate plan, typically used for senior discounts or adult-only rates.
Minimum consecutive nights required for a booking under this rate plan. For example, 2 requires a minimum 2-night stay.
Minimum number of guests required to qualify for this rate plan.
A descriptive name for this rate plan, such as ‘Best Available Rate’, ‘Non-Refundable’, or ‘Corporate Rate’.
When true, indicates if the rate is a prepaid rate.
Days of the week on which at least one night must fall within the stay. Useful for rates requiring weekend stays or specific weekday requirements. If null, no specific day-of-week stay requirements apply.
object
Convenience property to quickly determine if this existing object has any active days enabled.
Set to true to enable Friday.
Set to true to enable Monday.
Set to true to enable Saturday.
Set to true to enable Sunday.
Set to true to enable Thursday.
Set to true to enable Tuesday.
Set to true to enable Wednesday.
The date on which this rate plan is no longer available for booking. If both sellStartDate and sellEndDate are set, the rate can only be sold within that date range.
The date on which this rate plan becomes available for booking. If both sellStartDate and sellEndDate are set, the rate can only be sold within that date range.
The latest date a guest can check in to use this rate plan. If both stayStartDate and stayEndDate are set, the rate can only be used for stays within that date range.
The earliest date a guest can check in to use this rate plan. If both stayStartDate and stayEndDate are set, the rate can only be used for stays within that date range.
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
Inventory-level recognition.
Recognition for the ancillary blocking.
object
Recognition category.
The date the award was received
Recognition identifier.
Use this to let hotels indicate what the total score for this award is.
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.
The name of the entity that administers this recognition.
The actual award or rating received by the hotel facility.
Provides the symbol used in the rating. Used in conjunction with the Rating.
Type of rating system the recognition operated on. This allows us to display the score properly.
Indicates whether a reservation is required to participate in this inventory.
Supported OTA specification SEC code. See OTA geoname data
Social network accounts for blocking (if applicable).
Social network
object
URL or social network identifier to social network profile
Type of social network.
Use this property to sort an blocking in a list of activities.
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
Channel inventory identifier referencing this record.
The commission percentage.
Whether this package is commissionable based on the incoming sales channel.
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.
Localized transactional blocking
object
Localized descriptions describing inventory.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Unique transactional identifier
Whether there is a limit to maximum group size.
Whether there is a limit to minimum group size.
List of images / videos of item.
Multimedia that contains less information than Multimedia object
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Internal name of transactional blocking.
Localized offer details if rate plan discount applies.
Simplified localized description containing text content and its language code.
object
Longer text description
Indicate which language this description is written in.
Localized price
object
Channel discount percent
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in wink currency
Premium modifiers in wink currency
Promotional modifiers in wink currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Premium percent
Promotional discount percent
How many of this item is included in this price
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in hotel currency
Premium modifiers in hotel currency
Promotional modifiers in hotel currency
Hotel to wink currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Hotel to user currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in user specified currency
Premium modifiers in user specified currency
Promotional modifiers in user specified currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
How this inventory item should be priced.
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.
The actual amount of adults as determined by the hotel’s policy
Sales channel inventory identifier
The actual amount of children as determined by the hotel’s policy
The commission percentage.
Whether this package is commissionable based on the incoming sales channel.
The selected room configuration that created this record
object
Number of adult guests in this room type
Child guests in this room, with age groups
Child guest with age and quantity in a room configuration
object
Age of each child in this group (years)
Count of children of this age group in the room
Number of identical rooms with this configuration
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.
SimpleDateTimeItinerary endDate
Per rate plan level extra charges with localized prices
object
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
List of extra charges that applies to the rate plan.
object
The localized price of the extra charge
object
Channel discount percent
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in wink currency
Premium modifiers in wink currency
Promotional modifiers in wink currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Premium percent
Promotional discount percent
How many of this item is included in this price
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in hotel currency
Premium modifiers in hotel currency
Promotional modifiers in hotel currency
Hotel to wink currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Hotel to user currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in user specified currency
Premium modifiers in user specified currency
Promotional modifiers in user specified currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
What the guest is paying extra for
object
Localized descriptions of this fee in multiple languages. At least one entry in English is required.
Simplified localized description containing text content and its language code.
object
Longer text description
Indicate which language this description is written in.
The fixed fee amount in the property’s local currency.
object
Monetary amount value
ISO 4217 currency code
How this fee is charged: per day, per stay, per person per day, or per person per stay.
The localized unit price of the extra charge
object
Channel discount percent
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in wink currency
Premium modifiers in wink currency
Promotional modifiers in wink currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Premium percent
Promotional discount percent
How many of this item is included in this price
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in hotel currency
Premium modifiers in hotel currency
Promotional modifiers in hotel currency
Hotel to wink currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Hotel to user currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in user specified currency
Premium modifiers in user specified currency
Promotional modifiers in user specified currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
This is one localized bookable item that can stand alongside a restaurant / meeting room etc.
object
Localized descriptions describing inventory.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Unique transactional identifier
Whether there is a limit to maximum group size.
Whether there is a limit to minimum group size.
List of images / videos of item.
Multimedia that contains less information than Multimedia object
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Internal name of transactional blocking.
Localized offer details if rate plan discount applies.
Simplified localized description containing text content and its language code.
object
Longer text description
Indicate which language this description is written in.
Localized price
object
Channel discount percent
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in wink currency
Premium modifiers in wink currency
Promotional modifiers in wink currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Premium percent
Promotional discount percent
How many of this item is included in this price
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in hotel currency
Premium modifiers in hotel currency
Promotional modifiers in hotel currency
Hotel to wink currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Hotel to user currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in user specified currency
Premium modifiers in user specified currency
Promotional modifiers in user specified currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
How this inventory item should be priced.
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.
Perks that accompany the master rate
object
Datetime this record was first created
Localized descriptions of this perk in multiple languages. Each element provides a name, description, and language code (e.g., ‘en’, ‘fr’, ‘de’).
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Whether this perk is guaranteed to be provided or available on a best-effort basis. Guaranteed perks take priority in allocation.
Unique identifier for this record.
Datetime this record was last updated
Platform tier/value assigned to this perk (0=standard, higher=premium). Used for internal prioritization and matching with rate tiers.
Display order when showing this perk in a list (ascending sort). Lower numbers appear first; 999 is reserved for disabled/unlisted perks.
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
The combined value of these perkTypes
Calculated price
object
Available
Chanel discount percent
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in wink currency
Extra child modifier in wink currency
Extra person modifier in wink currency
Rate premiums modifiers in wink currency
Rate discount modifiers in wink currency
Singe occupant modifier in wink currency
Internal currency final price.
object
Monetary amount value
ISO 4217 currency code
Maximum occupancy
Minimum occupancy
Localized text of the discount
Simplified localized description containing text content and its language code.
object
Longer text description
Indicate which language this description is written in.
Premium percent
Promotional codes
Promotional discount percent
Quantity
Source
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in hotel’s currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in hotel currency
Extra child modifier in hotel currency
Extra person modifier in hotel currency.
Rate premiums modifiers in hotel currency
Rate discount modifiers in hotel currency
Single occupant modifier in hotel currency
Hotel to wink currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Hotel to user currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Source currency final price.
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in user specified currency
Extra child modifier in user specified currcency
Extra person modifier in user specified currency
Rate premiums modifiers in user specified currency
Rate discount modifiers in user specified currency
Single occupant modifier in user specified currency
User-defined currency final price.
object
Monetary amount value
ISO 4217 currency code
Localized transactional blocking
object
Localized descriptions describing inventory.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Unique transactional identifier
Whether there is a limit to maximum group size.
Whether there is a limit to minimum group size.
List of images / videos of item.
Multimedia that contains less information than Multimedia object
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Internal name of transactional blocking.
Localized offer details if rate plan discount applies.
Simplified localized description containing text content and its language code.
object
Longer text description
Indicate which language this description is written in.
Localized price
object
Channel discount percent
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in wink currency
Premium modifiers in wink currency
Promotional modifiers in wink currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Premium percent
Promotional discount percent
How many of this item is included in this price
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in hotel currency
Premium modifiers in hotel currency
Promotional modifiers in hotel currency
Hotel to wink currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Hotel to user currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in user specified currency
Premium modifiers in user specified currency
Promotional modifiers in user specified currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
How this inventory item should be priced.
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.
Specified rate plan
object
Everything included except alcohol
Everything included with alcohol
When true, indicates breakfast is included.
When true, indicates brunch is included.
When true, indicates dinner is included.
Rate plan identifier
When true, indicates lunch is included.
Provides the name of the rate plan.
Number of nights the guests will be staying
Specified master rate identifier
Specified master rate internal name
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
SimpleDateTimeItinerary startDate
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
The room type
object
Modify blocking availability with this flag.
Defaults to property address.
object
Address line 1
Address line 2
City name
Country
Country
County
Address 1, Address 2, City, State, Postal / Zip code, Country
Postal / zip code
State
OpenTravel room amenity codes (e.g., 1=Balcony, 7=Air Conditioning). See OTA geoname data
Number of bathrooms
A room type can have more than one bed configuration.
A named bedroom layout configuration for a room type, containing one or more bedrooms each with their own bed setup.
object
List of bedrooms within this configuration layout.
A single bedroom within a room type, specifying the bedroom type and its bed configuration.
object
List of bed configurations for this bedroom. Each entry specifies a bed type and quantity.
A single bed type and its quantity within a bedroom, described using the OpenTravel bed type code.
object
OpenTravel bed type code (e.g., 1=Double, 2=Twin, 7=Queen, 8=King). See OTA geoname data.
Number of beds of this type in the room.
Bedroom type classification (e.g., MASTER, QUEEN, JUNIOR, DORMITORY, BEDROOM_1…BEDROOM_10).
Unique identifier for this bedroom configuration layout.
Human-readable name of this room layout configuration.
Indicates if this inventory can be added to a booking or if it is read-only marketing material only.
Indicate whether sales channels receive commission for selling this inventory.
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.
Associate a contact person for this inventory (if applicable).
object
Contact E-mail
Contact first name
First and last name
Contact last name
Contact phone number
Contact secondary Email
Summary
Datetime this record was first created
Localized descriptions describing inventory.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Supported OTA specification PHY code. See OTA geoname data
Indicates whether this inventory is featured. Use this flag as a way to signify that this inventory is special.
Floor number on which this room type is located.
Hotel identifier.
Unique identifier for this record.
The number of pax the room price was meant for
The number of children the room price was meant for
Datetime this record was last updated
Indicate the type of lifestyle this inventory should be associated with.
Number of living rooms
Geo-location point where blocking takes place. Defaults to location of property.
object
Maximum number of adults allowed in a room type.
Maximum number of children allowed in a room type.
Maximum number of cribs allowed in a room type.
Maximum number of guest allowed in a room type.
Maximum number of rollaway beds allowed in this room type.
Supported OTA specification AQC code. See OTA geoname data
Minimum number of guests allowed in a room type.
List of images / videos of blocking.
Multimedia that contains less information than Multimedia object
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Internal name of inventory.
Non-smoking indicator
Level of expensiveness.
Supported OTA specification PRX code. See OTA geoname data
Publish lifecycle state: DRAFT (incomplete, not announced) or PUBLISHED (complete/live).
Defines the number of rooms of this type
Inventory-level recognition.
Recognition for the ancillary blocking.
object
Recognition category.
The date the award was received
Recognition identifier.
Use this to let hotels indicate what the total score for this award is.
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.
The name of the entity that administers this recognition.
The actual award or rating received by the hotel facility.
Provides the symbol used in the rating. Used in conjunction with the Rating.
Type of rating system the recognition operated on. This allows us to display the score properly.
OpenTravel architectural style code (e.g., 1=Modern, 2=Traditional, 3=Victorian). See OTA geoname data
OpenTravel segment category code (e.g., 1=Moderate, 4=Standard, 8=Deluxe). See OTA geoname data
OpenTravel guest room info code (e.g., 1=Suite, 2=Standard, 12=Villa, 16=Bungalow). See OTA geoname data
Used to request or specify a gender assignment for a room. Note: Typically used by Hosteliers.
OpenTravel room location type code (e.g., 1=Near Exit, 2=Close to Elevator, 3=Low Floor, 4=High Floor). See OTA geoname data
OpenTravel room view type code (e.g., 1=Ocean View, 2=Pool View, 3=Garden View). See OTA geoname data
Supported OTA specification SEC code. See OTA geoname data
If TRUE, the room requires or has sharing available. Note: Typically used by Hosteliers.
Number of square meters that defines the size of this room type.
Social network accounts for blocking (if applicable).
Social network
object
URL or social network identifier to social network profile
Type of social network.
Use this property to sort an blocking in a list of activities.
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
Detailed Green Index scores on hoe the property scores by category
object
Total score divided by high score
The highest possible score from all questions
A single scored answer to a Green Index sustainability question for a property.
object
Unique key identifying the Green Index question that was answered.
Score awarded for this answer (contributes toward the category high score).
Aggregate scores by Green Index category
Aggregated Green Index score for a single question category, showing how many sustainability points a property earned versus the maximum possible for that category.
object
Total score divided by high score within this category
Green Index category
The highest possible score from all questions within this category
The total score from all questions answered within this category
The total score from all questions answered
Property details
object
Number of activites property has listed on its profile.
Number of add-ons property has on its profile.
Property address.
object
Address line 1
Address line 2
City name
Country
Country
County
Address 1, Address 2, City, State, Postal / Zip code, Country
Postal / zip code
State
Aggregate Green Index score if the property has answered our questionnaire available in the Extranet.
Aggregate score based on all current user reviews.
Supported OTA specification ARC code. See OTA geoname data
Number of attractions property has listed on its profile.
Whether property is available
Number of bookings for this property on the wink.travel platform.
Name of hotel brand
Name of hotel chain if applicable.
City location
object
Ascii name of city
Country
object
Country capital
Continent code
Currency code
Currency name
Country GeoNames identifier
ISO code
Country name
ISO 3166-1 alpha-2 country code for the country this location belongs to
GeoNames specific feature code identifying the place type (e.g. PPL=populated place, PPLC=national capital, ISL=island)
GeoName identifier
Coordinate points of the city
object
Name of city
Country sub division
object
Sub-country ascii name
Sub-country GeoNames identifier
Sub-country name
Country sub sub division
object
ASCII-transliterated name of the county or district, safe for URLs and sorting
GeoNames.org unique identifier for this subdivision
Official name of the county or district in its local script
IANA timezone identifier for the location
GeoNameLightweight type
Url name
Currency code for property.
Short and long welcome text
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
General manager of the property.
object
Localized welcome message from GM.
Simplified localized description containing text content and its language code.
object
Longer text description
Indicate which language this description is written in.
Profile image of the general manager.
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Name of GM currently managing the property.
Supported OTA specification HAC code. See OTA geoname data
Supported OTA specification PCT code. See OTA geoname data
Unique hotel record identifier.
Property images.
Multimedia that contains less information than Multimedia object
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Timestamp of the last update to this property aggregate record.
Hotel local name if different from the trade name or if it is the local language.
Geo-location
object
Supported OTA specification LOC code. See OTA geoname data
Number of meeting rooms property has on its profile.
Hotel trade name
Number of rooms / keys for this property.
Number of places property has listed on its profile.
Basic property policy record.
object
When the guest can check in.
When the guest has to check out.
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 where internet is available in and around the property.
Indicates how guests can access the Internet on the property.
Indicates what type of parking is available at the property.
Indicates whether parking is available at the property.
If pets are allowed, property can tell travelers if there is a charge applicable for the pet.
object
Monetary amount value
ISO 4217 currency code
If pets are allowed, property can further limit on weight.
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.
Supported OTA specification PHY code. See OTA geoname data
Supported OTA specification SEC code. See OTA geoname data
Contact details for reservations desk
object
Contact E-mail
Contact first name
First and last name
Contact last name
Contact phone number
Contact secondary Email
Summary
Number of restaurants property has on its profile.
Demand score (0-100) derived from booking volume and review rating. Recomputed monthly; used to rank properties in search results.
Supported OTA specification SEG code. See OTA geoname data
Property’s social network accounts
Social network
object
URL or social network identifier to social network profile
Type of social network.
Number of spas property has on its profile.
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.
Array of awards and third party reviews given to property by certified / non-certified providers.
Recognition for the ancillary blocking.
object
Recognition category.
The date the award was received
Recognition identifier.
Use this to let hotels indicate what the total score for this award is.
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.
The name of the entity that administers this recognition.
The actual award or rating received by the hotel facility.
Provides the symbol used in the rating. Used in conjunction with the Rating.
Type of rating system the recognition operated on. This allows us to display the score properly.
Count of total reviews left by users at this property.
Event shorter name
Unique URL-friendly name slug of hotel
Property videos.
Multimedia that contains less information than Multimedia object
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Year the property was constructed.
Unique property identifier to retrieve inventory for.
List of property images
Multimedia that contains less information than Multimedia object
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Uses the content from roomTypes and shows the room type with the lowest price.
object
Price if available
object
The active / selected cancellation policy for this room configuration
object
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.
Datetime this record was first created
Property this cancellation is associated with
Unique identifier for this record.
Datetime this record was last updated
In case the ‘Refundable cancellation charge’ is set, a different no show charge can be applied.
If the guest does not honor the non-refundable deadline rule, this charge dictates what she owes after the deadline passes.
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.
Whether this cancellation policy is refundable or not
If advanceCancellationFreeOfCharge rules is not honored, this property explains what the guest will be charged.
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
Add-ons that are available with this room configuration
object
The original add-on record created by the property.
object
Modify blocking availability with this flag.
Defaults to property address.
object
Address line 1
Address line 2
City name
Country
Country
County
Address 1, Address 2, City, State, Postal / Zip code, Country
Postal / zip code
State
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.
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.
Indicates if this inventory can be added to a booking or if it is read-only marketing material only.
Closing time of blocking (if applicable). Leave empty if blocking is always available.
Indicate whether sales channels receive commission for selling this inventory.
Associate a contact person for this inventory (if applicable).
object
Contact E-mail
Contact first name
First and last name
Contact last name
Contact phone number
Contact secondary Email
Summary
Datetime this record was first created
Optional list of date ranges restricting add-on availability to specific periods. Mutually exclusive with ratePlan.
object
Retrieve data range ending with and including this end date
Retrieve data range starting with and including this start date
Indicate which days this inventory is open.
object
Convenience property to quickly determine if this existing object has any active days enabled.
Set to true to enable Friday.
Set to true to enable Monday.
Set to true to enable Saturday.
Set to true to enable Sunday.
Set to true to enable Thursday.
Set to true to enable Tuesday.
Set to true to enable Wednesday.
Localized descriptions describing inventory.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Supported OTA specification PHY code. See OTA geoname data
Indicates whether this inventory is featured. Use this flag as a way to signify that this inventory is special.
Hotel identifier.
Unique identifier for this record.
Datetime this record was last updated
Indicate the type of lifestyle this inventory should be associated with.
Geo-location point where blocking takes place. Defaults to location of property.
object
Make this add-on mandatory for all guests by enabling this flag.
Supported OTA specification AQC code. See OTA geoname data
List of images / videos of blocking.
Multimedia that contains less information than Multimedia object
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Internal name of inventory.
Total number of add-ons available to purchase.
Opening time of blocking (if applicable). Leave empty if blocking is always available.
Level of expensiveness.
Supported OTA specification PRX code. See OTA geoname data
Publish lifecycle state: DRAFT (incomplete, not announced) or PUBLISHED (complete/live).
An optional rate plan can be applied to the add-on. The rate plan can help to create availability restrictions.
object
Everything included except alcohol
Everything included with alcohol
Days of the week on which guests are allowed to check in. If null, arrivals are permitted on any day.
object
Convenience property to quickly determine if this existing object has any active days enabled.
Set to true to enable Friday.
Set to true to enable Monday.
Set to true to enable Saturday.
Set to true to enable Sunday.
Set to true to enable Thursday.
Set to true to enable Tuesday.
Set to true to enable Wednesday.
Days of the week when this rate plan is available for booking. If null, the rate plan is available on all days.
object
Convenience property to quickly determine if this existing object has any active days enabled.
Set to true to enable Friday.
Set to true to enable Monday.
Set to true to enable Saturday.
Set to true to enable Sunday.
Set to true to enable Thursday.
Set to true to enable Tuesday.
Set to true to enable Wednesday.
When true, indicates breakfast is included.
When true, indicates brunch is included.
The cancellation policy that governs refunds and cancellations for this rate plan.
object
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.
Datetime this record was first created
Property this cancellation is associated with
Unique identifier for this record.
Datetime this record was last updated
In case the ‘Refundable cancellation charge’ is set, a different no show charge can be applied.
If the guest does not honor the non-refundable deadline rule, this charge dictates what she owes after the deadline passes.
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.
Whether this cancellation policy is refundable or not
If advanceCancellationFreeOfCharge rules is not honored, this property explains what the guest will be charged.
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
Optional overrides of the cancellation policy for specific date ranges. Allows a property to apply different cancellation terms during peak seasons, events, or special periods. Leave null for no date-specific exceptions.
object
List of cancellation policy exceptions
object
Cancellation policy details for this exception
object
Advance notice window within which a cancellation is free of charge
Fee structure applied when a guest fails to show up without cancelling
Penalty charge applied when a non-refundable booking is cancelled after the deadline
Charge applied for cancelling a non-refundable rate
Deadline before arrival after which a booking becomes non-refundable
Charge retained when a refundable booking is cancelled
Cancellation policy identifier
End date for when this cancellation policy should end overriding the default cancellation policy.
Start date for when this cancellation policy should start to override the default cancellation policy.
Datetime this record was first created
Days of the week on which guests are allowed to check out. If null, departures are permitted on any day.
object
Convenience property to quickly determine if this existing object has any active days enabled.
Set to true to enable Friday.
Set to true to enable Monday.
Set to true to enable Saturday.
Set to true to enable Sunday.
Set to true to enable Thursday.
Set to true to enable Tuesday.
Set to true to enable Wednesday.
When true, indicates dinner is included.
A pricing modifier for guests checking in early. May include a surcharge or credit. If null, no early check-in charge applies.
The property (managing entity) that owns this rate plan.
Unique identifier for this record.
Datetime this record was last updated
A pricing modifier for guests staying late after standard checkout time. May include a surcharge or credit. If null, no late check-out charge applies.
When true, guests earn loyalty points toward the property’s loyalty program with this rate plan. When false, this rate plan does not accrue points.
When true, indicates lunch is included.
Maximum number of days in advance a guest may book this rate plan. For example, 180 allows bookings up to 6 months ahead.
Maximum guest age allowed for this rate plan, typically used for family or age-restricted rates.
Maximum consecutive nights allowed for a booking under this rate plan. For example, 30 caps bookings at 30 nights.
Maximum number of guests allowed under this rate plan.
Minimum number of days in advance a guest must book this rate plan. For example, 3 requires booking at least 3 days before arrival.
Minimum guest age required to book this rate plan, typically used for senior discounts or adult-only rates.
Minimum consecutive nights required for a booking under this rate plan. For example, 2 requires a minimum 2-night stay.
Minimum number of guests required to qualify for this rate plan.
A descriptive name for this rate plan, such as ‘Best Available Rate’, ‘Non-Refundable’, or ‘Corporate Rate’.
When true, indicates if the rate is a prepaid rate.
Days of the week on which at least one night must fall within the stay. Useful for rates requiring weekend stays or specific weekday requirements. If null, no specific day-of-week stay requirements apply.
object
Convenience property to quickly determine if this existing object has any active days enabled.
Set to true to enable Friday.
Set to true to enable Monday.
Set to true to enable Saturday.
Set to true to enable Sunday.
Set to true to enable Thursday.
Set to true to enable Tuesday.
Set to true to enable Wednesday.
The date on which this rate plan is no longer available for booking. If both sellStartDate and sellEndDate are set, the rate can only be sold within that date range.
The date on which this rate plan becomes available for booking. If both sellStartDate and sellEndDate are set, the rate can only be sold within that date range.
The latest date a guest can check in to use this rate plan. If both stayStartDate and stayEndDate are set, the rate can only be used for stays within that date range.
The earliest date a guest can check in to use this rate plan. If both stayStartDate and stayEndDate are set, the rate can only be used for stays within that date range.
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
Inventory-level recognition.
Recognition for the ancillary blocking.
object
Recognition category.
The date the award was received
Recognition identifier.
Use this to let hotels indicate what the total score for this award is.
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.
The name of the entity that administers this recognition.
The actual award or rating received by the hotel facility.
Provides the symbol used in the rating. Used in conjunction with the Rating.
Type of rating system the recognition operated on. This allows us to display the score properly.
Indicates whether a reservation is required to participate in this inventory.
Supported OTA specification SEC code. See OTA geoname data
Social network accounts for blocking (if applicable).
Social network
object
URL or social network identifier to social network profile
Type of social network.
Use this property to sort an blocking in a list of activities.
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
Channel inventory identifier referencing this record.
The commission percentage.
Whether this package is commissionable based on the incoming sales channel.
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.
Localized transactional blocking
object
Localized descriptions describing inventory.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Unique transactional identifier
Whether there is a limit to maximum group size.
Whether there is a limit to minimum group size.
List of images / videos of item.
Multimedia that contains less information than Multimedia object
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Internal name of transactional blocking.
Localized offer details if rate plan discount applies.
Simplified localized description containing text content and its language code.
object
Longer text description
Indicate which language this description is written in.
Localized price
object
Channel discount percent
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in wink currency
Premium modifiers in wink currency
Promotional modifiers in wink currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Premium percent
Promotional discount percent
How many of this item is included in this price
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in hotel currency
Premium modifiers in hotel currency
Promotional modifiers in hotel currency
Hotel to wink currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Hotel to user currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in user specified currency
Premium modifiers in user specified currency
Promotional modifiers in user specified currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
How this inventory item should be priced.
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.
The actual amount of adults as determined by the hotel’s policy
Sales channel inventory identifier
The actual amount of children as determined by the hotel’s policy
The commission percentage.
Whether this package is commissionable based on the incoming sales channel.
The selected room configuration that created this record
object
Number of adult guests in this room type
Child guests in this room, with age groups
Child guest with age and quantity in a room configuration
object
Age of each child in this group (years)
Count of children of this age group in the room
Number of identical rooms with this configuration
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.
SimpleDateTimeItinerary endDate
Per rate plan level extra charges with localized prices
object
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
List of extra charges that applies to the rate plan.
object
The localized price of the extra charge
object
Channel discount percent
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in wink currency
Premium modifiers in wink currency
Promotional modifiers in wink currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Premium percent
Promotional discount percent
How many of this item is included in this price
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in hotel currency
Premium modifiers in hotel currency
Promotional modifiers in hotel currency
Hotel to wink currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Hotel to user currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in user specified currency
Premium modifiers in user specified currency
Promotional modifiers in user specified currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
What the guest is paying extra for
object
Localized descriptions of this fee in multiple languages. At least one entry in English is required.
Simplified localized description containing text content and its language code.
object
Longer text description
Indicate which language this description is written in.
The fixed fee amount in the property’s local currency.
object
Monetary amount value
ISO 4217 currency code
How this fee is charged: per day, per stay, per person per day, or per person per stay.
The localized unit price of the extra charge
object
Channel discount percent
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in wink currency
Premium modifiers in wink currency
Promotional modifiers in wink currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Premium percent
Promotional discount percent
How many of this item is included in this price
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in hotel currency
Premium modifiers in hotel currency
Promotional modifiers in hotel currency
Hotel to wink currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Hotel to user currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in user specified currency
Premium modifiers in user specified currency
Promotional modifiers in user specified currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
This is one localized bookable item that can stand alongside a restaurant / meeting room etc.
object
Localized descriptions describing inventory.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Unique transactional identifier
Whether there is a limit to maximum group size.
Whether there is a limit to minimum group size.
List of images / videos of item.
Multimedia that contains less information than Multimedia object
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Internal name of transactional blocking.
Localized offer details if rate plan discount applies.
Simplified localized description containing text content and its language code.
object
Longer text description
Indicate which language this description is written in.
Localized price
object
Channel discount percent
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in wink currency
Premium modifiers in wink currency
Promotional modifiers in wink currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Premium percent
Promotional discount percent
How many of this item is included in this price
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in hotel currency
Premium modifiers in hotel currency
Promotional modifiers in hotel currency
Hotel to wink currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Hotel to user currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in user specified currency
Premium modifiers in user specified currency
Promotional modifiers in user specified currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
How this inventory item should be priced.
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.
Perks that accompany the master rate
object
Datetime this record was first created
Localized descriptions of this perk in multiple languages. Each element provides a name, description, and language code (e.g., ‘en’, ‘fr’, ‘de’).
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Whether this perk is guaranteed to be provided or available on a best-effort basis. Guaranteed perks take priority in allocation.
Unique identifier for this record.
Datetime this record was last updated
Platform tier/value assigned to this perk (0=standard, higher=premium). Used for internal prioritization and matching with rate tiers.
Display order when showing this perk in a list (ascending sort). Lower numbers appear first; 999 is reserved for disabled/unlisted perks.
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
The combined value of these perkTypes
Calculated price
object
Available
Chanel discount percent
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in wink currency
Extra child modifier in wink currency
Extra person modifier in wink currency
Rate premiums modifiers in wink currency
Rate discount modifiers in wink currency
Singe occupant modifier in wink currency
Internal currency final price.
object
Monetary amount value
ISO 4217 currency code
Maximum occupancy
Minimum occupancy
Localized text of the discount
Simplified localized description containing text content and its language code.
object
Longer text description
Indicate which language this description is written in.
Premium percent
Promotional codes
Promotional discount percent
Quantity
Source
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in hotel’s currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in hotel currency
Extra child modifier in hotel currency
Extra person modifier in hotel currency.
Rate premiums modifiers in hotel currency
Rate discount modifiers in hotel currency
Single occupant modifier in hotel currency
Hotel to wink currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Hotel to user currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Source currency final price.
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in user specified currency
Extra child modifier in user specified currcency
Extra person modifier in user specified currency
Rate premiums modifiers in user specified currency
Rate discount modifiers in user specified currency
Single occupant modifier in user specified currency
User-defined currency final price.
object
Monetary amount value
ISO 4217 currency code
Localized transactional blocking
object
Localized descriptions describing inventory.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Unique transactional identifier
Whether there is a limit to maximum group size.
Whether there is a limit to minimum group size.
List of images / videos of item.
Multimedia that contains less information than Multimedia object
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Internal name of transactional blocking.
Localized offer details if rate plan discount applies.
Simplified localized description containing text content and its language code.
object
Longer text description
Indicate which language this description is written in.
Localized price
object
Channel discount percent
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in wink currency
Premium modifiers in wink currency
Promotional modifiers in wink currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Premium percent
Promotional discount percent
How many of this item is included in this price
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in hotel currency
Premium modifiers in hotel currency
Promotional modifiers in hotel currency
Hotel to wink currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Hotel to user currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in user specified currency
Premium modifiers in user specified currency
Promotional modifiers in user specified currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
How this inventory item should be priced.
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.
Specified rate plan
object
Everything included except alcohol
Everything included with alcohol
When true, indicates breakfast is included.
When true, indicates brunch is included.
When true, indicates dinner is included.
Rate plan identifier
When true, indicates lunch is included.
Provides the name of the rate plan.
Number of nights the guests will be staying
Specified master rate identifier
Specified master rate internal name
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
SimpleDateTimeItinerary startDate
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
The room type
object
Modify blocking availability with this flag.
Defaults to property address.
object
Address line 1
Address line 2
City name
Country
Country
County
Address 1, Address 2, City, State, Postal / Zip code, Country
Postal / zip code
State
OpenTravel room amenity codes (e.g., 1=Balcony, 7=Air Conditioning). See OTA geoname data
Number of bathrooms
A room type can have more than one bed configuration.
A named bedroom layout configuration for a room type, containing one or more bedrooms each with their own bed setup.
object
List of bedrooms within this configuration layout.
A single bedroom within a room type, specifying the bedroom type and its bed configuration.
object
List of bed configurations for this bedroom. Each entry specifies a bed type and quantity.
A single bed type and its quantity within a bedroom, described using the OpenTravel bed type code.
object
OpenTravel bed type code (e.g., 1=Double, 2=Twin, 7=Queen, 8=King). See OTA geoname data.
Number of beds of this type in the room.
Bedroom type classification (e.g., MASTER, QUEEN, JUNIOR, DORMITORY, BEDROOM_1…BEDROOM_10).
Unique identifier for this bedroom configuration layout.
Human-readable name of this room layout configuration.
Indicates if this inventory can be added to a booking or if it is read-only marketing material only.
Indicate whether sales channels receive commission for selling this inventory.
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.
Associate a contact person for this inventory (if applicable).
object
Contact E-mail
Contact first name
First and last name
Contact last name
Contact phone number
Contact secondary Email
Summary
Datetime this record was first created
Localized descriptions describing inventory.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Supported OTA specification PHY code. See OTA geoname data
Indicates whether this inventory is featured. Use this flag as a way to signify that this inventory is special.
Floor number on which this room type is located.
Hotel identifier.
Unique identifier for this record.
The number of pax the room price was meant for
The number of children the room price was meant for
Datetime this record was last updated
Indicate the type of lifestyle this inventory should be associated with.
Number of living rooms
Geo-location point where blocking takes place. Defaults to location of property.
object
Maximum number of adults allowed in a room type.
Maximum number of children allowed in a room type.
Maximum number of cribs allowed in a room type.
Maximum number of guest allowed in a room type.
Maximum number of rollaway beds allowed in this room type.
Supported OTA specification AQC code. See OTA geoname data
Minimum number of guests allowed in a room type.
List of images / videos of blocking.
Multimedia that contains less information than Multimedia object
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Internal name of inventory.
Non-smoking indicator
Level of expensiveness.
Supported OTA specification PRX code. See OTA geoname data
Publish lifecycle state: DRAFT (incomplete, not announced) or PUBLISHED (complete/live).
Defines the number of rooms of this type
Inventory-level recognition.
Recognition for the ancillary blocking.
object
Recognition category.
The date the award was received
Recognition identifier.
Use this to let hotels indicate what the total score for this award is.
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.
The name of the entity that administers this recognition.
The actual award or rating received by the hotel facility.
Provides the symbol used in the rating. Used in conjunction with the Rating.
Type of rating system the recognition operated on. This allows us to display the score properly.
OpenTravel architectural style code (e.g., 1=Modern, 2=Traditional, 3=Victorian). See OTA geoname data
OpenTravel segment category code (e.g., 1=Moderate, 4=Standard, 8=Deluxe). See OTA geoname data
OpenTravel guest room info code (e.g., 1=Suite, 2=Standard, 12=Villa, 16=Bungalow). See OTA geoname data
Used to request or specify a gender assignment for a room. Note: Typically used by Hosteliers.
OpenTravel room location type code (e.g., 1=Near Exit, 2=Close to Elevator, 3=Low Floor, 4=High Floor). See OTA geoname data
OpenTravel room view type code (e.g., 1=Ocean View, 2=Pool View, 3=Garden View). See OTA geoname data
Supported OTA specification SEC code. See OTA geoname data
If TRUE, the room requires or has sharing available. Note: Typically used by Hosteliers.
Number of square meters that defines the size of this room type.
Social network accounts for blocking (if applicable).
Social network
object
URL or social network identifier to social network profile
Type of social network.
Use this property to sort an blocking in a list of activities.
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
List of property meeting rooms on and off the premises.
object
Channel inventory identifier referencing this record.
The commission percentage.
Whether this package is commissionable based on the incoming sales channel.
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.
This is one localized bookable item that can stand alongside a restaurant / meeting room etc.
object
Localized descriptions describing inventory.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Unique transactional identifier
Whether there is a limit to maximum group size.
Whether there is a limit to minimum group size.
List of images / videos of item.
Multimedia that contains less information than Multimedia object
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Internal name of transactional blocking.
Localized offer details if rate plan discount applies.
Simplified localized description containing text content and its language code.
object
Longer text description
Indicate which language this description is written in.
Localized price
object
Channel discount percent
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in wink currency
Premium modifiers in wink currency
Promotional modifiers in wink currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Premium percent
Promotional discount percent
How many of this item is included in this price
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in hotel currency
Premium modifiers in hotel currency
Promotional modifiers in hotel currency
Hotel to wink currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Hotel to user currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in user specified currency
Premium modifiers in user specified currency
Promotional modifiers in user specified currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
How this inventory item should be priced.
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.
Inventory data object
object
The type of access to the meeting space.
Modify blocking availability with this flag.
Defaults to property address.
object
Address line 1
Address line 2
City name
Country
Country
County
Address 1, Address 2, City, State, Postal / Zip code, Country
Postal / zip code
State
Supported OTA specification MRC code. See OTA geoname data.
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.
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.
Area (in square meters) of this meeting room.
Indicates if this inventory can be added to a booking or if it is read-only marketing material only.
Closing time of blocking (if applicable). Leave empty if blocking is always available.
Indicate whether sales channels receive commission for selling this inventory.
Associate a contact person for this inventory (if applicable).
object
Contact E-mail
Contact first name
First and last name
Contact last name
Contact phone number
Contact secondary Email
Summary
Datetime this record was first created
Indicate which days this inventory is open.
object
Convenience property to quickly determine if this existing object has any active days enabled.
Set to true to enable Friday.
Set to true to enable Monday.
Set to true to enable Saturday.
Set to true to enable Sunday.
Set to true to enable Thursday.
Set to true to enable Tuesday.
Set to true to enable Wednesday.
When true, the room is used for a single purpose as indicated by the MeetingRoomTypeCode attribute.
Localized descriptions describing inventory.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Supported OTA specification PHY code. See OTA geoname data
Indicates whether this inventory is featured. Use this flag as a way to signify that this inventory is special.
Height (in meters) of this meeting room.
Hotel identifier.
Unique identifier for this record.
Room has an irregular shape. If true, the room would be of a traditional square or rectangular shape.
Datetime this record was last updated
Length (in meters) of this meeting room.
Indicate the type of lifestyle this inventory should be associated with.
Geo-location point where blocking takes place. Defaults to location of property.
object
The total number of people permitted in the meeting room.
Defines the level in the facility where the meeting room is located.
Supported OTA specification MRF code. See OTA geoname data.
Supported OTA specification AQC code. See OTA geoname data
List of images / videos of blocking.
Multimedia that contains less information than Multimedia object
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Internal name of inventory.
Opening time of blocking (if applicable). Leave empty if blocking is always available.
Level of expensiveness.
Supported OTA specification PRX code. See OTA geoname data
Publish lifecycle state: DRAFT (incomplete, not announced) or PUBLISHED (complete/live).
Inventory-level recognition.
Recognition for the ancillary blocking.
object
Recognition category.
The date the award was received
Recognition identifier.
Use this to let hotels indicate what the total score for this award is.
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.
The name of the entity that administers this recognition.
The actual award or rating received by the hotel facility.
Provides the symbol used in the rating. Used in conjunction with the Rating.
Type of rating system the recognition operated on. This allows us to display the score properly.
Indicates whether a reservation is required to participate in this inventory.
Supported OTA specification SEC code. See OTA geoname data
Social network accounts for blocking (if applicable).
Social network
object
URL or social network identifier to social network profile
Type of social network.
Use this property to sort an blocking in a list of activities.
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
Width (in meters) of this meeting room.
Localized transactional blocking
object
Localized descriptions describing inventory.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Unique transactional identifier
Whether there is a limit to maximum group size.
Whether there is a limit to minimum group size.
List of images / videos of item.
Multimedia that contains less information than Multimedia object
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Internal name of transactional blocking.
Localized offer details if rate plan discount applies.
Simplified localized description containing text content and its language code.
object
Longer text description
Indicate which language this description is written in.
Localized price
object
Channel discount percent
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in wink currency
Premium modifiers in wink currency
Promotional modifiers in wink currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Premium percent
Promotional discount percent
How many of this item is included in this price
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in hotel currency
Premium modifiers in hotel currency
Promotional modifiers in hotel currency
Hotel to wink currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Hotel to user currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in user specified currency
Premium modifiers in user specified currency
Promotional modifiers in user specified currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
How this inventory item should be priced.
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.
List of property meta data.
A single metadata entry associated with a property, used for page titles, SEO meta tags, and other key-value annotations.
object
Metadata key identifier.
Category of this metadata entry.
Metadata value associated with the key.
List of property places on and off the premises.
object
Channel inventory identifier referencing this record.
The commission percentage.
Whether this package is commissionable based on the incoming sales channel.
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.
This is one localized bookable item that can stand alongside a restaurant / meeting room etc.
object
Localized descriptions describing inventory.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Unique transactional identifier
Whether there is a limit to maximum group size.
Whether there is a limit to minimum group size.
List of images / videos of item.
Multimedia that contains less information than Multimedia object
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Internal name of transactional blocking.
Localized offer details if rate plan discount applies.
Simplified localized description containing text content and its language code.
object
Longer text description
Indicate which language this description is written in.
Localized price
object
Channel discount percent
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in wink currency
Premium modifiers in wink currency
Promotional modifiers in wink currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Premium percent
Promotional discount percent
How many of this item is included in this price
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in hotel currency
Premium modifiers in hotel currency
Promotional modifiers in hotel currency
Hotel to wink currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Hotel to user currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in user specified currency
Premium modifiers in user specified currency
Promotional modifiers in user specified currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
How this inventory item should be priced.
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.
Inventory data object
object
Modify blocking availability with this flag.
Defaults to property address.
object
Address line 1
Address line 2
City name
Country
Country
County
Address 1, Address 2, City, State, Postal / Zip code, Country
Postal / zip code
State
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.
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.
Indicates if this inventory can be added to a booking or if it is read-only marketing material only.
Closing time of blocking (if applicable). Leave empty if blocking is always available.
Indicate whether sales channels receive commission for selling this inventory.
Associate a contact person for this inventory (if applicable).
object
Contact E-mail
Contact first name
First and last name
Contact last name
Contact phone number
Contact secondary Email
Summary
Datetime this record was first created
Indicate which days this inventory is open.
object
Convenience property to quickly determine if this existing object has any active days enabled.
Set to true to enable Friday.
Set to true to enable Monday.
Set to true to enable Saturday.
Set to true to enable Sunday.
Set to true to enable Thursday.
Set to true to enable Tuesday.
Set to true to enable Wednesday.
Localized descriptions describing inventory.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Supported OTA specification PHY code. See OTA geoname data
Indicates whether this inventory is featured. Use this flag as a way to signify that this inventory is special.
Hotel identifier.
Unique identifier for this record.
Datetime this record was last updated
Indicate the type of lifestyle this inventory should be associated with.
Geo-location point where blocking takes place. Defaults to location of property.
object
Supported OTA specification AQC code. See OTA geoname data
List of images / videos of blocking.
Multimedia that contains less information than Multimedia object
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Internal name of inventory.
Opening time of blocking (if applicable). Leave empty if blocking is always available.
Level of expensiveness.
Supported OTA specification PRX code. See OTA geoname data
Publish lifecycle state: DRAFT (incomplete, not announced) or PUBLISHED (complete/live).
Inventory-level recognition.
Recognition for the ancillary blocking.
object
Recognition category.
The date the award was received
Recognition identifier.
Use this to let hotels indicate what the total score for this award is.
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.
The name of the entity that administers this recognition.
The actual award or rating received by the hotel facility.
Provides the symbol used in the rating. Used in conjunction with the Rating.
Type of rating system the recognition operated on. This allows us to display the score properly.
Supported OTA specification REF code. See OTA geoname data.
Indicates whether a reservation is required to participate in this inventory.
Supported OTA specification SEC code. See OTA geoname data
Social network accounts for blocking (if applicable).
Social network
object
URL or social network identifier to social network profile
Type of social network.
Use this property to sort an blocking in a list of activities.
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
Localized transactional blocking
object
Localized descriptions describing inventory.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Unique transactional identifier
Whether there is a limit to maximum group size.
Whether there is a limit to minimum group size.
List of images / videos of item.
Multimedia that contains less information than Multimedia object
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Internal name of transactional blocking.
Localized offer details if rate plan discount applies.
Simplified localized description containing text content and its language code.
object
Longer text description
Indicate which language this description is written in.
Localized price
object
Channel discount percent
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in wink currency
Premium modifiers in wink currency
Promotional modifiers in wink currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Premium percent
Promotional discount percent
How many of this item is included in this price
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in hotel currency
Premium modifiers in hotel currency
Promotional modifiers in hotel currency
Hotel to wink currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Hotel to user currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in user specified currency
Premium modifiers in user specified currency
Promotional modifiers in user specified currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
How this inventory item should be priced.
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.
List of property recognitions
Recognition for the ancillary blocking.
object
Recognition category.
The date the award was received
Recognition identifier.
Use this to let hotels indicate what the total score for this award is.
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.
The name of the entity that administers this recognition.
The actual award or rating received by the hotel facility.
Provides the symbol used in the rating. Used in conjunction with the Rating.
Type of rating system the recognition operated on. This allows us to display the score properly.
List of property restaurants on and off the premises.
object
Channel inventory identifier referencing this record.
The commission percentage.
Whether this package is commissionable based on the incoming sales channel.
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.
This is one localized bookable item that can stand alongside a restaurant / meeting room etc.
object
Localized descriptions describing inventory.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Unique transactional identifier
Whether there is a limit to maximum group size.
Whether there is a limit to minimum group size.
List of images / videos of item.
Multimedia that contains less information than Multimedia object
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Internal name of transactional blocking.
Localized offer details if rate plan discount applies.
Simplified localized description containing text content and its language code.
object
Longer text description
Indicate which language this description is written in.
Localized price
object
Channel discount percent
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in wink currency
Premium modifiers in wink currency
Promotional modifiers in wink currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Premium percent
Promotional discount percent
How many of this item is included in this price
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in hotel currency
Premium modifiers in hotel currency
Promotional modifiers in hotel currency
Hotel to wink currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Hotel to user currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in user specified currency
Premium modifiers in user specified currency
Promotional modifiers in user specified currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
How this inventory item should be priced.
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.
Localized transactional blocking
object
Localized descriptions describing inventory.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Unique transactional identifier
Whether there is a limit to maximum group size.
Whether there is a limit to minimum group size.
List of images / videos of item.
Multimedia that contains less information than Multimedia object
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Internal name of transactional blocking.
Localized offer details if rate plan discount applies.
Simplified localized description containing text content and its language code.
object
Longer text description
Indicate which language this description is written in.
Localized price
object
Channel discount percent
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in wink currency
Premium modifiers in wink currency
Promotional modifiers in wink currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Premium percent
Promotional discount percent
How many of this item is included in this price
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in hotel currency
Premium modifiers in hotel currency
Promotional modifiers in hotel currency
Hotel to wink currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Hotel to user currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in user specified currency
Premium modifiers in user specified currency
Promotional modifiers in user specified currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
How this inventory item should be priced.
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.
Inventory data object
object
Modify blocking availability with this flag.
Defaults to property address.
object
Address line 1
Address line 2
City name
Country
Country
County
Address 1, Address 2, City, State, Postal / Zip code, Country
Postal / zip code
State
Supported OTA specification RSI code. See OTA geoname data.
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.
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.
Indicates if this inventory can be added to a booking or if it is read-only marketing material only.
Closing time of blocking (if applicable). Leave empty if blocking is always available.
Indicate whether sales channels receive commission for selling this inventory.
Associate a contact person for this inventory (if applicable).
object
Contact E-mail
Contact first name
First and last name
Contact last name
Contact phone number
Contact secondary Email
Summary
Datetime this record was first created
Supported OTA specification CUI code. See OTA geoname data.
Indicate which days this inventory is open.
object
Convenience property to quickly determine if this existing object has any active days enabled.
Set to true to enable Friday.
Set to true to enable Monday.
Set to true to enable Saturday.
Set to true to enable Sunday.
Set to true to enable Thursday.
Set to true to enable Tuesday.
Set to true to enable Wednesday.
Localized descriptions describing inventory.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Supported OTA specification PHY code. See OTA geoname data
Indicates whether this inventory is featured. Use this flag as a way to signify that this inventory is special.
Hotel identifier.
Unique identifier for this record.
Supported OTA specification RES code. See OTA geoname data.
Datetime this record was last updated
Indicate the type of lifestyle this inventory should be associated with.
Geo-location point where blocking takes place. Defaults to location of property.
object
Restaurant supports these many people.
Largest table at restaurant.
Supported OTA specification AQC code. See OTA geoname data
List of images / videos of blocking.
Multimedia that contains less information than Multimedia object
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Internal name of inventory.
Restaurant offers breakfast.
Restaurant offers brunch.
Restaurant offers dinner.
Restaurant offers lunch.
Opening time of blocking (if applicable). Leave empty if blocking is always available.
Level of expensiveness.
Supported OTA specification PRX code. See OTA geoname data
Publish lifecycle state: DRAFT (incomplete, not announced) or PUBLISHED (complete/live).
Inventory-level recognition.
Recognition for the ancillary blocking.
object
Recognition category.
The date the award was received
Recognition identifier.
Use this to let hotels indicate what the total score for this award is.
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.
The name of the entity that administers this recognition.
The actual award or rating received by the hotel facility.
Provides the symbol used in the rating. Used in conjunction with the Rating.
Type of rating system the recognition operated on. This allows us to display the score properly.
Indicates whether a reservation is required to participate in this inventory.
Supported OTA specification SEC code. See OTA geoname data
Social network accounts for blocking (if applicable).
Social network
object
URL or social network identifier to social network profile
Type of social network.
Use this property to sort an blocking in a list of activities.
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
List of property reviews
Anonymized public-facing view of a guest review, shown on property profiles to prospective guests.
object
List of reviewer’s question answers with scores.
Public-facing view of a single question-answer pair within a guest review, displayed on a property profile.
object
Category of the review question (e.g., COMFORT, SERVICE, VALUE).
Display order of this answer within the review.
Guest’s numeric rating for this question on a 0-10 scale.
Average rating score across all answered questions (0-10 scale).
Cloudinary image identifier for the guest’s uploaded photo from their stay.
Count of other members who ‘liked’ this review.
Property’s response to the guest review, displayed publicly on the property profile.
Guest’s full text review of their stay.
Reviewer’s name (first initial and last name).
Date and time when the review was submitted.
List of room types with price configurations based on the itinerary that was passed on the user session.
object
object
The active / selected cancellation policy for this room configuration
object
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.
Datetime this record was first created
Property this cancellation is associated with
Unique identifier for this record.
Datetime this record was last updated
In case the ‘Refundable cancellation charge’ is set, a different no show charge can be applied.
If the guest does not honor the non-refundable deadline rule, this charge dictates what she owes after the deadline passes.
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.
Whether this cancellation policy is refundable or not
If advanceCancellationFreeOfCharge rules is not honored, this property explains what the guest will be charged.
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
Add-ons that are available with this room configuration
object
The original add-on record created by the property.
object
Modify blocking availability with this flag.
Defaults to property address.
object
Address line 1
Address line 2
City name
Country
Country
County
Address 1, Address 2, City, State, Postal / Zip code, Country
Postal / zip code
State
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.
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.
Indicates if this inventory can be added to a booking or if it is read-only marketing material only.
Closing time of blocking (if applicable). Leave empty if blocking is always available.
Indicate whether sales channels receive commission for selling this inventory.
Associate a contact person for this inventory (if applicable).
object
Contact E-mail
Contact first name
First and last name
Contact last name
Contact phone number
Contact secondary Email
Summary
Datetime this record was first created
Optional list of date ranges restricting add-on availability to specific periods. Mutually exclusive with ratePlan.
object
Retrieve data range ending with and including this end date
Retrieve data range starting with and including this start date
Indicate which days this inventory is open.
object
Convenience property to quickly determine if this existing object has any active days enabled.
Set to true to enable Friday.
Set to true to enable Monday.
Set to true to enable Saturday.
Set to true to enable Sunday.
Set to true to enable Thursday.
Set to true to enable Tuesday.
Set to true to enable Wednesday.
Localized descriptions describing inventory.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Supported OTA specification PHY code. See OTA geoname data
Indicates whether this inventory is featured. Use this flag as a way to signify that this inventory is special.
Hotel identifier.
Unique identifier for this record.
Datetime this record was last updated
Indicate the type of lifestyle this inventory should be associated with.
Geo-location point where blocking takes place. Defaults to location of property.
object
Make this add-on mandatory for all guests by enabling this flag.
Supported OTA specification AQC code. See OTA geoname data
List of images / videos of blocking.
Multimedia that contains less information than Multimedia object
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Internal name of inventory.
Total number of add-ons available to purchase.
Opening time of blocking (if applicable). Leave empty if blocking is always available.
Level of expensiveness.
Supported OTA specification PRX code. See OTA geoname data
Publish lifecycle state: DRAFT (incomplete, not announced) or PUBLISHED (complete/live).
An optional rate plan can be applied to the add-on. The rate plan can help to create availability restrictions.
object
Everything included except alcohol
Everything included with alcohol
Days of the week on which guests are allowed to check in. If null, arrivals are permitted on any day.
object
Convenience property to quickly determine if this existing object has any active days enabled.
Set to true to enable Friday.
Set to true to enable Monday.
Set to true to enable Saturday.
Set to true to enable Sunday.
Set to true to enable Thursday.
Set to true to enable Tuesday.
Set to true to enable Wednesday.
Days of the week when this rate plan is available for booking. If null, the rate plan is available on all days.
object
Convenience property to quickly determine if this existing object has any active days enabled.
Set to true to enable Friday.
Set to true to enable Monday.
Set to true to enable Saturday.
Set to true to enable Sunday.
Set to true to enable Thursday.
Set to true to enable Tuesday.
Set to true to enable Wednesday.
When true, indicates breakfast is included.
When true, indicates brunch is included.
The cancellation policy that governs refunds and cancellations for this rate plan.
object
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.
Datetime this record was first created
Property this cancellation is associated with
Unique identifier for this record.
Datetime this record was last updated
In case the ‘Refundable cancellation charge’ is set, a different no show charge can be applied.
If the guest does not honor the non-refundable deadline rule, this charge dictates what she owes after the deadline passes.
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.
Whether this cancellation policy is refundable or not
If advanceCancellationFreeOfCharge rules is not honored, this property explains what the guest will be charged.
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
Optional overrides of the cancellation policy for specific date ranges. Allows a property to apply different cancellation terms during peak seasons, events, or special periods. Leave null for no date-specific exceptions.
object
List of cancellation policy exceptions
object
Cancellation policy details for this exception
object
Advance notice window within which a cancellation is free of charge
Fee structure applied when a guest fails to show up without cancelling
Penalty charge applied when a non-refundable booking is cancelled after the deadline
Charge applied for cancelling a non-refundable rate
Deadline before arrival after which a booking becomes non-refundable
Charge retained when a refundable booking is cancelled
Cancellation policy identifier
End date for when this cancellation policy should end overriding the default cancellation policy.
Start date for when this cancellation policy should start to override the default cancellation policy.
Datetime this record was first created
Days of the week on which guests are allowed to check out. If null, departures are permitted on any day.
object
Convenience property to quickly determine if this existing object has any active days enabled.
Set to true to enable Friday.
Set to true to enable Monday.
Set to true to enable Saturday.
Set to true to enable Sunday.
Set to true to enable Thursday.
Set to true to enable Tuesday.
Set to true to enable Wednesday.
When true, indicates dinner is included.
A pricing modifier for guests checking in early. May include a surcharge or credit. If null, no early check-in charge applies.
The property (managing entity) that owns this rate plan.
Unique identifier for this record.
Datetime this record was last updated
A pricing modifier for guests staying late after standard checkout time. May include a surcharge or credit. If null, no late check-out charge applies.
When true, guests earn loyalty points toward the property’s loyalty program with this rate plan. When false, this rate plan does not accrue points.
When true, indicates lunch is included.
Maximum number of days in advance a guest may book this rate plan. For example, 180 allows bookings up to 6 months ahead.
Maximum guest age allowed for this rate plan, typically used for family or age-restricted rates.
Maximum consecutive nights allowed for a booking under this rate plan. For example, 30 caps bookings at 30 nights.
Maximum number of guests allowed under this rate plan.
Minimum number of days in advance a guest must book this rate plan. For example, 3 requires booking at least 3 days before arrival.
Minimum guest age required to book this rate plan, typically used for senior discounts or adult-only rates.
Minimum consecutive nights required for a booking under this rate plan. For example, 2 requires a minimum 2-night stay.
Minimum number of guests required to qualify for this rate plan.
A descriptive name for this rate plan, such as ‘Best Available Rate’, ‘Non-Refundable’, or ‘Corporate Rate’.
When true, indicates if the rate is a prepaid rate.
Days of the week on which at least one night must fall within the stay. Useful for rates requiring weekend stays or specific weekday requirements. If null, no specific day-of-week stay requirements apply.
object
Convenience property to quickly determine if this existing object has any active days enabled.
Set to true to enable Friday.
Set to true to enable Monday.
Set to true to enable Saturday.
Set to true to enable Sunday.
Set to true to enable Thursday.
Set to true to enable Tuesday.
Set to true to enable Wednesday.
The date on which this rate plan is no longer available for booking. If both sellStartDate and sellEndDate are set, the rate can only be sold within that date range.
The date on which this rate plan becomes available for booking. If both sellStartDate and sellEndDate are set, the rate can only be sold within that date range.
The latest date a guest can check in to use this rate plan. If both stayStartDate and stayEndDate are set, the rate can only be used for stays within that date range.
The earliest date a guest can check in to use this rate plan. If both stayStartDate and stayEndDate are set, the rate can only be used for stays within that date range.
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
Inventory-level recognition.
Recognition for the ancillary blocking.
object
Recognition category.
The date the award was received
Recognition identifier.
Use this to let hotels indicate what the total score for this award is.
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.
The name of the entity that administers this recognition.
The actual award or rating received by the hotel facility.
Provides the symbol used in the rating. Used in conjunction with the Rating.
Type of rating system the recognition operated on. This allows us to display the score properly.
Indicates whether a reservation is required to participate in this inventory.
Supported OTA specification SEC code. See OTA geoname data
Social network accounts for blocking (if applicable).
Social network
object
URL or social network identifier to social network profile
Type of social network.
Use this property to sort an blocking in a list of activities.
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
Channel inventory identifier referencing this record.
The commission percentage.
Whether this package is commissionable based on the incoming sales channel.
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.
Localized transactional blocking
object
Localized descriptions describing inventory.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Unique transactional identifier
Whether there is a limit to maximum group size.
Whether there is a limit to minimum group size.
List of images / videos of item.
Multimedia that contains less information than Multimedia object
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Internal name of transactional blocking.
Localized offer details if rate plan discount applies.
Simplified localized description containing text content and its language code.
object
Longer text description
Indicate which language this description is written in.
Localized price
object
Channel discount percent
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in wink currency
Premium modifiers in wink currency
Promotional modifiers in wink currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Premium percent
Promotional discount percent
How many of this item is included in this price
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in hotel currency
Premium modifiers in hotel currency
Promotional modifiers in hotel currency
Hotel to wink currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Hotel to user currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in user specified currency
Premium modifiers in user specified currency
Promotional modifiers in user specified currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
How this inventory item should be priced.
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.
The actual amount of adults as determined by the hotel’s policy
Sales channel inventory identifier
The actual amount of children as determined by the hotel’s policy
The commission percentage.
Whether this package is commissionable based on the incoming sales channel.
The selected room configuration that created this record
object
Number of adult guests in this room type
Child guests in this room, with age groups
Child guest with age and quantity in a room configuration
object
Age of each child in this group (years)
Count of children of this age group in the room
Number of identical rooms with this configuration
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.
SimpleDateTimeItinerary endDate
Per rate plan level extra charges with localized prices
object
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
List of extra charges that applies to the rate plan.
object
The localized price of the extra charge
object
Channel discount percent
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in wink currency
Premium modifiers in wink currency
Promotional modifiers in wink currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Premium percent
Promotional discount percent
How many of this item is included in this price
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in hotel currency
Premium modifiers in hotel currency
Promotional modifiers in hotel currency
Hotel to wink currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Hotel to user currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in user specified currency
Premium modifiers in user specified currency
Promotional modifiers in user specified currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
What the guest is paying extra for
object
Localized descriptions of this fee in multiple languages. At least one entry in English is required.
Simplified localized description containing text content and its language code.
object
Longer text description
Indicate which language this description is written in.
The fixed fee amount in the property’s local currency.
object
Monetary amount value
ISO 4217 currency code
How this fee is charged: per day, per stay, per person per day, or per person per stay.
The localized unit price of the extra charge
object
Channel discount percent
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in wink currency
Premium modifiers in wink currency
Promotional modifiers in wink currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Premium percent
Promotional discount percent
How many of this item is included in this price
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in hotel currency
Premium modifiers in hotel currency
Promotional modifiers in hotel currency
Hotel to wink currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Hotel to user currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in user specified currency
Premium modifiers in user specified currency
Promotional modifiers in user specified currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
This is one localized bookable item that can stand alongside a restaurant / meeting room etc.
object
Localized descriptions describing inventory.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Unique transactional identifier
Whether there is a limit to maximum group size.
Whether there is a limit to minimum group size.
List of images / videos of item.
Multimedia that contains less information than Multimedia object
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Internal name of transactional blocking.
Localized offer details if rate plan discount applies.
Simplified localized description containing text content and its language code.
object
Longer text description
Indicate which language this description is written in.
Localized price
object
Channel discount percent
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in wink currency
Premium modifiers in wink currency
Promotional modifiers in wink currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Premium percent
Promotional discount percent
How many of this item is included in this price
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in hotel currency
Premium modifiers in hotel currency
Promotional modifiers in hotel currency
Hotel to wink currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Hotel to user currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in user specified currency
Premium modifiers in user specified currency
Promotional modifiers in user specified currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
How this inventory item should be priced.
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.
Perks that accompany the master rate
object
Datetime this record was first created
Localized descriptions of this perk in multiple languages. Each element provides a name, description, and language code (e.g., ‘en’, ‘fr’, ‘de’).
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Whether this perk is guaranteed to be provided or available on a best-effort basis. Guaranteed perks take priority in allocation.
Unique identifier for this record.
Datetime this record was last updated
Platform tier/value assigned to this perk (0=standard, higher=premium). Used for internal prioritization and matching with rate tiers.
Display order when showing this perk in a list (ascending sort). Lower numbers appear first; 999 is reserved for disabled/unlisted perks.
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
The combined value of these perkTypes
Calculated price
object
Available
Chanel discount percent
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in wink currency
Extra child modifier in wink currency
Extra person modifier in wink currency
Rate premiums modifiers in wink currency
Rate discount modifiers in wink currency
Singe occupant modifier in wink currency
Internal currency final price.
object
Monetary amount value
ISO 4217 currency code
Maximum occupancy
Minimum occupancy
Localized text of the discount
Simplified localized description containing text content and its language code.
object
Longer text description
Indicate which language this description is written in.
Premium percent
Promotional codes
Promotional discount percent
Quantity
Source
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in hotel’s currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in hotel currency
Extra child modifier in hotel currency
Extra person modifier in hotel currency.
Rate premiums modifiers in hotel currency
Rate discount modifiers in hotel currency
Single occupant modifier in hotel currency
Hotel to wink currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Hotel to user currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Source currency final price.
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in user specified currency
Extra child modifier in user specified currcency
Extra person modifier in user specified currency
Rate premiums modifiers in user specified currency
Rate discount modifiers in user specified currency
Single occupant modifier in user specified currency
User-defined currency final price.
object
Monetary amount value
ISO 4217 currency code
Localized transactional blocking
object
Localized descriptions describing inventory.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Unique transactional identifier
Whether there is a limit to maximum group size.
Whether there is a limit to minimum group size.
List of images / videos of item.
Multimedia that contains less information than Multimedia object
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Internal name of transactional blocking.
Localized offer details if rate plan discount applies.
Simplified localized description containing text content and its language code.
object
Longer text description
Indicate which language this description is written in.
Localized price
object
Channel discount percent
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in wink currency
Premium modifiers in wink currency
Promotional modifiers in wink currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Premium percent
Promotional discount percent
How many of this item is included in this price
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in hotel currency
Premium modifiers in hotel currency
Promotional modifiers in hotel currency
Hotel to wink currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Hotel to user currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in user specified currency
Premium modifiers in user specified currency
Promotional modifiers in user specified currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
How this inventory item should be priced.
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.
Specified rate plan
object
Everything included except alcohol
Everything included with alcohol
When true, indicates breakfast is included.
When true, indicates brunch is included.
When true, indicates dinner is included.
Rate plan identifier
When true, indicates lunch is included.
Provides the name of the rate plan.
Number of nights the guests will be staying
Specified master rate identifier
Specified master rate internal name
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
SimpleDateTimeItinerary startDate
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
The different price configurations available for this room type.
object
The active / selected cancellation policy for this room configuration
object
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.
Datetime this record was first created
Property this cancellation is associated with
Unique identifier for this record.
Datetime this record was last updated
In case the ‘Refundable cancellation charge’ is set, a different no show charge can be applied.
If the guest does not honor the non-refundable deadline rule, this charge dictates what she owes after the deadline passes.
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.
Whether this cancellation policy is refundable or not
If advanceCancellationFreeOfCharge rules is not honored, this property explains what the guest will be charged.
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
Add-ons that are available with this room configuration
object
The original add-on record created by the property.
object
Modify blocking availability with this flag.
Defaults to property address.
object
Address line 1
Address line 2
City name
Country
Country
County
Address 1, Address 2, City, State, Postal / Zip code, Country
Postal / zip code
State
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.
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.
Indicates if this inventory can be added to a booking or if it is read-only marketing material only.
Closing time of blocking (if applicable). Leave empty if blocking is always available.
Indicate whether sales channels receive commission for selling this inventory.
Associate a contact person for this inventory (if applicable).
object
Contact E-mail
Contact first name
First and last name
Contact last name
Contact phone number
Contact secondary Email
Summary
Datetime this record was first created
Optional list of date ranges restricting add-on availability to specific periods. Mutually exclusive with ratePlan.
object
Retrieve data range ending with and including this end date
Retrieve data range starting with and including this start date
Indicate which days this inventory is open.
object
Convenience property to quickly determine if this existing object has any active days enabled.
Set to true to enable Friday.
Set to true to enable Monday.
Set to true to enable Saturday.
Set to true to enable Sunday.
Set to true to enable Thursday.
Set to true to enable Tuesday.
Set to true to enable Wednesday.
Localized descriptions describing inventory.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Supported OTA specification PHY code. See OTA geoname data
Indicates whether this inventory is featured. Use this flag as a way to signify that this inventory is special.
Hotel identifier.
Unique identifier for this record.
Datetime this record was last updated
Indicate the type of lifestyle this inventory should be associated with.
Geo-location point where blocking takes place. Defaults to location of property.
object
Make this add-on mandatory for all guests by enabling this flag.
Supported OTA specification AQC code. See OTA geoname data
List of images / videos of blocking.
Multimedia that contains less information than Multimedia object
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Internal name of inventory.
Total number of add-ons available to purchase.
Opening time of blocking (if applicable). Leave empty if blocking is always available.
Level of expensiveness.
Supported OTA specification PRX code. See OTA geoname data
Publish lifecycle state: DRAFT (incomplete, not announced) or PUBLISHED (complete/live).
An optional rate plan can be applied to the add-on. The rate plan can help to create availability restrictions.
object
Everything included except alcohol
Everything included with alcohol
Days of the week on which guests are allowed to check in. If null, arrivals are permitted on any day.
object
Convenience property to quickly determine if this existing object has any active days enabled.
Set to true to enable Friday.
Set to true to enable Monday.
Set to true to enable Saturday.
Set to true to enable Sunday.
Set to true to enable Thursday.
Set to true to enable Tuesday.
Set to true to enable Wednesday.
Days of the week when this rate plan is available for booking. If null, the rate plan is available on all days.
object
Convenience property to quickly determine if this existing object has any active days enabled.
Set to true to enable Friday.
Set to true to enable Monday.
Set to true to enable Saturday.
Set to true to enable Sunday.
Set to true to enable Thursday.
Set to true to enable Tuesday.
Set to true to enable Wednesday.
When true, indicates breakfast is included.
When true, indicates brunch is included.
The cancellation policy that governs refunds and cancellations for this rate plan.
object
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.
Datetime this record was first created
Property this cancellation is associated with
Unique identifier for this record.
Datetime this record was last updated
In case the ‘Refundable cancellation charge’ is set, a different no show charge can be applied.
If the guest does not honor the non-refundable deadline rule, this charge dictates what she owes after the deadline passes.
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.
Whether this cancellation policy is refundable or not
If advanceCancellationFreeOfCharge rules is not honored, this property explains what the guest will be charged.
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
Optional overrides of the cancellation policy for specific date ranges. Allows a property to apply different cancellation terms during peak seasons, events, or special periods. Leave null for no date-specific exceptions.
object
List of cancellation policy exceptions
object
Cancellation policy details for this exception
object
Advance notice window within which a cancellation is free of charge
Fee structure applied when a guest fails to show up without cancelling
Penalty charge applied when a non-refundable booking is cancelled after the deadline
Charge applied for cancelling a non-refundable rate
Deadline before arrival after which a booking becomes non-refundable
Charge retained when a refundable booking is cancelled
Cancellation policy identifier
End date for when this cancellation policy should end overriding the default cancellation policy.
Start date for when this cancellation policy should start to override the default cancellation policy.
Datetime this record was first created
Days of the week on which guests are allowed to check out. If null, departures are permitted on any day.
object
Convenience property to quickly determine if this existing object has any active days enabled.
Set to true to enable Friday.
Set to true to enable Monday.
Set to true to enable Saturday.
Set to true to enable Sunday.
Set to true to enable Thursday.
Set to true to enable Tuesday.
Set to true to enable Wednesday.
When true, indicates dinner is included.
A pricing modifier for guests checking in early. May include a surcharge or credit. If null, no early check-in charge applies.
The property (managing entity) that owns this rate plan.
Unique identifier for this record.
Datetime this record was last updated
A pricing modifier for guests staying late after standard checkout time. May include a surcharge or credit. If null, no late check-out charge applies.
When true, guests earn loyalty points toward the property’s loyalty program with this rate plan. When false, this rate plan does not accrue points.
When true, indicates lunch is included.
Maximum number of days in advance a guest may book this rate plan. For example, 180 allows bookings up to 6 months ahead.
Maximum guest age allowed for this rate plan, typically used for family or age-restricted rates.
Maximum consecutive nights allowed for a booking under this rate plan. For example, 30 caps bookings at 30 nights.
Maximum number of guests allowed under this rate plan.
Minimum number of days in advance a guest must book this rate plan. For example, 3 requires booking at least 3 days before arrival.
Minimum guest age required to book this rate plan, typically used for senior discounts or adult-only rates.
Minimum consecutive nights required for a booking under this rate plan. For example, 2 requires a minimum 2-night stay.
Minimum number of guests required to qualify for this rate plan.
A descriptive name for this rate plan, such as ‘Best Available Rate’, ‘Non-Refundable’, or ‘Corporate Rate’.
When true, indicates if the rate is a prepaid rate.
Days of the week on which at least one night must fall within the stay. Useful for rates requiring weekend stays or specific weekday requirements. If null, no specific day-of-week stay requirements apply.
object
Convenience property to quickly determine if this existing object has any active days enabled.
Set to true to enable Friday.
Set to true to enable Monday.
Set to true to enable Saturday.
Set to true to enable Sunday.
Set to true to enable Thursday.
Set to true to enable Tuesday.
Set to true to enable Wednesday.
The date on which this rate plan is no longer available for booking. If both sellStartDate and sellEndDate are set, the rate can only be sold within that date range.
The date on which this rate plan becomes available for booking. If both sellStartDate and sellEndDate are set, the rate can only be sold within that date range.
The latest date a guest can check in to use this rate plan. If both stayStartDate and stayEndDate are set, the rate can only be used for stays within that date range.
The earliest date a guest can check in to use this rate plan. If both stayStartDate and stayEndDate are set, the rate can only be used for stays within that date range.
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
Inventory-level recognition.
Recognition for the ancillary blocking.
object
Recognition category.
The date the award was received
Recognition identifier.
Use this to let hotels indicate what the total score for this award is.
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.
The name of the entity that administers this recognition.
The actual award or rating received by the hotel facility.
Provides the symbol used in the rating. Used in conjunction with the Rating.
Type of rating system the recognition operated on. This allows us to display the score properly.
Indicates whether a reservation is required to participate in this inventory.
Supported OTA specification SEC code. See OTA geoname data
Social network accounts for blocking (if applicable).
Social network
object
URL or social network identifier to social network profile
Type of social network.
Use this property to sort an blocking in a list of activities.
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
Channel inventory identifier referencing this record.
The commission percentage.
Whether this package is commissionable based on the incoming sales channel.
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.
Localized transactional blocking
object
Localized descriptions describing inventory.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Unique transactional identifier
Whether there is a limit to maximum group size.
Whether there is a limit to minimum group size.
List of images / videos of item.
Multimedia that contains less information than Multimedia object
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Internal name of transactional blocking.
Localized offer details if rate plan discount applies.
Simplified localized description containing text content and its language code.
object
Longer text description
Indicate which language this description is written in.
Localized price
object
Channel discount percent
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in wink currency
Premium modifiers in wink currency
Promotional modifiers in wink currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Premium percent
Promotional discount percent
How many of this item is included in this price
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in hotel currency
Premium modifiers in hotel currency
Promotional modifiers in hotel currency
Hotel to wink currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Hotel to user currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in user specified currency
Premium modifiers in user specified currency
Promotional modifiers in user specified currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
How this inventory item should be priced.
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.
The actual amount of adults as determined by the hotel’s policy
Sales channel inventory identifier
The actual amount of children as determined by the hotel’s policy
The commission percentage.
Whether this package is commissionable based on the incoming sales channel.
The selected room configuration that created this record
object
Number of adult guests in this room type
Child guests in this room, with age groups
Child guest with age and quantity in a room configuration
object
Age of each child in this group (years)
Count of children of this age group in the room
Number of identical rooms with this configuration
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.
SimpleDateTimeItinerary endDate
Per rate plan level extra charges with localized prices
object
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
List of extra charges that applies to the rate plan.
object
The localized price of the extra charge
object
Channel discount percent
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in wink currency
Premium modifiers in wink currency
Promotional modifiers in wink currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Premium percent
Promotional discount percent
How many of this item is included in this price
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in hotel currency
Premium modifiers in hotel currency
Promotional modifiers in hotel currency
Hotel to wink currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Hotel to user currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in user specified currency
Premium modifiers in user specified currency
Promotional modifiers in user specified currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
What the guest is paying extra for
object
Localized descriptions of this fee in multiple languages. At least one entry in English is required.
Simplified localized description containing text content and its language code.
object
Longer text description
Indicate which language this description is written in.
The fixed fee amount in the property’s local currency.
object
Monetary amount value
ISO 4217 currency code
How this fee is charged: per day, per stay, per person per day, or per person per stay.
The localized unit price of the extra charge
object
Channel discount percent
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in wink currency
Premium modifiers in wink currency
Promotional modifiers in wink currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Premium percent
Promotional discount percent
How many of this item is included in this price
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in hotel currency
Premium modifiers in hotel currency
Promotional modifiers in hotel currency
Hotel to wink currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Hotel to user currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in user specified currency
Premium modifiers in user specified currency
Promotional modifiers in user specified currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
This is one localized bookable item that can stand alongside a restaurant / meeting room etc.
object
Localized descriptions describing inventory.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Unique transactional identifier
Whether there is a limit to maximum group size.
Whether there is a limit to minimum group size.
List of images / videos of item.
Multimedia that contains less information than Multimedia object
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Internal name of transactional blocking.
Localized offer details if rate plan discount applies.
Simplified localized description containing text content and its language code.
object
Longer text description
Indicate which language this description is written in.
Localized price
object
Channel discount percent
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in wink currency
Premium modifiers in wink currency
Promotional modifiers in wink currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Premium percent
Promotional discount percent
How many of this item is included in this price
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in hotel currency
Premium modifiers in hotel currency
Promotional modifiers in hotel currency
Hotel to wink currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Hotel to user currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in user specified currency
Premium modifiers in user specified currency
Promotional modifiers in user specified currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
How this inventory item should be priced.
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.
Perks that accompany the master rate
object
Datetime this record was first created
Localized descriptions of this perk in multiple languages. Each element provides a name, description, and language code (e.g., ‘en’, ‘fr’, ‘de’).
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Whether this perk is guaranteed to be provided or available on a best-effort basis. Guaranteed perks take priority in allocation.
Unique identifier for this record.
Datetime this record was last updated
Platform tier/value assigned to this perk (0=standard, higher=premium). Used for internal prioritization and matching with rate tiers.
Display order when showing this perk in a list (ascending sort). Lower numbers appear first; 999 is reserved for disabled/unlisted perks.
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
The combined value of these perkTypes
Calculated price
object
Available
Chanel discount percent
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in wink currency
Extra child modifier in wink currency
Extra person modifier in wink currency
Rate premiums modifiers in wink currency
Rate discount modifiers in wink currency
Singe occupant modifier in wink currency
Internal currency final price.
object
Monetary amount value
ISO 4217 currency code
Maximum occupancy
Minimum occupancy
Localized text of the discount
Simplified localized description containing text content and its language code.
object
Longer text description
Indicate which language this description is written in.
Premium percent
Promotional codes
Promotional discount percent
Quantity
Source
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in hotel’s currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in hotel currency
Extra child modifier in hotel currency
Extra person modifier in hotel currency.
Rate premiums modifiers in hotel currency
Rate discount modifiers in hotel currency
Single occupant modifier in hotel currency
Hotel to wink currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Hotel to user currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Source currency final price.
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in user specified currency
Extra child modifier in user specified currcency
Extra person modifier in user specified currency
Rate premiums modifiers in user specified currency
Rate discount modifiers in user specified currency
Single occupant modifier in user specified currency
User-defined currency final price.
object
Monetary amount value
ISO 4217 currency code
Localized transactional blocking
object
Localized descriptions describing inventory.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Unique transactional identifier
Whether there is a limit to maximum group size.
Whether there is a limit to minimum group size.
List of images / videos of item.
Multimedia that contains less information than Multimedia object
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Internal name of transactional blocking.
Localized offer details if rate plan discount applies.
Simplified localized description containing text content and its language code.
object
Longer text description
Indicate which language this description is written in.
Localized price
object
Channel discount percent
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in wink currency
Premium modifiers in wink currency
Promotional modifiers in wink currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Premium percent
Promotional discount percent
How many of this item is included in this price
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in hotel currency
Premium modifiers in hotel currency
Promotional modifiers in hotel currency
Hotel to wink currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Hotel to user currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in user specified currency
Premium modifiers in user specified currency
Promotional modifiers in user specified currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
How this inventory item should be priced.
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.
Specified rate plan
object
Everything included except alcohol
Everything included with alcohol
When true, indicates breakfast is included.
When true, indicates brunch is included.
When true, indicates dinner is included.
Rate plan identifier
When true, indicates lunch is included.
Provides the name of the rate plan.
Number of nights the guests will be staying
Specified master rate identifier
Specified master rate internal name
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
SimpleDateTimeItinerary startDate
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
The room type.
object
Modify blocking availability with this flag.
Defaults to property address.
object
Address line 1
Address line 2
City name
Country
Country
County
Address 1, Address 2, City, State, Postal / Zip code, Country
Postal / zip code
State
OpenTravel room amenity codes (e.g., 1=Balcony, 7=Air Conditioning). See OTA geoname data
Number of bathrooms
A room type can have more than one bed configuration.
A named bedroom layout configuration for a room type, containing one or more bedrooms each with their own bed setup.
object
List of bedrooms within this configuration layout.
A single bedroom within a room type, specifying the bedroom type and its bed configuration.
object
List of bed configurations for this bedroom. Each entry specifies a bed type and quantity.
A single bed type and its quantity within a bedroom, described using the OpenTravel bed type code.
object
OpenTravel bed type code (e.g., 1=Double, 2=Twin, 7=Queen, 8=King). See OTA geoname data.
Number of beds of this type in the room.
Bedroom type classification (e.g., MASTER, QUEEN, JUNIOR, DORMITORY, BEDROOM_1…BEDROOM_10).
Unique identifier for this bedroom configuration layout.
Human-readable name of this room layout configuration.
Indicates if this inventory can be added to a booking or if it is read-only marketing material only.
Indicate whether sales channels receive commission for selling this inventory.
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.
Associate a contact person for this inventory (if applicable).
object
Contact E-mail
Contact first name
First and last name
Contact last name
Contact phone number
Contact secondary Email
Summary
Datetime this record was first created
Localized descriptions describing inventory.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Supported OTA specification PHY code. See OTA geoname data
Indicates whether this inventory is featured. Use this flag as a way to signify that this inventory is special.
Floor number on which this room type is located.
Hotel identifier.
Unique identifier for this record.
The number of pax the room price was meant for
The number of children the room price was meant for
Datetime this record was last updated
Indicate the type of lifestyle this inventory should be associated with.
Number of living rooms
Geo-location point where blocking takes place. Defaults to location of property.
object
Maximum number of adults allowed in a room type.
Maximum number of children allowed in a room type.
Maximum number of cribs allowed in a room type.
Maximum number of guest allowed in a room type.
Maximum number of rollaway beds allowed in this room type.
Supported OTA specification AQC code. See OTA geoname data
Minimum number of guests allowed in a room type.
List of images / videos of blocking.
Multimedia that contains less information than Multimedia object
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Internal name of inventory.
Non-smoking indicator
Level of expensiveness.
Supported OTA specification PRX code. See OTA geoname data
Publish lifecycle state: DRAFT (incomplete, not announced) or PUBLISHED (complete/live).
Defines the number of rooms of this type
Inventory-level recognition.
Recognition for the ancillary blocking.
object
Recognition category.
The date the award was received
Recognition identifier.
Use this to let hotels indicate what the total score for this award is.
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.
The name of the entity that administers this recognition.
The actual award or rating received by the hotel facility.
Provides the symbol used in the rating. Used in conjunction with the Rating.
Type of rating system the recognition operated on. This allows us to display the score properly.
OpenTravel architectural style code (e.g., 1=Modern, 2=Traditional, 3=Victorian). See OTA geoname data
OpenTravel segment category code (e.g., 1=Moderate, 4=Standard, 8=Deluxe). See OTA geoname data
OpenTravel guest room info code (e.g., 1=Suite, 2=Standard, 12=Villa, 16=Bungalow). See OTA geoname data
Used to request or specify a gender assignment for a room. Note: Typically used by Hosteliers.
OpenTravel room location type code (e.g., 1=Near Exit, 2=Close to Elevator, 3=Low Floor, 4=High Floor). See OTA geoname data
OpenTravel room view type code (e.g., 1=Ocean View, 2=Pool View, 3=Garden View). See OTA geoname data
Supported OTA specification SEC code. See OTA geoname data
If TRUE, the room requires or has sharing available. Note: Typically used by Hosteliers.
Number of square meters that defines the size of this room type.
Social network accounts for blocking (if applicable).
Social network
object
URL or social network identifier to social network profile
Type of social network.
Use this property to sort an blocking in a list of activities.
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
Sales channel that owns this booking
object
Percentage discount offered by the property to this sales channel. Value between 0.0 and 1.0 (e.g., 0.15 for 15% discount).
Percentage commission paid by the property to this sales channel. Value between 0.0 and 1.0 (e.g., 0.10 for 10% commission).
Name of the sales channel or third-party distributor
List of property spas on and off the premises.
object
Channel inventory identifier referencing this record.
The commission percentage.
Whether this package is commissionable based on the incoming sales channel.
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.
This is one localized bookable item that can stand alongside a restaurant / meeting room etc.
object
Localized descriptions describing inventory.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Unique transactional identifier
Whether there is a limit to maximum group size.
Whether there is a limit to minimum group size.
List of images / videos of item.
Multimedia that contains less information than Multimedia object
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Internal name of transactional blocking.
Localized offer details if rate plan discount applies.
Simplified localized description containing text content and its language code.
object
Longer text description
Indicate which language this description is written in.
Localized price
object
Channel discount percent
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in wink currency
Premium modifiers in wink currency
Promotional modifiers in wink currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Premium percent
Promotional discount percent
How many of this item is included in this price
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in hotel currency
Premium modifiers in hotel currency
Promotional modifiers in hotel currency
Hotel to wink currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Hotel to user currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in user specified currency
Premium modifiers in user specified currency
Promotional modifiers in user specified currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
How this inventory item should be priced.
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.
Localized transactional blocking
object
Localized descriptions describing inventory.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Unique transactional identifier
Whether there is a limit to maximum group size.
Whether there is a limit to minimum group size.
List of images / videos of item.
Multimedia that contains less information than Multimedia object
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Internal name of transactional blocking.
Localized offer details if rate plan discount applies.
Simplified localized description containing text content and its language code.
object
Longer text description
Indicate which language this description is written in.
Localized price
object
Channel discount percent
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in wink currency
Premium modifiers in wink currency
Promotional modifiers in wink currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Premium percent
Promotional discount percent
How many of this item is included in this price
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in hotel currency
Premium modifiers in hotel currency
Promotional modifiers in hotel currency
Hotel to wink currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Hotel to user currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in user specified currency
Premium modifiers in user specified currency
Promotional modifiers in user specified currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
How this inventory item should be priced.
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.
Inventory data object
object
Modify blocking availability with this flag.
Defaults to property address.
object
Address line 1
Address line 2
City name
Country
Country
County
Address 1, Address 2, City, State, Postal / Zip code, Country
Postal / zip code
State
OTA specification codes for spa amenities (massage types, facilities, wellness offerings, etc.)
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.
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.
Indicates if this inventory can be added to a booking or if it is read-only marketing material only.
Closing time of blocking (if applicable). Leave empty if blocking is always available.
Indicate whether sales channels receive commission for selling this inventory.
Associate a contact person for this inventory (if applicable).
object
Contact E-mail
Contact first name
First and last name
Contact last name
Contact phone number
Contact secondary Email
Summary
Datetime this record was first created
Indicate which days this inventory is open.
object
Convenience property to quickly determine if this existing object has any active days enabled.
Set to true to enable Friday.
Set to true to enable Monday.
Set to true to enable Saturday.
Set to true to enable Sunday.
Set to true to enable Thursday.
Set to true to enable Tuesday.
Set to true to enable Wednesday.
Localized descriptions describing inventory.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Supported OTA specification PHY code. See OTA geoname data
Indicates whether this inventory is featured. Use this flag as a way to signify that this inventory is special.
Hotel identifier.
Unique identifier for this record.
Datetime this record was last updated
Indicate the type of lifestyle this inventory should be associated with.
Geo-location point where blocking takes place. Defaults to location of property.
object
Supported OTA specification AQC code. See OTA geoname data
List of images / videos of blocking.
Multimedia that contains less information than Multimedia object
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Internal name of inventory.
Opening time of blocking (if applicable). Leave empty if blocking is always available.
Level of expensiveness.
Supported OTA specification PRX code. See OTA geoname data
Publish lifecycle state: DRAFT (incomplete, not announced) or PUBLISHED (complete/live).
Inventory-level recognition.
Recognition for the ancillary blocking.
object
Recognition category.
The date the award was received
Recognition identifier.
Use this to let hotels indicate what the total score for this award is.
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.
The name of the entity that administers this recognition.
The actual award or rating received by the hotel facility.
Provides the symbol used in the rating. Used in conjunction with the Rating.
Type of rating system the recognition operated on. This allows us to display the score properly.
Indicates whether a reservation is required to participate in this inventory.
Supported OTA specification SEC code. See OTA geoname data
Social network accounts for blocking (if applicable).
Social network
object
URL or social network identifier to social network profile
Type of social network.
Use this property to sort an blocking in a list of activities.
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
Unique short ID.
Unique url-friendly record identifier of property.
List of property videos
Multimedia that contains less information than Multimedia object
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Example
{ "activities": [], "announcements": [], "attractions": [], "greenIndexScores": null, "hotel": { "descriptions": [ { "description": "A five-star property in the heart of Bangkok.", "language": "en", "title": "Luxury Urban Retreat" } ], "identifier": "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "location": { "city": "Bangkok", "country": "TH" }, "name": "The Siam Residences", "starRating": 5, "urlName": "the-siam-residences-bangkok" }, "hotelIdentifier": "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "images": [ { "descriptions": [ { "description": "Grand lobby entrance", "language": "en", "title": "Lobby" } ], "identifier": "the-siam-residences/lobby", "isLandscape": true, "multimediaIdentifier": "b5e9c2d4-1f7a-4b8e-a3c0-9d6e2f4a1b7c", "published": true, "sort": 1, "type": "IMAGE" } ], "meetingRooms": [], "metadata": [], "places": [], "recognitions": [], "restaurants": [], "reviews": [], "roomTypes": [ { "adults": 2, "children": 0, "endDate": "2026-07-15", "priceConfigurations": [ { "price": { "sourceTotal": { "amount": 26250, "currency": "THB" }, "userSpecifiedCurrencyTotal": { "amount": 750, "currency": "USD" } } } ], "room": { "identifier": "7a2d4f1e-9b3c-4e5a-8d6f-1c0b2a3e4f5d", "name": "Deluxe River View", "urlName": "deluxe-river-view" }, "roomNights": 5, "startDate": "2026-07-10" } ], "salesChannel": { "commissionPercentage": 10, "identifier": "8f3d1a7c-2e5b-4c9a-b0d4-6e1f3a8c2d5e" }, "spas": [], "uniqueId": "SIAM1", "urlName": "the-siam-residences-bangkok", "videos": []}Bad Request — missing or invalid request parameter or body
object
object
Example
Unauthorized — authentication is required or the session has expired
object
object
Example
Forbidden — authenticated but lacking the required permission or scope
object
object
Example
Not Found — the requested resource does not exist
object
object
Example
Method Not Allowed — the HTTP verb is not supported on this endpoint
object
object
Example
Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version
object
object
Example
Unsupported Media Type — use application/json
object
object
Example
Internal Server Error — an unexpected failure occurred on the server
object
object
Example
Service Unavailable — a downstream dependency is unreachable