Test Rate / Availability
const url = 'https://api.wink.travel/api/managing-entity/hotel-1/extranet/sandbox/room/list';const options = { method: 'POST', headers: {'Wink-Version': '2.0', 'Content-Type': 'application/json'}, body: '""'};
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/managing-entity/hotel-1/extranet/sandbox/room/list \ --header 'Content-Type: application/json' \ --header 'Wink-Version: 2.0' \ --data '""'Test whether the rates and availability for a sales channel is coming backing the way the property wants
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”Display available room for property ID
Example
hotel-1Header Parameters
Section titled “Header Parameters ”Request Body required
Section titled “Request Body required ”Rate request body
Responses
Section titled “ Responses ”OK
object
object
Document UUID
Datetime this record was first created
Datetime this record was last updated
Version property that shows how many times this document has been persisted. Document will not persist if the version property is less than current version property in the system. Result in an optimistic locking exception.
Hotel identifier.
Internal name of master rate. The name is generated by guest room and rate plan names respectively.
object
Room type ID
Hotel ID
Indicates whether this inventory is featured. Use this flag as a way to signify that this inventory is special.
Indicate the type of lifestyle this inventory should be associated with.
Geo-location point where inventory takes place. Defaults to location of property.
object
Localized descriptions describing inventory.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
List of images / videos of inventory.
Multimedia that contains less information than Multimedia object
object
Document identifier
Use this identifier to communicate with Cloudinary.
Whether Cloudinary media is a VIDEO or IMAGE.
Currently ONLY using Cloudinary to store all image / video assets.
Sort allows you to control how you want to sort this record in a list of media records.
Media angle
Media width in pixels.
Media height in pixels.
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Whether image has attribution properties
object
URL to contributor
Name of contributor
True if media width is greater or equal to height
Associate a contact person for this inventory (if applicable).
object
Contact first name
Contact last name
Contact E-mail
Contact secondary Email
Contact phone number
First and last name
Summary
Defaults to property address.
object
Address line 1
Address line 2
State
Postal / zip code
County
City name
Country
Country
Address 1, Address 2, City, State, Postal / Zip code, Country
Indicate whether sales channels receive commission for selling this inventory.
Internal name of inventory.
Supported OTA specification PRX code. See OTA geoname data
Use this property to sort an inventory in a list of activities.
Supported OTA specification AQC code. See OTA geoname data
Indicates if this inventory can be added to a booking or if it is read-only marketing material only.
Modify inventory availability with this flag.
Supported OTA specification PHY code. See OTA geoname data
Supported OTA specification SEC code. See OTA geoname data
Social network accounts for inventory (if applicable).
Social network
object
Type of social network.
URL or social network identifier to social network profile
Level of expensiveness.
Inventory-level recognition.
Recognition for the ancillary blocking.
object
Recognition identifier.
Recognition category.
Type of rating system the recognition operated on. This allows us to display the score properly.
The name of the entity that administers this recognition.
The actual award or rating received by the hotel facility.
Use this to let hotels indicate what the total score for this award is.
The date the award was received
When true, this indicates the property has received official permission from the award provider to use the rating in publications and marketing materials; when false this permission has not been granted.
Provides the symbol used in the rating. Used in conjunction with the Rating.
Purchasable items for this inventory.
This is one bookable item that can stand alongside a restaurant / meeting room etc.
object
Unique transactional identifier
Internal name of transactional blocking.
Localized descriptions describing inventory.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
How this blocking item should be priced.
Base price of booking this blocking.
object
If you are selling this blocking at a discount, indicate the discounted selling price. Leave empty if there is no discount.
object
List of images / videos of item.
Multimedia that contains less information than Multimedia object
object
Document identifier
Use this identifier to communicate with Cloudinary.
Whether Cloudinary media is a VIDEO or IMAGE.
Currently ONLY using Cloudinary to store all image / video assets.
Sort allows you to control how you want to sort this record in a list of media records.
Media angle
Media width in pixels.
Media height in pixels.
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Whether image has attribution properties
object
URL to contributor
Name of contributor
True if media width is greater or equal to height
Whether there is a limit to minimum group size.
Whether there is a limit to maximum group size.
Calculates the percent difference between basePrice and discountedPrice.
Calculates the percent difference between basePrice and discountedPrice.
Maximum number of guest allowed in a room type.
Minimum number of guests allowed in a room type.
Defines the number of rooms of this type
Non-smoking indicator
A room type can have more than one bed configuration.
object
Unique identifier
Name of layout
A room type can have more than one bedroom configuration.
object
Type of bedroom
A bedroom can have more than one bed type.
object
Indicates the type of bed(s) found in the room. Typical values would be Double, Twin, Queen, or King. Supported OTA specification BED code. See OTA geoname data.
Number of beds for this bed type.
Number of square meters that defines the size of this room type.
Maximum number of adults allowed in a room type.
Maximum number of children allowed in a room type.
Number of bathrooms
Number of living rooms
Maximum number of rollaway beds allowed in this room type.
Indicates the category of the room. Typical values would be Moderate, Standard, or Deluxe. Supported OTA specification SEG code. See OTA geoname data
Floor an which a room is located
Indicates the location of the room within the hotel structure. Typical values would be “Near Exit”,“Close to elevator”, “Low Floor” or “High Floor”. Supported OTA specification RLT code. See OTA geoname data
Indicates the view of the room. Typical values would be “Ocean view”, “Pool view” or “Garden View”. Supported OTA specification RVT code. See OTA geoname data
Indicates that the room (suite) is a composite of smaller units.
Number of rooms of this room type that makes up a larger unit (composite) such as a two bedroom suite could be comprised of two king rooms plus other room types. A 0 means disabled.
Specifies the room classification (e.g., cabin, apartment). Supported OTA specification GRI code. See OTA geoname data
Specifies the architectural style of a room. Supported OTA specification ARC code. See OTA geoname data
Used to request or specify a gender assignment for a room. Note: Typically used by Hosteliers.
If TRUE, the room requires or has sharing available. Note: Typically used by Hosteliers.
Maximum number of cribs allowed in a room type.
Collection of room amenity items available to the guest. Supported OTA specification RMA code. See OTA geoname data
The number of pax the room price was meant for
The number of children the room price was meant for
Typical one night rate during regular remand period
object
Typical one night rate in a distressed period
object
object
Rate plan identifier
Hotel ID
Provides the name of the rate plan.
When true, indicates if the rate is a prepaid rate.
Whether rate plan is active or not.
When true, indicates breakfast is included.
When true, indicates brunch is included.
When true, indicates lunch is included.
When true, indicates dinner is included.
Everything included except alcohol
Everything included with alcohol
Set a start date for when to start selling this rate. When sellStartDate and sellEndDate are set, this rate is only available for sale within that date range.
Set an end date for when to finish selling this rate. When sellStartDate and sellEndDate are set, this rate is only available for sale within that date range.
Set a start date for when the guest can visit. When stayStartDate and stayEndDate are set, this rate is only available for stay within that date range.
Set an end date for when the guest can visit. When stayStartDate and stayEndDate are set, this rate is only available for stay within that date range.
Property honors loyalty points with this rate plan.
Maximum days before the arrival date for which this rate plan may be booked.
Minimum days before the arrival date for which this rate plan may be booked.
Defines the minimum number of total occupants required for this rate plan.
Defines the maximum number of total occupants required for this rate plan.
Indicates the minimum length of stay required for this rate plan.
Indicates the maximum length of stay.
The minimum age to qualify for this rate plan.
The maximum age to qualify for this rate plan.
This can be a one-time fee such as a cleaning fee
object
List of localized descriptions for this fee.
object
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
Rate plan level fixed fee amount in property currency
object
Rate plan fee type
object
Set to true to enable Monday.
Set to true to enable Tuesday.
Set to true to enable Wednesday.
Set to true to enable Thursday.
Set to true to enable Friday.
Set to true to enable Saturday.
Set to true to enable Sunday.
Convenience property to quickly determine if this existing object has any active days enabled.
object
Set to true to enable Monday.
Set to true to enable Tuesday.
Set to true to enable Wednesday.
Set to true to enable Thursday.
Set to true to enable Friday.
Set to true to enable Saturday.
Set to true to enable Sunday.
Convenience property to quickly determine if this existing object has any active days enabled.
object
Set to true to enable Monday.
Set to true to enable Tuesday.
Set to true to enable Wednesday.
Set to true to enable Thursday.
Set to true to enable Friday.
Set to true to enable Saturday.
Set to true to enable Sunday.
Convenience property to quickly determine if this existing object has any active days enabled.
object
Set to true to enable Monday.
Set to true to enable Tuesday.
Set to true to enable Wednesday.
Set to true to enable Thursday.
Set to true to enable Friday.
Set to true to enable Saturday.
Set to true to enable Sunday.
Convenience property to quickly determine if this existing object has any active days enabled.
object
When the type is FIXED, fixedAmount is required. When the type is PERCENTAGE, percent is required.
A percentage of the total stay amount for an early check-in or late check-out
A localized amount
object
object
When the type is FIXED, fixedAmount is required. When the type is PERCENTAGE, percent is required.
A percentage of the total stay amount for an early check-in or late check-out
A localized amount
object
The cancellation policy for this rate plan.
object
Unique cancellation policy identifier
Property this cancellation is associated with
Whether this cancellation policy is refundable or not
When the cancellation policy is refundable, this flag can be set and indicates there is more rules involved than just a no-questions-asked refundable.
If advanceCancellationFreeOfCharge rules is not honored, this property explains what the guest will be charged.
In case the ‘Refundable cancellation charge’ is set, a different no show charge can be applied.
When the cancellation policy is non-refundable, this flag can be set and indicates there is more rules involved to calculate what the guest will owe in case of a cancellation.
The non-refundable charge might can have a deadline. If that deadline passes, the guest might be charged more.
If the guest does not honor the non-refundable deadline rule, this charge dictates what she owes after the deadline passes.
Allows a property to dynamically use another cancellation policy for a specific date range
object
List of cancellation policy exceptions
object
Cancellation policy
Cancellation policy
object
Unique cancellation policy identifier
Property this cancellation is associated with
Whether this cancellation policy is refundable or not
When the cancellation policy is refundable, this flag can be set and indicates there is more rules involved than just a no-questions-asked refundable.
If advanceCancellationFreeOfCharge rules is not honored, this property explains what the guest will be charged.
In case the ‘Refundable cancellation charge’ is set, a different no show charge can be applied.
When the cancellation policy is non-refundable, this flag can be set and indicates there is more rules involved to calculate what the guest will owe in case of a cancellation.
The non-refundable charge might can have a deadline. If that deadline passes, the guest might be charged more.
If the guest does not honor the non-refundable deadline rule, this charge dictates what she owes after the deadline passes.
Start date for when this cancellation policy should start to override the default cancellation policy.
End date for when this cancellation policy should end overriding the default cancellation policy.
object
When the type is FIXED, fixedAmount is required. When the type is PERCENTAGE, percent is required.
A percentage of the total stay amount for an early check-in or late check-out
A localized amount
object
object
When the type is FIXED, fixedAmount is required. When the type is PERCENTAGE, percent is required.
A percentage of the total stay amount for an early check-in or late check-out
A localized amount
object
object
When the type is FIXED, fixedAmount is required. When the type is PERCENTAGE, percent is required.
A percentage of the total stay amount for an early check-in or late check-out
A localized amount
object
Flag to enable / disable master rate across all sales channels
The perks associated with this master rate
object
Enum identifier identifier for this perk. Makes the persistent version backwards compatible.
Whether perk is guaranteed or not.
The platform value of this perk.
Localized description for this perk
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
This is how perks get sorted when in a list
object
object
object
Document UUID
Datetime this record was first created
Datetime this record was last updated
Version property that shows how many times this document has been persisted. Document will not persist if the version property is less than current version property in the system. Result in an optimistic locking exception.
Parent sales channel
object
Unique record identifier of this segment / account
Channel is owned by this supplier identifier.
Name of property / supplier that owns this channel
Flag when supplier not available. E.g. Hotel disables property
What type of segment of channel is this.
A specific identifier for the company / corporation / travel agency that is retrieving the rates
Name of the owner / affiliate. Hotel booking customization when it’s the booking customization.
Flag the supplier can use to enable / disable this channel
System override by supplier to disable channel. E.g. Platform disables supplier.
A way to blacklist a specific channel a property doesn’t want to send blocking to.
Percent discount on this channel and all its children [unless configured at the child level].
Amount of sales commission earned through this channel and all its children [unless configured at the child level].
Promotions for this channel
object
Unique record identifier
Hotel identifier.
Internal name of promotion.
Set whether you want the price to go up or down when the rules of this promotion have been satisfied.
object
When the type is FIXED, fixedAmount is required. When the type is PERCENTAGE, percent is required.
A percentage of the total stay amount for an early check-in or late check-out
A localized amount
object
Whether this promotion is enabled or not.
This determines whether this discount should be applied per night, per stay or per person - per night
Localized descriptions describing promotion. At least one English entry is required.
object
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
Restrict promotion to specific cities. See Geo-IP city geoname data
object
City geoIP
object
GeoNameLightweight identifiers taken from https://geonames.org.
Locale code
Continent code
Continent name
Country ISO code
Country name
City name
Timezone
Sub-division 1 code
Sub-division 1 name
Sub-division 2 code
Sub-division 2 name
Restrict promotion to specific continents. See Geo-IP continent geoname data
object
Continent code
Restrict promotion to specific countries. See Geo-IP country geoname data
object
Country to restrict on
object
Restrict promotion by requiring users to enter a promo code.
object
Promotion code
Restrict promotion to specific IP ranges.
object
Start of IP range
End of IP range
Restrict promotion by restricting to how many rooms the user wants.
object
Minimum number of rooms
Maximum number of rooms
Restrict promotion to either prepaid / non-prepaid rates.
object
Whether prepay is required or not
Restrict promotion to either refundable / non-refundable rates.
object
Whether restriction is on refundable rates
Restrict promotion to specific time zones. See Geo-IP timezone geoname data
object
Bookers timezone
Restrict promotion to users who want to book a room close to the date.
object
Seconds before day of arrival occurs
Restrict promotion to users who want to stay a certain number of days.
object
Minimum length of stay qualifier
Maximum length of stay qualifier
Restrict promotion to users who want to book in advance.
object
Minimum advance booking offset qualifier
Maximum advance booking offset qualifier
Restrict promotion to specific stay dates the user wants to arrive.
object
The effective (start) date of the stay date rate qualifier
The expiration (end) date of the stay date rate qualifier
Restrict promotion to specific dates the booking is made.
object
The effective (start) date of the sell date rate qualifier
The expiration (end) date of the sell date rate qualifier
Restrict promotion to specific days of the week the promotion is available.
object
The days of the week when this rate is available
object
Set to true to enable Monday.
Set to true to enable Tuesday.
Set to true to enable Wednesday.
Set to true to enable Thursday.
Set to true to enable Friday.
Set to true to enable Saturday.
Set to true to enable Sunday.
Convenience property to quickly determine if this existing object has any active days enabled.
Restrict promotion to specific days of the week the guest is arriving.
object
The days of the week when this rate is available for guests to arrive on
object
Set to true to enable Monday.
Set to true to enable Tuesday.
Set to true to enable Wednesday.
Set to true to enable Thursday.
Set to true to enable Friday.
Set to true to enable Saturday.
Set to true to enable Sunday.
Convenience property to quickly determine if this existing object has any active days enabled.
Restrict promotion to specific days of the week the guest is departing.
object
The days of the week when this rate is available
object
Set to true to enable Monday.
Set to true to enable Tuesday.
Set to true to enable Wednesday.
Set to true to enable Thursday.
Set to true to enable Friday.
Set to true to enable Saturday.
Set to true to enable Sunday.
Convenience property to quickly determine if this existing object has any active days enabled.
Restrict promotion to specific days of the week the guest has to stay.
object
The days of the week the user has to stay on to get this rate
object
Set to true to enable Monday.
Set to true to enable Tuesday.
Set to true to enable Wednesday.
Set to true to enable Thursday.
Set to true to enable Friday.
Set to true to enable Saturday.
Set to true to enable Sunday.
Convenience property to quickly determine if this existing object has any active days enabled.
Restrict on specific master rates.
Restrict on specific add-ons.
Restrict on specific rate plans.
Exclude this promotion from specific date ranges.
object
Blackout start date.
Blackout end date.
Promotion bundles for this channel
object
Unique record identifier
Hotel identifier.
Internal name of promotion ancillary.
Whether this promotion ancillary is enabled or not.
Promotions that go together to make up this ancillary.
object
Unique record identifier
Hotel identifier.
Internal name of promotion.
Set whether you want the price to go up or down when the rules of this promotion have been satisfied.
object
When the type is FIXED, fixedAmount is required. When the type is PERCENTAGE, percent is required.
A percentage of the total stay amount for an early check-in or late check-out
A localized amount
object
Whether this promotion is enabled or not.
This determines whether this discount should be applied per night, per stay or per person - per night
Localized descriptions describing promotion. At least one English entry is required.
object
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
Restrict promotion to specific cities. See Geo-IP city geoname data
object
City geoIP
object
GeoNameLightweight identifiers taken from https://geonames.org.
Locale code
Continent code
Continent name
Country ISO code
Country name
City name
Timezone
Sub-division 1 code
Sub-division 1 name
Sub-division 2 code
Sub-division 2 name
Restrict promotion to specific continents. See Geo-IP continent geoname data
object
Continent code
Restrict promotion to specific countries. See Geo-IP country geoname data
object
Country to restrict on
object
Restrict promotion by requiring users to enter a promo code.
object
Promotion code
Restrict promotion to specific IP ranges.
object
Start of IP range
End of IP range
Restrict promotion by restricting to how many rooms the user wants.
object
Minimum number of rooms
Maximum number of rooms
Restrict promotion to either prepaid / non-prepaid rates.
object
Whether prepay is required or not
Restrict promotion to either refundable / non-refundable rates.
object
Whether restriction is on refundable rates
Restrict promotion to specific time zones. See Geo-IP timezone geoname data
object
Bookers timezone
Restrict promotion to users who want to book a room close to the date.
object
Seconds before day of arrival occurs
Restrict promotion to users who want to stay a certain number of days.
object
Minimum length of stay qualifier
Maximum length of stay qualifier
Restrict promotion to users who want to book in advance.
object
Minimum advance booking offset qualifier
Maximum advance booking offset qualifier
Restrict promotion to specific stay dates the user wants to arrive.
object
The effective (start) date of the stay date rate qualifier
The expiration (end) date of the stay date rate qualifier
Restrict promotion to specific dates the booking is made.
object
The effective (start) date of the sell date rate qualifier
The expiration (end) date of the sell date rate qualifier
Restrict promotion to specific days of the week the promotion is available.
object
The days of the week when this rate is available
object
Set to true to enable Monday.
Set to true to enable Tuesday.
Set to true to enable Wednesday.
Set to true to enable Thursday.
Set to true to enable Friday.
Set to true to enable Saturday.
Set to true to enable Sunday.
Convenience property to quickly determine if this existing object has any active days enabled.
Restrict promotion to specific days of the week the guest is arriving.
object
The days of the week when this rate is available for guests to arrive on
object
Set to true to enable Monday.
Set to true to enable Tuesday.
Set to true to enable Wednesday.
Set to true to enable Thursday.
Set to true to enable Friday.
Set to true to enable Saturday.
Set to true to enable Sunday.
Convenience property to quickly determine if this existing object has any active days enabled.
Restrict promotion to specific days of the week the guest is departing.
object
The days of the week when this rate is available
object
Set to true to enable Monday.
Set to true to enable Tuesday.
Set to true to enable Wednesday.
Set to true to enable Thursday.
Set to true to enable Friday.
Set to true to enable Saturday.
Set to true to enable Sunday.
Convenience property to quickly determine if this existing object has any active days enabled.
Restrict promotion to specific days of the week the guest has to stay.
object
The days of the week the user has to stay on to get this rate
object
Set to true to enable Monday.
Set to true to enable Tuesday.
Set to true to enable Wednesday.
Set to true to enable Thursday.
Set to true to enable Friday.
Set to true to enable Saturday.
Set to true to enable Sunday.
Convenience property to quickly determine if this existing object has any active days enabled.
Restrict on specific master rates.
Restrict on specific add-ons.
Restrict on specific rate plans.
Exclude this promotion from specific date ranges.
object
Blackout start date.
Blackout end date.
object
When the type is FIXED, fixedAmount is required. When the type is PERCENTAGE, percent is required.
A percentage of the total stay amount for an early check-in or late check-out
A localized amount
object
Required if manual override modifier is not null
Determines whether this discount should be applied per night, per stay or per person - per night; Required if amount override is not null
Optional bundle-level descriptions. When populated, these replace the aggregated item descriptions in offerDetails.
object
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
object
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
object
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
Whether the sales channel is a self-acquiring entity.
Inventory type
Inventory type identifier
Name of inventory as hotel is seeing it
Name of inventory as traveler is seeing it
Whether this inventory is enabled or not
Main image of inventory
object
Document identifier
Use this identifier to communicate with Cloudinary.
Whether Cloudinary media is a VIDEO or IMAGE.
Currently ONLY using Cloudinary to store all image / video assets.
Sort allows you to control how you want to sort this record in a list of media records.
Media angle
Media width in pixels.
Media height in pixels.
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Whether image has attribution properties
object
URL to contributor
Name of contributor
True if media width is greater or equal to height
Level of expensiveness.
Location
object
Defaults to property address.
object
Address line 1
Address line 2
State
Postal / zip code
County
City name
Country
Country
Address 1, Address 2, City, State, Postal / Zip code, Country
Quantity
Whether this is commissionable or not
Whether inventory can be booked
Which continent the inventory is located on
Which country the inventory is located on
Which country the inventory is located on
Which city the inventory is located on
Which city the inventory is located on
Best price of the room type or facility ancillary
object
Best price of the room type or facility ancillary in platform currency
object
object
object
object
object
object
object
Unique record identifier
Hotel identifier.
Indicates whether this inventory is featured. Use this flag as a way to signify that this inventory is special.
Indicate the type of lifestyle this blocking should be associated with.
Geo-location point where blocking takes place. Defaults to location of property.
object
Localized descriptions describing inventory.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
List of images / videos of blocking.
Multimedia that contains less information than Multimedia object
object
Document identifier
Use this identifier to communicate with Cloudinary.
Whether Cloudinary media is a VIDEO or IMAGE.
Currently ONLY using Cloudinary to store all image / video assets.
Sort allows you to control how you want to sort this record in a list of media records.
Media angle
Media width in pixels.
Media height in pixels.
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Whether image has attribution properties
object
URL to contributor
Name of contributor
True if media width is greater or equal to height
Associate a contact person for this blocking (if applicable).
object
Contact first name
Contact last name
Contact E-mail
Contact secondary Email
Contact phone number
First and last name
Summary
Defaults to property address.
object
Address line 1
Address line 2
State
Postal / zip code
County
City name
Country
Country
Address 1, Address 2, City, State, Postal / Zip code, Country
Indicate whether sales channels receive commission for selling this blocking.
Internal name of inventory.
Supported OTA specification PRX code. See OTA geoname data
Use this property to sort an blocking in a list of activities.
Supported OTA specification AQC code. See OTA geoname data
Indicates if this blocking can be added to a booking or if it is read-only marketing material only.
Modify blocking availability with this flag.
Supported OTA specification PHY code. See OTA geoname data
Supported OTA specification SEC code. See OTA geoname data
Social network accounts for blocking (if applicable).
Social network
object
Type of social network.
URL or social network identifier to social network profile
Level of expensiveness.
Inventory-level recognition.
Recognition for the ancillary blocking.
object
Recognition identifier.
Recognition category.
Type of rating system the recognition operated on. This allows us to display the score properly.
The name of the entity that administers this recognition.
The actual award or rating received by the hotel facility.
Use this to let hotels indicate what the total score for this award is.
The date the award was received
When true, this indicates the property has received official permission from the award provider to use the rating in publications and marketing materials; when false this permission has not been granted.
Provides the symbol used in the rating. Used in conjunction with the Rating.
Purchasable items for this blocking.
This is one bookable item that can stand alongside a restaurant / meeting room etc.
object
Unique transactional identifier
Internal name of transactional blocking.
Localized descriptions describing inventory.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
How this blocking item should be priced.
Base price of booking this blocking.
object
If you are selling this blocking at a discount, indicate the discounted selling price. Leave empty if there is no discount.
object
List of images / videos of item.
Multimedia that contains less information than Multimedia object
object
Document identifier
Use this identifier to communicate with Cloudinary.
Whether Cloudinary media is a VIDEO or IMAGE.
Currently ONLY using Cloudinary to store all image / video assets.
Sort allows you to control how you want to sort this record in a list of media records.
Media angle
Media width in pixels.
Media height in pixels.
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Whether image has attribution properties
object
URL to contributor
Name of contributor
True if media width is greater or equal to height
Whether there is a limit to minimum group size.
Whether there is a limit to maximum group size.
Calculates the percent difference between basePrice and discountedPrice.
Calculates the percent difference between basePrice and discountedPrice.
Maximum number of guest allowed in a room type.
Minimum number of guests allowed in a room type.
Defines the number of rooms of this type
Non-smoking indicator
A room type can have more than one bed configuration.
object
Unique identifier
Name of layout
A room type can have more than one bedroom configuration.
object
Type of bedroom
A bedroom can have more than one bed type.
object
Indicates the type of bed(s) found in the room. Typical values would be Double, Twin, Queen, or King. Supported OTA specification BED code. See OTA geoname data.
Number of beds for this bed type.
Number of square meters that defines the size of this room type.
Maximum number of adults allowed in a room type.
Maximum number of children allowed in a room type.
Number of bathrooms
Number of living rooms
Maximum number of rollaway beds allowed in this room type.
Indicates the category of the room. Typical values would be Moderate, Standard, or Deluxe. Supported OTA specification SEG code. See OTA geoname data
Floor an which a room is located
Indicates the location of the room within the hotel structure. Typical values would be “Near Exit”,“Close to elevator”, “Low Floor” or “High Floor”. Supported OTA specification RLT code. See OTA geoname data
Indicates the view of the room. Typical values would be “Ocean view”, “Pool view” or “Garden View”. Supported OTA specification RVT code. See OTA geoname data
Indicates that the room (suite) is a composite of smaller units.
Number of rooms of this room type that makes up a larger unit (composite) such as a two bedroom suite could be comprised of two king rooms plus other room types. A 0 means disabled.
Specifies the room classification (e.g., cabin, apartment). Supported OTA specification GRI code. See OTA geoname data
Specifies the architectural style of a room. Supported OTA specification ARC code. See OTA geoname data
Used to request or specify a gender assignment for a room. Note: Typically used by Hosteliers.
If TRUE, the room requires or has sharing available. Note: Typically used by Hosteliers.
Maximum number of cribs allowed in a room type.
Collection of room amenity items available to the guest. Supported OTA specification RMA code. See OTA geoname data
The number of pax the room price was meant for
The number of children the room price was meant for
Typical one night rate during regular remand period
object
Typical one night rate in a distressed period
object
object
Sales channel inventory identifier
This is one localized bookable item that can stand alongside a restaurant / meeting room etc.
object
Unique transactional identifier
Internal name of transactional blocking.
Localized descriptions describing inventory.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
How this blocking item should be priced.
Localized price
object
Hotel to user currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Hotel to wink currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Base total in user specified currency.
object
Base total in hotel currency.
object
Base total in wink currency.
object
Promotional modifiers in user specified currency
Promotional modifiers in hotel currency
Promotional modifiers in wink currency
Premium modifiers in user specified currency
Premium modifiers in hotel currency
Premium modifiers in wink currency
Channel / Membership modifier in user specified currency
Channel / Membership modifier in hotel currency
Channel / Membership modifier in wink currency
How many of this item is included in this price
Promotional discount percent
Channel discount percent
Premium percent
object
object
object
List of images / videos of item.
Multimedia that contains less information than Multimedia object
object
Document identifier
Use this identifier to communicate with Cloudinary.
Whether Cloudinary media is a VIDEO or IMAGE.
Currently ONLY using Cloudinary to store all image / video assets.
Sort allows you to control how you want to sort this record in a list of media records.
Media angle
Media width in pixels.
Media height in pixels.
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Whether image has attribution properties
object
URL to contributor
Name of contributor
True if media width is greater or equal to height
Whether there is a limit to minimum group size.
Whether there is a limit to maximum group size.
Localized offer details if rate plan discount applies.
object
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
If a package is linked to a rate plan the user could be entitled to a promotional discount if she enters a code. When this field is populated, it means the discount was applied to the package.
Whether this package is commissionable based on the incoming sales channel.
The commission percentage.
Indicates whether the blocking from sales channel is direct or not. If you are a travel agent doing your own acquiring, this flag has to be true to make a booking.
The actual amount of adults as determined by the hotel’s policy
The actual amount of children as determined by the hotel’s policy
SimpleDateTimeItinerary startDate
SimpleDateTimeItinerary endDate
Specified master rate identifier
Specified master rate internal name
Specified rate plan
object
Rate plan identifier
Provides the name of the rate plan.
When true, indicates breakfast is included.
When true, indicates brunch is included.
When true, indicates lunch is included.
When true, indicates dinner is included.
Everything included except alcohol
Everything included with alcohol
object
When the type is FIXED, fixedAmount is required. When the type is PERCENTAGE, percent is required.
A percentage of the total stay amount for an early check-in or late check-out
A localized amount
object
object
When the type is FIXED, fixedAmount is required. When the type is PERCENTAGE, percent is required.
A percentage of the total stay amount for an early check-in or late check-out
A localized amount
object
Perks that accompany the master rate
object
Enum identifier identifier for this perk. Makes the persistent version backwards compatible.
Whether perk is guaranteed or not.
The platform value of this perk.
Localized description for this perk
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
This is how perks get sorted when in a list
Calculated price
object
Base total in user specified currency.
object
Base total in hotel’s currency.
object
Base total in wink currency.
object
Extra person modifier in hotel currency.
Extra person modifier in wink currency
Extra person modifier in user specified currency
Extra child modifier in hotel currency
Extra child modifier in wink currency
Extra child modifier in user specified currcency
Single occupant modifier in hotel currency
Singe occupant modifier in wink currency
Single occupant modifier in user specified currency
Rate discount modifiers in hotel currency
Rate discount modifiers in wink currency
Rate discount modifiers in user specified currency
Rate premiums modifiers in hotel currency
Rate premiums modifiers in wink currency
Rate premiums modifiers in user specified currency
Channel / Membership modifier in hotel currency
Channel / Membership modifier in wink currency
Channel / Membership modifier in user specified currency
Quantity
Minimum occupancy
Maximum occupancy
Source
Promotional discount percent
Chanel discount percent
Premium percent
Available
Hotel to user currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Hotel to wink currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Localized text of the discount
object
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
Promotional codes
object
object
object
object
object
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
object
Unique record identifier.
Owner of daily rate.
Indicate where this rate originated from. Leave as TRAVELIKO unless you are a channel manager and responsible for the property’s rates externally of this platform.
Rate plan associated with this daily rate.
Guest room associated with this daily rate.
object
This flag indicates whether this rate is available for this date.
This flag indicates whether a guest can arrive at the property on this date.
This flag indicates whether a guest can leave the property on this date.
The date this rate is applicable for.
Amount of rooms available for this date.
Minimum number of guests allowed in a room type.
Maximum number of guest allowed in a room type.
Control the minimum length of stay at the day-level. This means that a guest arriving within this date range is required to stay at least these number of days in order to get this rate. Leave empty if you don’t want to update this property.
Control the maximum length of stay at the day-level. This means that a guest arriving within this date range is required to stay no longer than these number of days in order to get this rate. Leave empty if you don’t want to update this property.
object
When the type is FIXED, fixedAmount is required. When the type is PERCENTAGE, percent is required.
A percentage of the total stay amount for an early check-in or late check-out
A localized amount
object
object
When the type is FIXED, fixedAmount is required. When the type is PERCENTAGE, percent is required.
A percentage of the total stay amount for an early check-in or late check-out
A localized amount
object
object
When the type is FIXED, fixedAmount is required. When the type is PERCENTAGE, percent is required.
A percentage of the total stay amount for an early check-in or late check-out
A localized amount
object
Maximum number of adults allowed in a room type.
Maximum number of children allowed in a room type.
The number of pax the room price was meant for
The number of children the room price was meant for
object
Source
Target
Exchange rate
Timestamp
object
Source
Target
Exchange rate
Timestamp
object
object
Source
Target
Exchange rate
Timestamp
object
Source
Target
Exchange rate
Timestamp
Beneficiary is a registered account with rights to compensation within a booking.
object
AccountIdentifier of beneficiary that can map to an account with us
AccountName of beneficiary that can map to an account with us
AccountEmail of beneficiary that can map to an account with us
AccountUrl of beneficiary that can map to an account with us
The type of beneficiary payment.
The original slice requested
object
The type of charge
A percentage of the total stay amount for an early checkin or late checkout
The source currency
The display currency
The internal currency
Amount in source currency
Amount in display currency
Amount in internal currency
The delta from the original source amount after a refund occurred
The delta from the original display amount after a refund occurred
The delta from the original internal amount after a refund occurred
When a refund is first requested, it ends up here. Once it is applied, it moves out of this list and into the parent modifier property
object
This is the refund identifier located on the root bookingContract.refunds object
The delta from the original source amount after a refund occurred
The delta from the original display amount after a refund occurred
The delta from the original internal amount after a refund occurred
Source amount minus source modifier.
Display amount minus display modifier.
Internal amount minus internal modifier.
Whether a funds transfer has occurred for this booking.
Place to add more data related to the beneficiary.
object
object
Final per-night rate in hotel currency (base + modifiers). Computed at instantiation.
object
Final per-night rate in wink currency (base + modifiers). Computed at instantiation.
object
Final per-night rate in user specified currency (base + modifiers). Computed at instantiation.
object
object
object
object
object
Beneficiary is a registered account with rights to compensation within a booking.
object
AccountIdentifier of beneficiary that can map to an account with us
AccountName of beneficiary that can map to an account with us
AccountEmail of beneficiary that can map to an account with us
AccountUrl of beneficiary that can map to an account with us
The type of beneficiary payment.
The original slice requested
object
The type of charge
A percentage of the total stay amount for an early checkin or late checkout
The source currency
The display currency
The internal currency
Amount in source currency
Amount in display currency
Amount in internal currency
The delta from the original source amount after a refund occurred
The delta from the original display amount after a refund occurred
The delta from the original internal amount after a refund occurred
When a refund is first requested, it ends up here. Once it is applied, it moves out of this list and into the parent modifier property
object
This is the refund identifier located on the root bookingContract.refunds object
The delta from the original source amount after a refund occurred
The delta from the original display amount after a refund occurred
The delta from the original internal amount after a refund occurred
Source amount minus source modifier.
Display amount minus display modifier.
Internal amount minus internal modifier.
Whether a funds transfer has occurred for this booking.
Place to add more data related to the beneficiary.
object
User-defined currency final price.
object
Source currency final price.
object
Internal currency final price.
object
object
object
Source
Target
Exchange rate
Timestamp
object
Source
Target
Exchange rate
Timestamp
Beneficiary is a registered account with rights to compensation within a booking.
object
AccountIdentifier of beneficiary that can map to an account with us
AccountName of beneficiary that can map to an account with us
AccountEmail of beneficiary that can map to an account with us
AccountUrl of beneficiary that can map to an account with us
The type of beneficiary payment.
The original slice requested
object
The type of charge
A percentage of the total stay amount for an early checkin or late checkout
The source currency
The display currency
The internal currency
Amount in source currency
Amount in display currency
Amount in internal currency
The delta from the original source amount after a refund occurred
The delta from the original display amount after a refund occurred
The delta from the original internal amount after a refund occurred
When a refund is first requested, it ends up here. Once it is applied, it moves out of this list and into the parent modifier property
object
This is the refund identifier located on the root bookingContract.refunds object
The delta from the original source amount after a refund occurred
The delta from the original display amount after a refund occurred
The delta from the original internal amount after a refund occurred
Source amount minus source modifier.
Display amount minus display modifier.
Internal amount minus internal modifier.
Whether a funds transfer has occurred for this booking.
Place to add more data related to the beneficiary.
object
object
object
object
Beneficiary is a registered account with rights to compensation within a booking.
object
AccountIdentifier of beneficiary that can map to an account with us
AccountName of beneficiary that can map to an account with us
AccountEmail of beneficiary that can map to an account with us
AccountUrl of beneficiary that can map to an account with us
The type of beneficiary payment.
The original slice requested
object
The type of charge
A percentage of the total stay amount for an early checkin or late checkout
The source currency
The display currency
The internal currency
Amount in source currency
Amount in display currency
Amount in internal currency
The delta from the original source amount after a refund occurred
The delta from the original display amount after a refund occurred
The delta from the original internal amount after a refund occurred
When a refund is first requested, it ends up here. Once it is applied, it moves out of this list and into the parent modifier property
object
This is the refund identifier located on the root bookingContract.refunds object
The delta from the original source amount after a refund occurred
The delta from the original display amount after a refund occurred
The delta from the original internal amount after a refund occurred
Source amount minus source modifier.
Display amount minus display modifier.
Internal amount minus internal modifier.
Whether a funds transfer has occurred for this booking.
Place to add more data related to the beneficiary.
object
object
Per rate plan level extra charges with localized prices
object
List of extra charges that applies to the rate plan.
object
What the guest is paying extra for
object
List of localized descriptions for this fee.
object
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
Rate plan level fixed fee amount in property currency
object
Rate plan fee type
The localized unit price of the extra charge
object
Hotel to user currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Hotel to wink currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Base total in user specified currency.
object
Base total in hotel currency.
object
Base total in wink currency.
object
Promotional modifiers in user specified currency
Promotional modifiers in hotel currency
Promotional modifiers in wink currency
Premium modifiers in user specified currency
Premium modifiers in hotel currency
Premium modifiers in wink currency
Channel / Membership modifier in user specified currency
Channel / Membership modifier in hotel currency
Channel / Membership modifier in wink currency
How many of this item is included in this price
Promotional discount percent
Channel discount percent
Premium percent
object
object
object
The localized price of the extra charge
object
Hotel to user currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Hotel to wink currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Base total in user specified currency.
object
Base total in hotel currency.
object
Base total in wink currency.
object
Promotional modifiers in user specified currency
Promotional modifiers in hotel currency
Promotional modifiers in wink currency
Premium modifiers in user specified currency
Premium modifiers in hotel currency
Premium modifiers in wink currency
Channel / Membership modifier in user specified currency
Channel / Membership modifier in hotel currency
Channel / Membership modifier in wink currency
How many of this item is included in this price
Promotional discount percent
Channel discount percent
Premium percent
object
object
object
object
object
object
The selected room configuration that created this record
object
Number of adults
Children configurations
BookingItineraryRoomConfigurationChild configuration
object
Number of children
Age of children
Number of identical rooms of this configuration being booked
Add-ons that are available with this room configuration
object
The original add-on record created by the property.
object
Unique record identifier
Hotel identifier.
Indicates whether this inventory is featured. Use this flag as a way to signify that this inventory is special.
Indicate the type of lifestyle this blocking should be associated with.
Geo-location point where blocking takes place. Defaults to location of property.
object
Localized descriptions describing inventory.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
List of images / videos of blocking.
Multimedia that contains less information than Multimedia object
object
Document identifier
Use this identifier to communicate with Cloudinary.
Whether Cloudinary media is a VIDEO or IMAGE.
Currently ONLY using Cloudinary to store all image / video assets.
Sort allows you to control how you want to sort this record in a list of media records.
Media angle
Media width in pixels.
Media height in pixels.
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Whether image has attribution properties
object
URL to contributor
Name of contributor
True if media width is greater or equal to height
Associate a contact person for this blocking (if applicable).
object
Contact first name
Contact last name
Contact E-mail
Contact secondary Email
Contact phone number
First and last name
Summary
Defaults to property address.
object
Address line 1
Address line 2
State
Postal / zip code
County
City name
Country
Country
Address 1, Address 2, City, State, Postal / Zip code, Country
Indicate whether sales channels receive commission for selling this blocking.
Internal name of inventory.
Supported OTA specification PRX code. See OTA geoname data
Use this property to sort an blocking in a list of activities.
Supported OTA specification AQC code. See OTA geoname data
Indicates if this blocking can be added to a booking or if it is read-only marketing material only.
Modify blocking availability with this flag.
Supported OTA specification PHY code. See OTA geoname data
Supported OTA specification SEC code. See OTA geoname data
Social network accounts for blocking (if applicable).
Social network
object
Type of social network.
URL or social network identifier to social network profile
Level of expensiveness.
Inventory-level recognition.
Recognition for the ancillary blocking.
object
Recognition identifier.
Recognition category.
Type of rating system the recognition operated on. This allows us to display the score properly.
The name of the entity that administers this recognition.
The actual award or rating received by the hotel facility.
Use this to let hotels indicate what the total score for this award is.
The date the award was received
When true, this indicates the property has received official permission from the award provider to use the rating in publications and marketing materials; when false this permission has not been granted.
Provides the symbol used in the rating. Used in conjunction with the Rating.
Purchasable items for this blocking.
This is one bookable item that can stand alongside a restaurant / meeting room etc.
object
Unique transactional identifier
Internal name of transactional blocking.
Localized descriptions describing inventory.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
How this blocking item should be priced.
Base price of booking this blocking.
object
If you are selling this blocking at a discount, indicate the discounted selling price. Leave empty if there is no discount.
object
List of images / videos of item.
Multimedia that contains less information than Multimedia object
object
Document identifier
Use this identifier to communicate with Cloudinary.
Whether Cloudinary media is a VIDEO or IMAGE.
Currently ONLY using Cloudinary to store all image / video assets.
Sort allows you to control how you want to sort this record in a list of media records.
Media angle
Media width in pixels.
Media height in pixels.
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Whether image has attribution properties
object
URL to contributor
Name of contributor
True if media width is greater or equal to height
Whether there is a limit to minimum group size.
Whether there is a limit to maximum group size.
Calculates the percent difference between basePrice and discountedPrice.
Calculates the percent difference between basePrice and discountedPrice.
Start month and day or date for which the attraction (e.g. the start of a season) is available. This date property signifies that the blocking is recurring and / or seasonal. If the date is in the past, only day and month will be used to infer seasonality. If the date is a future date, it will be interpreted as a starting date.
End month and day or date for which the attraction (e.g. the start of a season) is available. This date property signifies that the blocking is recurring and / or seasonal. If the date is in the past, only day and month will be used to infer seasonality. If the date is a future date, it will be interpreted as a ending date.
Indicates whether a reservation is required to participate in this blocking.
Opening time of blocking (if applicable). Leave empty if blocking is always available.
Closing time of blocking (if applicable). Leave empty if blocking is always available.
Indicate which days this blocking is open.
object
Set to true to enable Monday.
Set to true to enable Tuesday.
Set to true to enable Wednesday.
Set to true to enable Thursday.
Set to true to enable Friday.
Set to true to enable Saturday.
Set to true to enable Sunday.
Convenience property to quickly determine if this existing object has any active days enabled.
Total number of add-ons available to purchase.
Make this add-on mandatory for all guests by enabling this flag.
Optional restriction on rate plan.
Localized transactional blocking
object
Unique transactional identifier
Internal name of transactional blocking.
Localized descriptions describing inventory.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
How this blocking item should be priced.
Localized price
object
Hotel to user currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Hotel to wink currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Base total in user specified currency.
object
Base total in hotel currency.
object
Base total in wink currency.
object
Promotional modifiers in user specified currency
Promotional modifiers in hotel currency
Promotional modifiers in wink currency
Premium modifiers in user specified currency
Premium modifiers in hotel currency
Premium modifiers in wink currency
Channel / Membership modifier in user specified currency
Channel / Membership modifier in hotel currency
Channel / Membership modifier in wink currency
How many of this item is included in this price
Promotional discount percent
Channel discount percent
Premium percent
object
object
object
List of images / videos of item.
Multimedia that contains less information than Multimedia object
object
Document identifier
Use this identifier to communicate with Cloudinary.
Whether Cloudinary media is a VIDEO or IMAGE.
Currently ONLY using Cloudinary to store all image / video assets.
Sort allows you to control how you want to sort this record in a list of media records.
Media angle
Media width in pixels.
Media height in pixels.
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Whether image has attribution properties
object
URL to contributor
Name of contributor
True if media width is greater or equal to height
Whether there is a limit to minimum group size.
Whether there is a limit to maximum group size.
Localized offer details if rate plan discount applies.
object
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
If a package is linked to a rate plan the user could be entitled to a promotional discount if she enters a code. When this field is populated, it means the discount was applied to the package.
Channel inventory identifier referencing this record.
Whether this package is commissionable based on the incoming sales channel.
The commission percentage.
Indicates whether the blocking from sales channel is direct or not. If you are a travel agent doing your own acquiring, this flag has to be true to make a booking.
The combined value of these perkTypes
The active / selected cancellation policy for this room configuration
object
Unique cancellation policy identifier
Property this cancellation is associated with
Whether this cancellation policy is refundable or not
When the cancellation policy is refundable, this flag can be set and indicates there is more rules involved than just a no-questions-asked refundable.
If advanceCancellationFreeOfCharge rules is not honored, this property explains what the guest will be charged.
In case the ‘Refundable cancellation charge’ is set, a different no show charge can be applied.
When the cancellation policy is non-refundable, this flag can be set and indicates there is more rules involved to calculate what the guest will owe in case of a cancellation.
The non-refundable charge might can have a deadline. If that deadline passes, the guest might be charged more.
If the guest does not honor the non-refundable deadline rule, this charge dictates what she owes after the deadline passes.
Number of nights the guests will be staying
Localized transactional blocking
object
Unique transactional identifier
Internal name of transactional blocking.
Localized descriptions describing inventory.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
How this blocking item should be priced.
Localized price
object
Hotel to user currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Hotel to wink currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Base total in user specified currency.
object
Base total in hotel currency.
object
Base total in wink currency.
object
Promotional modifiers in user specified currency
Promotional modifiers in hotel currency
Promotional modifiers in wink currency
Premium modifiers in user specified currency
Premium modifiers in hotel currency
Premium modifiers in wink currency
Channel / Membership modifier in user specified currency
Channel / Membership modifier in hotel currency
Channel / Membership modifier in wink currency
How many of this item is included in this price
Promotional discount percent
Channel discount percent
Premium percent
object
object
object
List of images / videos of item.
Multimedia that contains less information than Multimedia object
object
Document identifier
Use this identifier to communicate with Cloudinary.
Whether Cloudinary media is a VIDEO or IMAGE.
Currently ONLY using Cloudinary to store all image / video assets.
Sort allows you to control how you want to sort this record in a list of media records.
Media angle
Media width in pixels.
Media height in pixels.
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Whether image has attribution properties
object
URL to contributor
Name of contributor
True if media width is greater or equal to height
Whether there is a limit to minimum group size.
Whether there is a limit to maximum group size.
Localized offer details if rate plan discount applies.
object
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
If a package is linked to a rate plan the user could be entitled to a promotional discount if she enters a code. When this field is populated, it means the discount was applied to the package.
object
object
object
object
Sales channel inventory identifier
This is one localized bookable item that can stand alongside a restaurant / meeting room etc.
object
Unique transactional identifier
Internal name of transactional blocking.
Localized descriptions describing inventory.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
How this blocking item should be priced.
Localized price
object
Hotel to user currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Hotel to wink currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Base total in user specified currency.
object
Base total in hotel currency.
object
Base total in wink currency.
object
Promotional modifiers in user specified currency
Promotional modifiers in hotel currency
Promotional modifiers in wink currency
Premium modifiers in user specified currency
Premium modifiers in hotel currency
Premium modifiers in wink currency
Channel / Membership modifier in user specified currency
Channel / Membership modifier in hotel currency
Channel / Membership modifier in wink currency
How many of this item is included in this price
Promotional discount percent
Channel discount percent
Premium percent
object
object
object
List of images / videos of item.
Multimedia that contains less information than Multimedia object
object
Document identifier
Use this identifier to communicate with Cloudinary.
Whether Cloudinary media is a VIDEO or IMAGE.
Currently ONLY using Cloudinary to store all image / video assets.
Sort allows you to control how you want to sort this record in a list of media records.
Media angle
Media width in pixels.
Media height in pixels.
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Whether image has attribution properties
object
URL to contributor
Name of contributor
True if media width is greater or equal to height
Whether there is a limit to minimum group size.
Whether there is a limit to maximum group size.
Localized offer details if rate plan discount applies.
object
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
If a package is linked to a rate plan the user could be entitled to a promotional discount if she enters a code. When this field is populated, it means the discount was applied to the package.
Whether this package is commissionable based on the incoming sales channel.
The commission percentage.
Indicates whether the blocking from sales channel is direct or not. If you are a travel agent doing your own acquiring, this flag has to be true to make a booking.
The actual amount of adults as determined by the hotel’s policy
The actual amount of children as determined by the hotel’s policy
SimpleDateTimeItinerary startDate
SimpleDateTimeItinerary endDate
Specified master rate identifier
Specified master rate internal name
Specified rate plan
object
Rate plan identifier
Provides the name of the rate plan.
When true, indicates breakfast is included.
When true, indicates brunch is included.
When true, indicates lunch is included.
When true, indicates dinner is included.
Everything included except alcohol
Everything included with alcohol
object
When the type is FIXED, fixedAmount is required. When the type is PERCENTAGE, percent is required.
A percentage of the total stay amount for an early check-in or late check-out
A localized amount
object
object
When the type is FIXED, fixedAmount is required. When the type is PERCENTAGE, percent is required.
A percentage of the total stay amount for an early check-in or late check-out
A localized amount
object
Perks that accompany the master rate
object
Enum identifier identifier for this perk. Makes the persistent version backwards compatible.
Whether perk is guaranteed or not.
The platform value of this perk.
Localized description for this perk
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
This is how perks get sorted when in a list
Calculated price
object
Base total in user specified currency.
object
Base total in hotel’s currency.
object
Base total in wink currency.
object
Extra person modifier in hotel currency.
Extra person modifier in wink currency
Extra person modifier in user specified currency
Extra child modifier in hotel currency
Extra child modifier in wink currency
Extra child modifier in user specified currcency
Single occupant modifier in hotel currency
Singe occupant modifier in wink currency
Single occupant modifier in user specified currency
Rate discount modifiers in hotel currency
Rate discount modifiers in wink currency
Rate discount modifiers in user specified currency
Rate premiums modifiers in hotel currency
Rate premiums modifiers in wink currency
Rate premiums modifiers in user specified currency
Channel / Membership modifier in hotel currency
Channel / Membership modifier in wink currency
Channel / Membership modifier in user specified currency
Quantity
Minimum occupancy
Maximum occupancy
Source
Promotional discount percent
Chanel discount percent
Premium percent
Available
Hotel to user currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Hotel to wink currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Localized text of the discount
object
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
Promotional codes
object
object
object
object
object
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
object
Unique record identifier.
Owner of daily rate.
Indicate where this rate originated from. Leave as TRAVELIKO unless you are a channel manager and responsible for the property’s rates externally of this platform.
Rate plan associated with this daily rate.
Guest room associated with this daily rate.
object
This flag indicates whether this rate is available for this date.
This flag indicates whether a guest can arrive at the property on this date.
This flag indicates whether a guest can leave the property on this date.
The date this rate is applicable for.
Amount of rooms available for this date.
Minimum number of guests allowed in a room type.
Maximum number of guest allowed in a room type.
Control the minimum length of stay at the day-level. This means that a guest arriving within this date range is required to stay at least these number of days in order to get this rate. Leave empty if you don’t want to update this property.
Control the maximum length of stay at the day-level. This means that a guest arriving within this date range is required to stay no longer than these number of days in order to get this rate. Leave empty if you don’t want to update this property.
object
When the type is FIXED, fixedAmount is required. When the type is PERCENTAGE, percent is required.
A percentage of the total stay amount for an early check-in or late check-out
A localized amount
object
object
When the type is FIXED, fixedAmount is required. When the type is PERCENTAGE, percent is required.
A percentage of the total stay amount for an early check-in or late check-out
A localized amount
object
object
When the type is FIXED, fixedAmount is required. When the type is PERCENTAGE, percent is required.
A percentage of the total stay amount for an early check-in or late check-out
A localized amount
object
Maximum number of adults allowed in a room type.
Maximum number of children allowed in a room type.
The number of pax the room price was meant for
The number of children the room price was meant for
object
Source
Target
Exchange rate
Timestamp
object
Source
Target
Exchange rate
Timestamp
object
object
Source
Target
Exchange rate
Timestamp
object
Source
Target
Exchange rate
Timestamp
Beneficiary is a registered account with rights to compensation within a booking.
object
AccountIdentifier of beneficiary that can map to an account with us
AccountName of beneficiary that can map to an account with us
AccountEmail of beneficiary that can map to an account with us
AccountUrl of beneficiary that can map to an account with us
The type of beneficiary payment.
The original slice requested
object
The type of charge
A percentage of the total stay amount for an early checkin or late checkout
The source currency
The display currency
The internal currency
Amount in source currency
Amount in display currency
Amount in internal currency
The delta from the original source amount after a refund occurred
The delta from the original display amount after a refund occurred
The delta from the original internal amount after a refund occurred
When a refund is first requested, it ends up here. Once it is applied, it moves out of this list and into the parent modifier property
object
This is the refund identifier located on the root bookingContract.refunds object
The delta from the original source amount after a refund occurred
The delta from the original display amount after a refund occurred
The delta from the original internal amount after a refund occurred
Source amount minus source modifier.
Display amount minus display modifier.
Internal amount minus internal modifier.
Whether a funds transfer has occurred for this booking.
Place to add more data related to the beneficiary.
object
object
Final per-night rate in hotel currency (base + modifiers). Computed at instantiation.
object
Final per-night rate in wink currency (base + modifiers). Computed at instantiation.
object
Final per-night rate in user specified currency (base + modifiers). Computed at instantiation.
object
object
object
object
object
Beneficiary is a registered account with rights to compensation within a booking.
object
AccountIdentifier of beneficiary that can map to an account with us
AccountName of beneficiary that can map to an account with us
AccountEmail of beneficiary that can map to an account with us
AccountUrl of beneficiary that can map to an account with us
The type of beneficiary payment.
The original slice requested
object
The type of charge
A percentage of the total stay amount for an early checkin or late checkout
The source currency
The display currency
The internal currency
Amount in source currency
Amount in display currency
Amount in internal currency
The delta from the original source amount after a refund occurred
The delta from the original display amount after a refund occurred
The delta from the original internal amount after a refund occurred
When a refund is first requested, it ends up here. Once it is applied, it moves out of this list and into the parent modifier property
object
This is the refund identifier located on the root bookingContract.refunds object
The delta from the original source amount after a refund occurred
The delta from the original display amount after a refund occurred
The delta from the original internal amount after a refund occurred
Source amount minus source modifier.
Display amount minus display modifier.
Internal amount minus internal modifier.
Whether a funds transfer has occurred for this booking.
Place to add more data related to the beneficiary.
object
User-defined currency final price.
object
Source currency final price.
object
Internal currency final price.
object
object
object
Source
Target
Exchange rate
Timestamp
object
Source
Target
Exchange rate
Timestamp
Beneficiary is a registered account with rights to compensation within a booking.
object
AccountIdentifier of beneficiary that can map to an account with us
AccountName of beneficiary that can map to an account with us
AccountEmail of beneficiary that can map to an account with us
AccountUrl of beneficiary that can map to an account with us
The type of beneficiary payment.
The original slice requested
object
The type of charge
A percentage of the total stay amount for an early checkin or late checkout
The source currency
The display currency
The internal currency
Amount in source currency
Amount in display currency
Amount in internal currency
The delta from the original source amount after a refund occurred
The delta from the original display amount after a refund occurred
The delta from the original internal amount after a refund occurred
When a refund is first requested, it ends up here. Once it is applied, it moves out of this list and into the parent modifier property
object
This is the refund identifier located on the root bookingContract.refunds object
The delta from the original source amount after a refund occurred
The delta from the original display amount after a refund occurred
The delta from the original internal amount after a refund occurred
Source amount minus source modifier.
Display amount minus display modifier.
Internal amount minus internal modifier.
Whether a funds transfer has occurred for this booking.
Place to add more data related to the beneficiary.
object
object
object
object
Beneficiary is a registered account with rights to compensation within a booking.
object
AccountIdentifier of beneficiary that can map to an account with us
AccountName of beneficiary that can map to an account with us
AccountEmail of beneficiary that can map to an account with us
AccountUrl of beneficiary that can map to an account with us
The type of beneficiary payment.
The original slice requested
object
The type of charge
A percentage of the total stay amount for an early checkin or late checkout
The source currency
The display currency
The internal currency
Amount in source currency
Amount in display currency
Amount in internal currency
The delta from the original source amount after a refund occurred
The delta from the original display amount after a refund occurred
The delta from the original internal amount after a refund occurred
When a refund is first requested, it ends up here. Once it is applied, it moves out of this list and into the parent modifier property
object
This is the refund identifier located on the root bookingContract.refunds object
The delta from the original source amount after a refund occurred
The delta from the original display amount after a refund occurred
The delta from the original internal amount after a refund occurred
Source amount minus source modifier.
Display amount minus display modifier.
Internal amount minus internal modifier.
Whether a funds transfer has occurred for this booking.
Place to add more data related to the beneficiary.
object
object
Per rate plan level extra charges with localized prices
object
List of extra charges that applies to the rate plan.
object
What the guest is paying extra for
object
List of localized descriptions for this fee.
object
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
Rate plan level fixed fee amount in property currency
object
Rate plan fee type
The localized unit price of the extra charge
object
Hotel to user currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Hotel to wink currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Base total in user specified currency.
object
Base total in hotel currency.
object
Base total in wink currency.
object
Promotional modifiers in user specified currency
Promotional modifiers in hotel currency
Promotional modifiers in wink currency
Premium modifiers in user specified currency
Premium modifiers in hotel currency
Premium modifiers in wink currency
Channel / Membership modifier in user specified currency
Channel / Membership modifier in hotel currency
Channel / Membership modifier in wink currency
How many of this item is included in this price
Promotional discount percent
Channel discount percent
Premium percent
object
object
object
The localized price of the extra charge
object
Hotel to user currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Hotel to wink currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Base total in user specified currency.
object
Base total in hotel currency.
object
Base total in wink currency.
object
Promotional modifiers in user specified currency
Promotional modifiers in hotel currency
Promotional modifiers in wink currency
Premium modifiers in user specified currency
Premium modifiers in hotel currency
Premium modifiers in wink currency
Channel / Membership modifier in user specified currency
Channel / Membership modifier in hotel currency
Channel / Membership modifier in wink currency
How many of this item is included in this price
Promotional discount percent
Channel discount percent
Premium percent
object
object
object
object
object
object
The selected room configuration that created this record
object
Number of adults
Children configurations
BookingItineraryRoomConfigurationChild configuration
object
Number of children
Age of children
Number of identical rooms of this configuration being booked
Add-ons that are available with this room configuration
object
The original add-on record created by the property.
object
Unique record identifier
Hotel identifier.
Indicates whether this inventory is featured. Use this flag as a way to signify that this inventory is special.
Indicate the type of lifestyle this blocking should be associated with.
Geo-location point where blocking takes place. Defaults to location of property.
object
Localized descriptions describing inventory.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
List of images / videos of blocking.
Multimedia that contains less information than Multimedia object
object
Document identifier
Use this identifier to communicate with Cloudinary.
Whether Cloudinary media is a VIDEO or IMAGE.
Currently ONLY using Cloudinary to store all image / video assets.
Sort allows you to control how you want to sort this record in a list of media records.
Media angle
Media width in pixels.
Media height in pixels.
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Whether image has attribution properties
object
URL to contributor
Name of contributor
True if media width is greater or equal to height
Associate a contact person for this blocking (if applicable).
object
Contact first name
Contact last name
Contact E-mail
Contact secondary Email
Contact phone number
First and last name
Summary
Defaults to property address.
object
Address line 1
Address line 2
State
Postal / zip code
County
City name
Country
Country
Address 1, Address 2, City, State, Postal / Zip code, Country
Indicate whether sales channels receive commission for selling this blocking.
Internal name of inventory.
Supported OTA specification PRX code. See OTA geoname data
Use this property to sort an blocking in a list of activities.
Supported OTA specification AQC code. See OTA geoname data
Indicates if this blocking can be added to a booking or if it is read-only marketing material only.
Modify blocking availability with this flag.
Supported OTA specification PHY code. See OTA geoname data
Supported OTA specification SEC code. See OTA geoname data
Social network accounts for blocking (if applicable).
Social network
object
Type of social network.
URL or social network identifier to social network profile
Level of expensiveness.
Inventory-level recognition.
Recognition for the ancillary blocking.
object
Recognition identifier.
Recognition category.
Type of rating system the recognition operated on. This allows us to display the score properly.
The name of the entity that administers this recognition.
The actual award or rating received by the hotel facility.
Use this to let hotels indicate what the total score for this award is.
The date the award was received
When true, this indicates the property has received official permission from the award provider to use the rating in publications and marketing materials; when false this permission has not been granted.
Provides the symbol used in the rating. Used in conjunction with the Rating.
Purchasable items for this blocking.
This is one bookable item that can stand alongside a restaurant / meeting room etc.
object
Unique transactional identifier
Internal name of transactional blocking.
Localized descriptions describing inventory.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
How this blocking item should be priced.
Base price of booking this blocking.
object
If you are selling this blocking at a discount, indicate the discounted selling price. Leave empty if there is no discount.
object
List of images / videos of item.
Multimedia that contains less information than Multimedia object
object
Document identifier
Use this identifier to communicate with Cloudinary.
Whether Cloudinary media is a VIDEO or IMAGE.
Currently ONLY using Cloudinary to store all image / video assets.
Sort allows you to control how you want to sort this record in a list of media records.
Media angle
Media width in pixels.
Media height in pixels.
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Whether image has attribution properties
object
URL to contributor
Name of contributor
True if media width is greater or equal to height
Whether there is a limit to minimum group size.
Whether there is a limit to maximum group size.
Calculates the percent difference between basePrice and discountedPrice.
Calculates the percent difference between basePrice and discountedPrice.
Start month and day or date for which the attraction (e.g. the start of a season) is available. This date property signifies that the blocking is recurring and / or seasonal. If the date is in the past, only day and month will be used to infer seasonality. If the date is a future date, it will be interpreted as a starting date.
End month and day or date for which the attraction (e.g. the start of a season) is available. This date property signifies that the blocking is recurring and / or seasonal. If the date is in the past, only day and month will be used to infer seasonality. If the date is a future date, it will be interpreted as a ending date.
Indicates whether a reservation is required to participate in this blocking.
Opening time of blocking (if applicable). Leave empty if blocking is always available.
Closing time of blocking (if applicable). Leave empty if blocking is always available.
Indicate which days this blocking is open.
object
Set to true to enable Monday.
Set to true to enable Tuesday.
Set to true to enable Wednesday.
Set to true to enable Thursday.
Set to true to enable Friday.
Set to true to enable Saturday.
Set to true to enable Sunday.
Convenience property to quickly determine if this existing object has any active days enabled.
Total number of add-ons available to purchase.
Make this add-on mandatory for all guests by enabling this flag.
Optional restriction on rate plan.
Localized transactional blocking
object
Unique transactional identifier
Internal name of transactional blocking.
Localized descriptions describing inventory.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
How this blocking item should be priced.
Localized price
object
Hotel to user currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Hotel to wink currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Base total in user specified currency.
object
Base total in hotel currency.
object
Base total in wink currency.
object
Promotional modifiers in user specified currency
Promotional modifiers in hotel currency
Promotional modifiers in wink currency
Premium modifiers in user specified currency
Premium modifiers in hotel currency
Premium modifiers in wink currency
Channel / Membership modifier in user specified currency
Channel / Membership modifier in hotel currency
Channel / Membership modifier in wink currency
How many of this item is included in this price
Promotional discount percent
Channel discount percent
Premium percent
object
object
object
List of images / videos of item.
Multimedia that contains less information than Multimedia object
object
Document identifier
Use this identifier to communicate with Cloudinary.
Whether Cloudinary media is a VIDEO or IMAGE.
Currently ONLY using Cloudinary to store all image / video assets.
Sort allows you to control how you want to sort this record in a list of media records.
Media angle
Media width in pixels.
Media height in pixels.
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Whether image has attribution properties
object
URL to contributor
Name of contributor
True if media width is greater or equal to height
Whether there is a limit to minimum group size.
Whether there is a limit to maximum group size.
Localized offer details if rate plan discount applies.
object
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
If a package is linked to a rate plan the user could be entitled to a promotional discount if she enters a code. When this field is populated, it means the discount was applied to the package.
Channel inventory identifier referencing this record.
Whether this package is commissionable based on the incoming sales channel.
The commission percentage.
Indicates whether the blocking from sales channel is direct or not. If you are a travel agent doing your own acquiring, this flag has to be true to make a booking.
The combined value of these perkTypes
The active / selected cancellation policy for this room configuration
object
Unique cancellation policy identifier
Property this cancellation is associated with
Whether this cancellation policy is refundable or not
When the cancellation policy is refundable, this flag can be set and indicates there is more rules involved than just a no-questions-asked refundable.
If advanceCancellationFreeOfCharge rules is not honored, this property explains what the guest will be charged.
In case the ‘Refundable cancellation charge’ is set, a different no show charge can be applied.
When the cancellation policy is non-refundable, this flag can be set and indicates there is more rules involved to calculate what the guest will owe in case of a cancellation.
The non-refundable charge might can have a deadline. If that deadline passes, the guest might be charged more.
If the guest does not honor the non-refundable deadline rule, this charge dictates what she owes after the deadline passes.
Number of nights the guests will be staying
Localized transactional blocking
object
Unique transactional identifier
Internal name of transactional blocking.
Localized descriptions describing inventory.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
How this blocking item should be priced.
Localized price
object
Hotel to user currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Hotel to wink currency exchange rate.
object
Source
Target
Exchange rate
Timestamp
Base total in user specified currency.
object
Base total in hotel currency.
object
Base total in wink currency.
object
Promotional modifiers in user specified currency
Promotional modifiers in hotel currency
Promotional modifiers in wink currency
Premium modifiers in user specified currency
Premium modifiers in hotel currency
Premium modifiers in wink currency
Channel / Membership modifier in user specified currency
Channel / Membership modifier in hotel currency
Channel / Membership modifier in wink currency
How many of this item is included in this price
Promotional discount percent
Channel discount percent
Premium percent
object
object
object
List of images / videos of item.
Multimedia that contains less information than Multimedia object
object
Document identifier
Use this identifier to communicate with Cloudinary.
Whether Cloudinary media is a VIDEO or IMAGE.
Currently ONLY using Cloudinary to store all image / video assets.
Sort allows you to control how you want to sort this record in a list of media records.
Media angle
Media width in pixels.
Media height in pixels.
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Whether image has attribution properties
object
URL to contributor
Name of contributor
True if media width is greater or equal to height
Whether there is a limit to minimum group size.
Whether there is a limit to maximum group size.
Localized offer details if rate plan discount applies.
object
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
If a package is linked to a rate plan the user could be entitled to a promotional discount if she enters a code. When this field is populated, it means the discount was applied to the package.
object
object
object
object
object
object
object
Example
[ { "accessibleMasterRates": [ null ], "accessibleInventory": [ { "id": "", "createdDate": "", "lastUpdate": "", "version": "", "salesChannel": "", "inventoryType": "GUEST_ROOM", "inventoryIdentifier": "", "inventoryName": "", "inventoryNameInEnglish": "", "enabled": true, "image": "", "pricePoint": "HALF", "location": "", "address": "", "quantity": 0, "commissionable": false, "bookable": true, "continent": "", "countryCode": "", "countryGeoNameId": "", "cityGeoNameId": "", "cityUrlName": "", "lowestPrice": "", "lowestDisplayPrice": "" } ], "accessibleAvailability": [ { "room": { "identifier": "", "hotelIdentifier": "", "featuredInd": false, "lifestyleType": "LIFESTYLE_HEALTH_FITNESS", "location": "", "descriptions": [ "" ], "multimedias": [ "" ], "contact": "", "address": "", "commissionable": true, "name": "", "proximityCode": "", "sort": "", "minAgeAppropriateCode": "", "bookable": true, "active": true, "disabilityFeatures": [ "" ], "securityFeatures": [ "" ], "socials": [ "" ], "pricePoint": "HALF", "recognitionList": [ "" ], "transactionalInventoryList": [ "" ], "maxOccupancy": 2, "minOccupancy": 1, "quantity": "", "nonSmoking": false, "bedroomConfigurationList": [ "" ], "size": "", "maxAdultOccupancy": 2, "maxChildOccupancy": 0, "bathroomCount": 1, "livingRoomCount": 1, "maxRollaways": 0, "roomCategory": "", "floor": "", "roomLocationCode": "", "roomViewCode": "", "composite": false, "compositeCount": 0, "roomClassificationCode": "", "roomArchitectureCode": "", "roomGender": "Male", "sharedRoomInd": false, "maxCribs": 0, "amenities": [ "" ], "includedAdultOccupancy": 2, "includedChildOccupancy": 0, "baseRate": "", "minRate": "" }, "bestPrice": { "channelInventoryIdentifier": "", "list": [ null ], "commissionable": false, "commission": "", "direct": false, "adults": "", "children": "", "startDate": "", "endDate": "", "roomRateIdentifier": "", "roomRateInternalName": "", "ratePlan": "", "perkTypes": [ "" ], "price": "", "extraCharges": "", "configuration": "", "addOnOffers": [ "" ], "perkValue": "", "activeCancellationPolicy": "", "roomNights": "", "priceList": [ null ] }, "priceConfigurations": [ { "channelInventoryIdentifier": "", "list": [ null ], "commissionable": false, "commission": "", "direct": false, "adults": "", "children": "", "startDate": "", "endDate": "", "roomRateIdentifier": "", "roomRateInternalName": "", "ratePlan": "", "perkTypes": [ "" ], "price": "", "extraCharges": "", "configuration": "", "addOnOffers": [ "" ], "perkValue": "", "activeCancellationPolicy": "", "roomNights": "", "priceList": [ null ] } ] } ] }]Bad Request
object
object
Example generated
{ "type": "https://example.com", "title": "example", "status": 1, "detail": "example", "instance": "https://example.com", "properties": { "additionalProperty": "example" }}object
object
object
object
object
object
object
object
Unauthorized
object
object
Forbidden
object
object
Internal Server Error
object
Example generated
{}