Test 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', Authorization: 'Bearer <token>', 'Content-Type': 'application/json' }, body: '{"channel":{"propertyIdentifier":"the-siam-residences","subType":"HOTEL","ownerIdentifier":"3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51","name":"The Siam Residences - Direct Channel"},"roomConfigurations":[{"adults":2,"children":[{"quantity":2,"age":7}],"quantity":1}],"city":{"geoNameId":"1609350","localeCode":"en","continentCode":"AS","continentName":"Asia","countryIsoCode":"TH","countryName":"Thailand","cityName":"Bangkok","timezone":"Asia/Bangkok","subDivision1Code":"10","subDivision1Name":"Bangkok","subDivision2Code":"1001","subDivision2Name":"Phra Nakhon"},"country":{"geoNameId":"1609350","continentCode":"AS","continentName":"Asia","countryIsoCode":"TH","countryName":"Thailand"}}'};
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 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --header 'Wink-Version: 2.0' \ --data '{ "channel": { "propertyIdentifier": "the-siam-residences", "subType": "HOTEL", "ownerIdentifier": "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "name": "The Siam Residences - Direct Channel" }, "roomConfigurations": [ { "adults": 2, "children": [ { "quantity": 2, "age": 7 } ], "quantity": 1 } ], "city": { "geoNameId": "1609350", "localeCode": "en", "continentCode": "AS", "continentName": "Asia", "countryIsoCode": "TH", "countryName": "Thailand", "cityName": "Bangkok", "timezone": "Asia/Bangkok", "subDivision1Code": "10", "subDivision1Name": "Bangkok", "subDivision2Code": "1001", "subDivision2Name": "Phra Nakhon" }, "country": { "geoNameId": "1609350", "continentCode": "AS", "continentName": "Asia", "countryIsoCode": "TH", "countryName": "Thailand" } }'Runs a sandbox search against the selected sales channel and returns the available and unavailable rooms, with descriptive daily rate detail, so the property can verify its rates resolve correctly.
Authorizations
Section titled “Authorizations ”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 verification request containing the sales channel identifier, occupancy and desired stay dates to test against
object
Channel owner of inventory
object
Type of entity that manages, facilitates, or administers properties, bookings, or payments on the Wink Platform
Example
{ "propertyIdentifier": "the-siam-residences", "subType": "HOTEL", "ownerIdentifier": "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "name": "The Siam Residences - Direct Channel"}Arrival date
Departure date
Desired room configuration
object
Number of adult guests in this room type
Example
2Child guests in this room, with age groups
Child guest with age and quantity in a room configuration
object
Count of children of this age group in the room
Example
2Age of each child in this group (years)
Example
7Example
{ "quantity": 2, "age": 7}Number of identical rooms with this configuration
Example
1Example
{ "adults": 2, "children": [ { "quantity": 2, "age": 7 } ], "quantity": 1}Display currency
The booking start date
The sell start date
The sell end date
A promo code
A booker coming from a specific city
object
Locale code
Example
enContinent code
Example
NAContinent name
Example
North AmericaCountry ISO code
Example
USCountry name
Example
United StatesCity name
Example
New YorkTimezone
Example
America/New_YorkSub-division 1 code
Example
NYSub-division 1 name
Example
NYSub-division 2 code
Example
KingsSub-division 2 name
Example
Kings CountyExample
{ "geoNameId": "1609350", "localeCode": "en", "continentCode": "AS", "continentName": "Asia", "countryIsoCode": "TH", "countryName": "Thailand", "cityName": "Bangkok", "timezone": "Asia/Bangkok", "subDivision1Code": "10", "subDivision1Name": "Bangkok", "subDivision2Code": "1001", "subDivision2Name": "Phra Nakhon"}A booker coming from a specific country
object
GeoNames identifier
Example
1609350Continent code (two-letter ISO)
Example
ASContinent name
Example
AsiaCountry ISO 3166-1 alpha-2 code
Example
THCountry name
Example
ThailandExample
{ "geoNameId": "1609350", "continentCode": "AS", "continentName": "Asia", "countryIsoCode": "TH", "countryName": "Thailand"}A booker coming from a specific continent
A booker coming from a specific IP number
A booker coming from a specific timezone
A booker coming from a specific latitude
A booker coming from a specific longitude
Example
{ "channel": { "propertyIdentifier": "the-siam-residences", "subType": "HOTEL", "ownerIdentifier": "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "name": "The Siam Residences - Direct Channel" }, "roomConfigurations": [ { "adults": 2, "children": [ { "quantity": 2, "age": 7 } ], "quantity": 1 } ], "city": { "geoNameId": "1609350", "localeCode": "en", "continentCode": "AS", "continentName": "Asia", "countryIsoCode": "TH", "countryName": "Thailand", "cityName": "Bangkok", "timezone": "Asia/Bangkok", "subDivision1Code": "10", "subDivision1Name": "Bangkok", "subDivision2Code": "1001", "subDivision2Name": "Phra Nakhon" }, "country": { "geoNameId": "1609350", "continentCode": "AS", "continentName": "Asia", "countryIsoCode": "TH", "countryName": "Thailand" }}Responses
Section titled “ Responses ”OK
A wrapper around a room with metadata about availability and pricing, including accessible and inaccessible master rates, inventory, rate plans, and availability details
object
A master rate is the base pricing unit that combines a room type with a rate plan, controlling availability and pricing across all sales channels.
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.
Property (managing entity) identifier that owns this master rate.
Internal name of master rate. Auto-generated by combining room type and rate plan names.
Room type details for this master rate
object
Unique identifier for this room type.
Property identifier that owns this room type.
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.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
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.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
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.
OpenTravel proximity code (1=on site, 2=off site, 3=not available). See OTA geoname data
Use this property to sort an inventory in a list of activities.
OpenTravel age qualifying code (e.g., 1=any age, 2=adult only, 5=children only). 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.
OpenTravel physical/disability feature codes (e.g., 1=wheelchair accessible, 5=accessible bathroom). See OTA geoname data
OpenTravel security feature codes (e.g., 1=safe, 7=electronic safe, 14=alarm). 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.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
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
Monetary amount value
ISO 4217 currency code
If you are selling this blocking at a discount, indicate the discounted selling price. Leave empty if there is no discount.
object
Monetary amount value
ISO 4217 currency code
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.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
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.
A named bedroom layout configuration for a room type, containing one or more bedrooms each with their own bed setup.
object
Unique identifier for this bedroom configuration layout.
Human-readable name of this room layout configuration.
List of bedrooms within this configuration layout.
A single bedroom within a room type, specifying the bedroom type and its bed configuration.
object
Bedroom type classification (e.g., MASTER, QUEEN, JUNIOR, DORMITORY, BEDROOM_1…BEDROOM_10).
List of bed configurations for this bedroom. Each entry specifies a bed type and quantity.
A single bed type and its quantity within a bedroom, described using the OpenTravel bed type code.
object
OpenTravel bed type code (e.g., 1=Double, 2=Twin, 7=Queen, 8=King). See OTA geoname data.
Number of beds of this type in the room.
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.
OpenTravel segment category code (e.g., 1=Moderate, 4=Standard, 8=Deluxe). See OTA geoname data
Floor number on which this room type is located.
OpenTravel room location type code (e.g., 1=Near Exit, 2=Close to Elevator, 3=Low Floor, 4=High Floor). See OTA geoname data
OpenTravel room view type code (e.g., 1=Ocean View, 2=Pool View, 3=Garden View). See OTA geoname data
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.
OpenTravel guest room info code (e.g., 1=Suite, 2=Standard, 12=Villa, 16=Bungalow). See OTA geoname data
OpenTravel architectural style code (e.g., 1=Modern, 2=Traditional, 3=Victorian). 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.
OpenTravel room amenity codes (e.g., 1=Balcony, 7=Air Conditioning). 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
Monetary amount value
ISO 4217 currency code
Typical one night rate in a distressed period
object
Monetary amount value
ISO 4217 currency code
Rate plan details for this master rate
object
Unique identifier for this rate plan.
The property (managing entity) that owns this rate plan.
A descriptive name for this rate plan, such as ‘Best Available Rate’, ‘Non-Refundable’, or ‘Corporate Rate’.
When true, indicates if the rate is a prepaid rate.
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
The date on which this rate plan becomes available for booking. If both sellStartDate and sellEndDate are set, the rate can only be sold within that date range.
The date on which this rate plan is no longer available for booking. If both sellStartDate and sellEndDate are set, the rate can only be sold within that date range.
The earliest date a guest can check in to use this rate plan. If both stayStartDate and stayEndDate are set, the rate can only be used for stays within that date range.
The latest date a guest can check in to use this rate plan. If both stayStartDate and stayEndDate are set, the rate can only be used for stays within that date range.
When true, guests earn loyalty points toward the property’s loyalty program with this rate plan. When false, this rate plan does not accrue points.
Maximum number of days in advance a guest may book this rate plan. For example, 180 allows bookings up to 6 months ahead.
Minimum number of days in advance a guest must book this rate plan. For example, 3 requires booking at least 3 days before arrival.
Minimum number of guests required to qualify for this rate plan.
Maximum number of guests allowed under this rate plan.
Minimum consecutive nights required for a booking under this rate plan. For example, 2 requires a minimum 2-night stay.
Maximum consecutive nights allowed for a booking under this rate plan. For example, 30 caps bookings at 30 nights.
Minimum guest age required to book this rate plan, typically used for senior discounts or adult-only rates.
Maximum guest age allowed for this rate plan, typically used for family or age-restricted rates.
Additional fees applied to this rate plan, such as resort facilities fees, parking fees, or cleaning charges. Fees can be charged per day, per stay, per person, or combinations thereof.
An additional fee attached to a rate plan, such as a resort facility fee, cleaning fee, or parking fee. The fee amount and how it is charged (per day, per stay, per person, etc.) are defined per fee entry.
object
Localized descriptions of this fee in multiple languages. At least one entry in English is required.
Simplified localized description containing text content and its language code.
object
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
The fixed fee amount in the property’s local currency.
object
Monetary amount value
ISO 4217 currency code
How this fee is charged: per day, per stay, per person per day, or per person per stay.
Days of the week when this rate plan is available for booking. If null, the rate plan is available on all days.
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.
Days of the week on which guests are allowed to check in. If null, arrivals are permitted on any day.
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.
Days of the week on which guests are allowed to check out. If null, departures are permitted on any day.
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.
Days of the week on which at least one night must fall within the stay. Useful for rates requiring weekend stays or specific weekday requirements. If null, no specific day-of-week stay requirements apply.
object
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.
A pricing modifier for guests checking in early. May include a surcharge or credit. If null, no early check-in charge applies.
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
Monetary amount value
ISO 4217 currency code
A pricing modifier for guests staying late after standard checkout time. May include a surcharge or credit. If null, no late check-out charge applies.
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
Monetary amount value
ISO 4217 currency code
The cancellation policy that governs refunds and cancellations 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.
Optional overrides of the cancellation policy for specific date ranges. Allows a property to apply different cancellation terms during peak seasons, events, or special periods. Leave null for no date-specific exceptions.
object
List of cancellation policy exceptions
object
Cancellation policy identifier
Cancellation policy details for this exception
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.
A pricing modifier applied when a single guest books this rate plan. For example, a 10% discount for solo travelers. If null, no single occupancy adjustment applies.
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
Monetary amount value
ISO 4217 currency code
A pricing modifier applied for each additional adult guest beyond the base occupancy. For example, a per-person surcharge for extra occupants. If null, no extra adult adjustment applies.
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
Monetary amount value
ISO 4217 currency code
A pricing modifier applied for each additional child guest. Typically used for child discounts or family rate adjustments. If null, no extra child adjustment applies.
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
Monetary amount value
ISO 4217 currency code
Whether this master rate is enabled for sale across all sales channels
Perks (incentives) offered with this master rate to encourage bookings
object
Unique enum-like string identifier for this perk (e.g., PERK_GUARANTEED_UPGRADE). Enables backwards compatibility by persisting the identifier rather than relying on ordinal position.
Whether this perk is guaranteed to be provided or available on a best-effort basis. Guaranteed perks take priority in allocation.
Platform tier/value assigned to this perk (0=standard, higher=premium). Used for internal prioritization and matching with rate tiers.
Localized descriptions of this perk in multiple languages. Each element provides a name, description, and language code (e.g., ‘en’, ‘fr’, ‘de’).
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
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.
Display order when showing this perk in a list (ascending sort). Lower numbers appear first; 999 is reserved for disabled/unlisted perks.
Descriptive reason container carrying an identifier, a name, an optional attribute map, and a list of human-readable reason strings used for verification or validation feedback
object
Unique identifier of the entity or rule this reason is associated with
Human-readable name of the entity or rule associated with this reason
Optional key-value attribute map providing additional context for the reason
object
List of human-readable reason strings explaining why verification failed or an action is required
A bookable inventory item tied to a sales channel, representing a guest room, meeting room, spa, restaurant, add-on, attraction, activity, or place made available for booking.
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
A lightweight projection of a special rate (promotion) containing all qualifying conditions and metadata.
object
Unique identifier of this promotion.
Unique identifier of the property this promotion belongs to.
Internal name of promotion.
Set whether you want the price to go up or down when the rules of this promotion have been satisfied.
The discount or premium amount and its type (fixed or percentage).
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
Monetary amount value
ISO 4217 currency code
Whether this promotion is enabled or not.
This determines whether this discount should be applied per night, per stay or per person - per night
Simplified localized description containing text content and its language code.
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.
Qualifier that restricts a promotion to guests whose IP geolocation resolves to a specific city.
object
City details (obtained via geonames) to restrict the promotion by guest location.
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
Qualifier that restricts a promotion to guests whose IP geolocation resolves to a specific continent.
object
Two-letter continent code (e.g. NA, EU, AS)
Qualifier that restricts a promotion to guests whose IP geolocation resolves to a specific country.
object
Country (obtained via geonames) to restrict the promotion by guest location.
object
GeoNames identifier
Continent code (two-letter ISO)
Continent name
Country ISO 3166-1 alpha-2 code
Country name
Qualifier that restricts a promotion to guests who enter a specific promotional code at checkout.
object
Promo code that guests must enter to access this promotion.
Qualifier that restricts a promotion to guests whose IP address falls within a specified IPv4 range.
object
Starting IP address of the range (inclusive).
Ending IP address of the range (inclusive).
Restrict promotion by restricting to how many rooms the user wants.
object
Minimum number of rooms in the booking for this promotion to apply.
Maximum number of rooms in the booking. Leave null or 0 for no upper limit.
Restrict promotion to either prepaid / non-prepaid rates.
object
True to apply only to prepaid rates, false to apply only to pay-at-property rates.
Restrict promotion to either refundable / non-refundable rates.
object
True to apply only to refundable rates, false to apply only to non-refundable rates.
Qualifier that restricts a promotion to guests whose system timezone matches the specified IANA timezone name.
object
IANA timezone name of the booker’s location (e.g. Asia/Bangkok).
Restrict promotion to users who want to book a room close to the date.
object
Number of seconds before the arrival date when the promotion becomes active (last-minute bookings).
Restrict promotion to users who want to stay a certain number of days.
object
Minimum number of nights for promotion to apply. Set to 0 for no minimum.
Maximum number of nights. Set to 0 for no maximum.
Restrict promotion to users who want to book in advance.
object
Minimum days in advance of stay start date when the booking must be made. Set to 0 for no minimum.
Maximum days in advance of stay start date when the booking may be made. Set to 0 for no maximum.
Rate qualifier that restricts a promotion to guests whose stay falls within a specific date range.
object
Promotion applies when guest’s stay starts on or after this date (inclusive).
Promotion applies when guest’s stay starts on or before this date (inclusive).
Qualifier that restricts a promotion to bookings made within a specific date window.
object
Promotion is available when the booking is made on or after this date (inclusive).
Promotion is available when the booking is made on or before this date (inclusive).
Restrict promotion to specific days of the week the promotion is available.
object
The days of the week when this rate is available for booking
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 the guest is allowed to depart
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.
A date range during which a promotion is not available (blackout period).
object
Start date when the promotion is not available (inclusive).
End date when the promotion is not available (inclusive).
Promotion bundles for this channel
A lightweight projection of a promotion bundle containing the full set of qualifying conditions and metadata.
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 identifier of this promotion.
Unique identifier of the property this promotion belongs to.
Internal name of promotion.
Set whether you want the price to go up or down when the rules of this promotion have been satisfied.
The discount or premium amount and its type (fixed or percentage).
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
Monetary amount value
ISO 4217 currency code
Whether this promotion is enabled or not.
This determines whether this discount should be applied per night, per stay or per person - per night
Simplified localized description containing text content and its language code.
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.
Qualifier that restricts a promotion to guests whose IP geolocation resolves to a specific city.
object
City details (obtained via geonames) to restrict the promotion by guest location.
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
Qualifier that restricts a promotion to guests whose IP geolocation resolves to a specific continent.
object
Two-letter continent code (e.g. NA, EU, AS)
Qualifier that restricts a promotion to guests whose IP geolocation resolves to a specific country.
object
Country (obtained via geonames) to restrict the promotion by guest location.
object
GeoNames identifier
Continent code (two-letter ISO)
Continent name
Country ISO 3166-1 alpha-2 code
Country name
Qualifier that restricts a promotion to guests who enter a specific promotional code at checkout.
object
Promo code that guests must enter to access this promotion.
Qualifier that restricts a promotion to guests whose IP address falls within a specified IPv4 range.
object
Starting IP address of the range (inclusive).
Ending IP address of the range (inclusive).
Restrict promotion by restricting to how many rooms the user wants.
object
Minimum number of rooms in the booking for this promotion to apply.
Maximum number of rooms in the booking. Leave null or 0 for no upper limit.
Restrict promotion to either prepaid / non-prepaid rates.
object
True to apply only to prepaid rates, false to apply only to pay-at-property rates.
Restrict promotion to either refundable / non-refundable rates.
object
True to apply only to refundable rates, false to apply only to non-refundable rates.
Qualifier that restricts a promotion to guests whose system timezone matches the specified IANA timezone name.
object
IANA timezone name of the booker’s location (e.g. Asia/Bangkok).
Restrict promotion to users who want to book a room close to the date.
object
Number of seconds before the arrival date when the promotion becomes active (last-minute bookings).
Restrict promotion to users who want to stay a certain number of days.
object
Minimum number of nights for promotion to apply. Set to 0 for no minimum.
Maximum number of nights. Set to 0 for no maximum.
Restrict promotion to users who want to book in advance.
object
Minimum days in advance of stay start date when the booking must be made. Set to 0 for no minimum.
Maximum days in advance of stay start date when the booking may be made. Set to 0 for no maximum.
Rate qualifier that restricts a promotion to guests whose stay falls within a specific date range.
object
Promotion applies when guest’s stay starts on or after this date (inclusive).
Promotion applies when guest’s stay starts on or before this date (inclusive).
Qualifier that restricts a promotion to bookings made within a specific date window.
object
Promotion is available when the booking is made on or after this date (inclusive).
Promotion is available when the booking is made on or before this date (inclusive).
Restrict promotion to specific days of the week the promotion is available.
object
The days of the week when this rate is available for booking
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 the guest is allowed to depart
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.
A date range during which a promotion is not available (blackout period).
object
Start date when the promotion is not available (inclusive).
End date when the promotion is not available (inclusive).
Optional: override the combined discount of all bundle items with a single fixed or percentage amount.
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
Monetary amount value
ISO 4217 currency code
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.
Simplified localized description containing text content and its language code.
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.
Simplified localized description containing text content and its language code.
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.
Simplified localized description containing text content and its language code.
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.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
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
Monetary amount value
ISO 4217 currency code
Best price of the room type or facility ancillary in platform currency
object
Monetary amount value
ISO 4217 currency code
Descriptive reason container carrying an identifier, a name, an optional attribute map, and a list of human-readable reason strings used for verification or validation feedback
object
Unique identifier of the entity or rule this reason is associated with
Human-readable name of the entity or rule associated with this reason
Optional key-value attribute map providing additional context for the reason
object
List of human-readable reason strings explaining why verification failed or an action is required
Descriptive reason container carrying an identifier, a name, an optional attribute map, and a list of human-readable reason strings used for verification or validation feedback
object
Unique identifier of the entity or rule this reason is associated with
Human-readable name of the entity or rule associated with this reason
Optional key-value attribute map providing additional context for the reason
object
List of human-readable reason strings explaining why verification failed or an action is required
object
A lightweight projection of a room type, carrying all occupancy, bedroom configuration, pricing and classification details needed for availability and booking flows.
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.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
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.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
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.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
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
Monetary amount value
ISO 4217 currency code
If you are selling this blocking at a discount, indicate the discounted selling price. Leave empty if there is no discount.
object
Monetary amount value
ISO 4217 currency code
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.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
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.
A named bedroom layout configuration for a room type, containing one or more bedrooms each with their own bed setup.
object
Unique identifier for this bedroom configuration layout.
Human-readable name of this room layout configuration.
List of bedrooms within this configuration layout.
A single bedroom within a room type, specifying the bedroom type and its bed configuration.
object
Bedroom type classification (e.g., MASTER, QUEEN, JUNIOR, DORMITORY, BEDROOM_1…BEDROOM_10).
List of bed configurations for this bedroom. Each entry specifies a bed type and quantity.
A single bed type and its quantity within a bedroom, described using the OpenTravel bed type code.
object
OpenTravel bed type code (e.g., 1=Double, 2=Twin, 7=Queen, 8=King). See OTA geoname data.
Number of beds of this type in the room.
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.
OpenTravel segment category code (e.g., 1=Moderate, 4=Standard, 8=Deluxe). See OTA geoname data
Floor number on which this room type is located.
OpenTravel room location type code (e.g., 1=Near Exit, 2=Close to Elevator, 3=Low Floor, 4=High Floor). See OTA geoname data
OpenTravel room view type code (e.g., 1=Ocean View, 2=Pool View, 3=Garden View). See OTA geoname data
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.
OpenTravel guest room info code (e.g., 1=Suite, 2=Standard, 12=Villa, 16=Bungalow). See OTA geoname data
OpenTravel architectural style code (e.g., 1=Modern, 2=Traditional, 3=Victorian). 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.
OpenTravel room amenity codes (e.g., 1=Balcony, 7=Air Conditioning). 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
Monetary amount value
ISO 4217 currency code
Typical one night rate in a distressed period
object
Monetary amount value
ISO 4217 currency code
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.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
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
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Hotel to wink currency exchange rate.
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
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
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
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.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
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.
Simplified localized description containing text content and its language code.
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
Monetary amount value
ISO 4217 currency code
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
Monetary amount value
ISO 4217 currency code
Perks that accompany the master rate
object
Unique enum-like string identifier for this perk (e.g., PERK_GUARANTEED_UPGRADE). Enables backwards compatibility by persisting the identifier rather than relying on ordinal position.
Whether this perk is guaranteed to be provided or available on a best-effort basis. Guaranteed perks take priority in allocation.
Platform tier/value assigned to this perk (0=standard, higher=premium). Used for internal prioritization and matching with rate tiers.
Localized descriptions of this perk in multiple languages. Each element provides a name, description, and language code (e.g., ‘en’, ‘fr’, ‘de’).
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
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.
Display order when showing this perk in a list (ascending sort). Lower numbers appear first; 999 is reserved for disabled/unlisted perks.
Calculated price
object
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Base total in hotel’s currency.
object
Monetary amount value
ISO 4217 currency code
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
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
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Hotel to wink currency exchange rate.
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Localized text of the discount
Simplified localized description containing text content and its language code.
object
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
Promotional codes
object
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Simplified localized description containing text content and its language code.
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.
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
This 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
Monetary amount value
ISO 4217 currency code
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
Monetary amount value
ISO 4217 currency code
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
Monetary amount value
ISO 4217 currency code
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
Lightweight representation of an exchange rate quote between a source and target currency pair
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Lightweight representation of an exchange rate quote between a source and target currency pair
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
object
Lightweight representation of an exchange rate quote between a source and target currency pair
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Lightweight representation of an exchange rate quote between a source and target currency pair
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
A beneficiary is a registered account entitled to a portion of booking funds. Funds are allocated by type (SALE, COMMISSION, PLATFORM_FEE, etc.) and tracked across source, display, and internal (platform) currencies. Refund modifiers record adjustments from cancellations.
object
Unique identifier of the beneficiary’s account in the TripPay system
Display name of the beneficiary account (e.g. hotel, affiliate, or platform name)
Contact email address for the beneficiary account
Profile or dashboard URL for the beneficiary account
Category of the beneficiary: SALE (property), COMMISSION (affiliate), PLATFORM_FEE (Wink), TRIP_PAY (platform internal), or agency fees
Charge rule: either a fixed percentage of the total stay or the remainder after other beneficiaries are deducted
object
PERCENTAGE: apply the percent field to the total booking price. REMAINDER: this beneficiary receives whatever is left after other beneficiaries are satisfied (typically used for the hotel).
The percentage value (0.0–1.0) to apply to the total booking amount when type=PERCENTAGE. For example, 0.050 = 5% of the booking price. Ignored when type=REMAINDER.
ISO 4217 currency code for the originating source (supplier’s local currency, e.g. hotel in Thailand uses THB)
ISO 4217 currency code for display to the user (e.g. booking shown in USD)
ISO 4217 currency code for internal platform ledger (always USD)
Gross amount owed to this beneficiary in source currency (before refunds)
Gross amount owed to this beneficiary in display currency (before refunds)
Gross amount owed to this beneficiary in internal currency (before refunds)
Cumulative refund reduction applied to sourceAmount (sum of all applied PendingRefunds)
Cumulative refund reduction applied to displayAmount (sum of all applied PendingRefunds)
Cumulative refund reduction applied to internalAmount (sum of all applied PendingRefunds)
Pending refunds awaiting settlement. Once a refund transitions from PENDING to APPLIED, it moves out of this list and into the corresponding *AmountRefundModifier property
object
Unique identifier linking this pending refund to the parent booking’s refund record
Refund amount to be deducted from the beneficiary’s sourceAmount when applied
Refund amount to be deducted from the beneficiary’s displayAmount when applied
Refund amount to be deducted from the beneficiary’s internalAmount when applied
Net amount owed in source currency (sourceAmount - sourceAmountRefundModifier)
Net amount owed in display currency (displayAmount - displayAmountRefundModifier)
Net amount owed in internal currency (internalAmount - internalAmountRefundModifier)
Flag indicating whether net amounts have been transferred (disbursed) from TripPay to the beneficiary
Additional key-value metadata for the beneficiary (e.g. bank details, supplier identifiers)
object
object
Final per-night rate in hotel currency (base + modifiers). Computed at instantiation.
object
Monetary amount value
ISO 4217 currency code
Final per-night rate in wink currency (base + modifiers). Computed at instantiation.
object
Monetary amount value
ISO 4217 currency code
Final per-night rate in user specified currency (base + modifiers). Computed at instantiation.
object
Monetary amount value
ISO 4217 currency code
A beneficiary is a registered account entitled to a portion of booking funds. Funds are allocated by type (SALE, COMMISSION, PLATFORM_FEE, etc.) and tracked across source, display, and internal (platform) currencies. Refund modifiers record adjustments from cancellations.
object
Unique identifier of the beneficiary’s account in the TripPay system
Display name of the beneficiary account (e.g. hotel, affiliate, or platform name)
Contact email address for the beneficiary account
Profile or dashboard URL for the beneficiary account
Category of the beneficiary: SALE (property), COMMISSION (affiliate), PLATFORM_FEE (Wink), TRIP_PAY (platform internal), or agency fees
Charge rule: either a fixed percentage of the total stay or the remainder after other beneficiaries are deducted
object
PERCENTAGE: apply the percent field to the total booking price. REMAINDER: this beneficiary receives whatever is left after other beneficiaries are satisfied (typically used for the hotel).
The percentage value (0.0–1.0) to apply to the total booking amount when type=PERCENTAGE. For example, 0.050 = 5% of the booking price. Ignored when type=REMAINDER.
ISO 4217 currency code for the originating source (supplier’s local currency, e.g. hotel in Thailand uses THB)
ISO 4217 currency code for display to the user (e.g. booking shown in USD)
ISO 4217 currency code for internal platform ledger (always USD)
Gross amount owed to this beneficiary in source currency (before refunds)
Gross amount owed to this beneficiary in display currency (before refunds)
Gross amount owed to this beneficiary in internal currency (before refunds)
Cumulative refund reduction applied to sourceAmount (sum of all applied PendingRefunds)
Cumulative refund reduction applied to displayAmount (sum of all applied PendingRefunds)
Cumulative refund reduction applied to internalAmount (sum of all applied PendingRefunds)
Pending refunds awaiting settlement. Once a refund transitions from PENDING to APPLIED, it moves out of this list and into the corresponding *AmountRefundModifier property
object
Unique identifier linking this pending refund to the parent booking’s refund record
Refund amount to be deducted from the beneficiary’s sourceAmount when applied
Refund amount to be deducted from the beneficiary’s displayAmount when applied
Refund amount to be deducted from the beneficiary’s internalAmount when applied
Net amount owed in source currency (sourceAmount - sourceAmountRefundModifier)
Net amount owed in display currency (displayAmount - displayAmountRefundModifier)
Net amount owed in internal currency (internalAmount - internalAmountRefundModifier)
Flag indicating whether net amounts have been transferred (disbursed) from TripPay to the beneficiary
Additional key-value metadata for the beneficiary (e.g. bank details, supplier identifiers)
object
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
User-defined currency final price.
object
Monetary amount value
ISO 4217 currency code
Source currency final price.
object
Monetary amount value
ISO 4217 currency code
Internal currency final price.
object
Monetary amount value
ISO 4217 currency code
object
Lightweight representation of an exchange rate quote between a source and target currency pair
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Lightweight representation of an exchange rate quote between a source and target currency pair
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
A beneficiary is a registered account entitled to a portion of booking funds. Funds are allocated by type (SALE, COMMISSION, PLATFORM_FEE, etc.) and tracked across source, display, and internal (platform) currencies. Refund modifiers record adjustments from cancellations.
object
Unique identifier of the beneficiary’s account in the TripPay system
Display name of the beneficiary account (e.g. hotel, affiliate, or platform name)
Contact email address for the beneficiary account
Profile or dashboard URL for the beneficiary account
Category of the beneficiary: SALE (property), COMMISSION (affiliate), PLATFORM_FEE (Wink), TRIP_PAY (platform internal), or agency fees
Charge rule: either a fixed percentage of the total stay or the remainder after other beneficiaries are deducted
object
PERCENTAGE: apply the percent field to the total booking price. REMAINDER: this beneficiary receives whatever is left after other beneficiaries are satisfied (typically used for the hotel).
The percentage value (0.0–1.0) to apply to the total booking amount when type=PERCENTAGE. For example, 0.050 = 5% of the booking price. Ignored when type=REMAINDER.
ISO 4217 currency code for the originating source (supplier’s local currency, e.g. hotel in Thailand uses THB)
ISO 4217 currency code for display to the user (e.g. booking shown in USD)
ISO 4217 currency code for internal platform ledger (always USD)
Gross amount owed to this beneficiary in source currency (before refunds)
Gross amount owed to this beneficiary in display currency (before refunds)
Gross amount owed to this beneficiary in internal currency (before refunds)
Cumulative refund reduction applied to sourceAmount (sum of all applied PendingRefunds)
Cumulative refund reduction applied to displayAmount (sum of all applied PendingRefunds)
Cumulative refund reduction applied to internalAmount (sum of all applied PendingRefunds)
Pending refunds awaiting settlement. Once a refund transitions from PENDING to APPLIED, it moves out of this list and into the corresponding *AmountRefundModifier property
object
Unique identifier linking this pending refund to the parent booking’s refund record
Refund amount to be deducted from the beneficiary’s sourceAmount when applied
Refund amount to be deducted from the beneficiary’s displayAmount when applied
Refund amount to be deducted from the beneficiary’s internalAmount when applied
Net amount owed in source currency (sourceAmount - sourceAmountRefundModifier)
Net amount owed in display currency (displayAmount - displayAmountRefundModifier)
Net amount owed in internal currency (internalAmount - internalAmountRefundModifier)
Flag indicating whether net amounts have been transferred (disbursed) from TripPay to the beneficiary
Additional key-value metadata for the beneficiary (e.g. bank details, supplier identifiers)
object
object
A beneficiary is a registered account entitled to a portion of booking funds. Funds are allocated by type (SALE, COMMISSION, PLATFORM_FEE, etc.) and tracked across source, display, and internal (platform) currencies. Refund modifiers record adjustments from cancellations.
object
Unique identifier of the beneficiary’s account in the TripPay system
Display name of the beneficiary account (e.g. hotel, affiliate, or platform name)
Contact email address for the beneficiary account
Profile or dashboard URL for the beneficiary account
Category of the beneficiary: SALE (property), COMMISSION (affiliate), PLATFORM_FEE (Wink), TRIP_PAY (platform internal), or agency fees
Charge rule: either a fixed percentage of the total stay or the remainder after other beneficiaries are deducted
object
PERCENTAGE: apply the percent field to the total booking price. REMAINDER: this beneficiary receives whatever is left after other beneficiaries are satisfied (typically used for the hotel).
The percentage value (0.0–1.0) to apply to the total booking amount when type=PERCENTAGE. For example, 0.050 = 5% of the booking price. Ignored when type=REMAINDER.
ISO 4217 currency code for the originating source (supplier’s local currency, e.g. hotel in Thailand uses THB)
ISO 4217 currency code for display to the user (e.g. booking shown in USD)
ISO 4217 currency code for internal platform ledger (always USD)
Gross amount owed to this beneficiary in source currency (before refunds)
Gross amount owed to this beneficiary in display currency (before refunds)
Gross amount owed to this beneficiary in internal currency (before refunds)
Cumulative refund reduction applied to sourceAmount (sum of all applied PendingRefunds)
Cumulative refund reduction applied to displayAmount (sum of all applied PendingRefunds)
Cumulative refund reduction applied to internalAmount (sum of all applied PendingRefunds)
Pending refunds awaiting settlement. Once a refund transitions from PENDING to APPLIED, it moves out of this list and into the corresponding *AmountRefundModifier property
object
Unique identifier linking this pending refund to the parent booking’s refund record
Refund amount to be deducted from the beneficiary’s sourceAmount when applied
Refund amount to be deducted from the beneficiary’s displayAmount when applied
Refund amount to be deducted from the beneficiary’s internalAmount when applied
Net amount owed in source currency (sourceAmount - sourceAmountRefundModifier)
Net amount owed in display currency (displayAmount - displayAmountRefundModifier)
Net amount owed in internal currency (internalAmount - internalAmountRefundModifier)
Flag indicating whether net amounts have been transferred (disbursed) from TripPay to the beneficiary
Additional key-value metadata for the beneficiary (e.g. bank details, supplier identifiers)
object
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
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
Localized descriptions of this fee in multiple languages. At least one entry in English is required.
Simplified localized description containing text content and its language code.
object
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
The fixed fee amount in the property’s local currency.
object
Monetary amount value
ISO 4217 currency code
How this fee is charged: per day, per stay, per person per day, or per person per stay.
The localized unit price of the extra charge
object
Hotel to user currency exchange rate.
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Hotel to wink currency exchange rate.
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
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
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
The localized price of the extra charge
object
Hotel to user currency exchange rate.
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Hotel to wink currency exchange rate.
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
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
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
The selected room configuration that created this record
object
Number of adult guests in this room type
Child guests in this room, with age groups
Child guest with age and quantity in a room configuration
object
Count of children of this age group in the room
Age of each child in this group (years)
Number of identical rooms with this configuration
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.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
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.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
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.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
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
Monetary amount value
ISO 4217 currency code
If you are selling this blocking at a discount, indicate the discounted selling price. Leave empty if there is no discount.
object
Monetary amount value
ISO 4217 currency code
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.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
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 rate plan identifier restricting this add-on to guests on a specific rate plan.
Localized transactional blocking
object
Unique transactional identifier
Internal name of transactional blocking.
Localized descriptions describing inventory.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
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
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Hotel to wink currency exchange rate.
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
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
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
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.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
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.
Simplified localized description containing text content and its language code.
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.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
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
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Hotel to wink currency exchange rate.
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
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
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
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.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
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.
Simplified localized description containing text content and its language code.
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.
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
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.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
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
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Hotel to wink currency exchange rate.
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
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
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
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.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
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.
Simplified localized description containing text content and its language code.
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
Monetary amount value
ISO 4217 currency code
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
Monetary amount value
ISO 4217 currency code
Perks that accompany the master rate
object
Unique enum-like string identifier for this perk (e.g., PERK_GUARANTEED_UPGRADE). Enables backwards compatibility by persisting the identifier rather than relying on ordinal position.
Whether this perk is guaranteed to be provided or available on a best-effort basis. Guaranteed perks take priority in allocation.
Platform tier/value assigned to this perk (0=standard, higher=premium). Used for internal prioritization and matching with rate tiers.
Localized descriptions of this perk in multiple languages. Each element provides a name, description, and language code (e.g., ‘en’, ‘fr’, ‘de’).
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
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.
Display order when showing this perk in a list (ascending sort). Lower numbers appear first; 999 is reserved for disabled/unlisted perks.
Calculated price
object
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Base total in hotel’s currency.
object
Monetary amount value
ISO 4217 currency code
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
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
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Hotel to wink currency exchange rate.
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Localized text of the discount
Simplified localized description containing text content and its language code.
object
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
Promotional codes
object
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Simplified localized description containing text content and its language code.
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.
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
This 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
Monetary amount value
ISO 4217 currency code
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
Monetary amount value
ISO 4217 currency code
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
Monetary amount value
ISO 4217 currency code
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
Lightweight representation of an exchange rate quote between a source and target currency pair
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Lightweight representation of an exchange rate quote between a source and target currency pair
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
object
Lightweight representation of an exchange rate quote between a source and target currency pair
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Lightweight representation of an exchange rate quote between a source and target currency pair
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
A beneficiary is a registered account entitled to a portion of booking funds. Funds are allocated by type (SALE, COMMISSION, PLATFORM_FEE, etc.) and tracked across source, display, and internal (platform) currencies. Refund modifiers record adjustments from cancellations.
object
Unique identifier of the beneficiary’s account in the TripPay system
Display name of the beneficiary account (e.g. hotel, affiliate, or platform name)
Contact email address for the beneficiary account
Profile or dashboard URL for the beneficiary account
Category of the beneficiary: SALE (property), COMMISSION (affiliate), PLATFORM_FEE (Wink), TRIP_PAY (platform internal), or agency fees
Charge rule: either a fixed percentage of the total stay or the remainder after other beneficiaries are deducted
object
PERCENTAGE: apply the percent field to the total booking price. REMAINDER: this beneficiary receives whatever is left after other beneficiaries are satisfied (typically used for the hotel).
The percentage value (0.0–1.0) to apply to the total booking amount when type=PERCENTAGE. For example, 0.050 = 5% of the booking price. Ignored when type=REMAINDER.
ISO 4217 currency code for the originating source (supplier’s local currency, e.g. hotel in Thailand uses THB)
ISO 4217 currency code for display to the user (e.g. booking shown in USD)
ISO 4217 currency code for internal platform ledger (always USD)
Gross amount owed to this beneficiary in source currency (before refunds)
Gross amount owed to this beneficiary in display currency (before refunds)
Gross amount owed to this beneficiary in internal currency (before refunds)
Cumulative refund reduction applied to sourceAmount (sum of all applied PendingRefunds)
Cumulative refund reduction applied to displayAmount (sum of all applied PendingRefunds)
Cumulative refund reduction applied to internalAmount (sum of all applied PendingRefunds)
Pending refunds awaiting settlement. Once a refund transitions from PENDING to APPLIED, it moves out of this list and into the corresponding *AmountRefundModifier property
object
Unique identifier linking this pending refund to the parent booking’s refund record
Refund amount to be deducted from the beneficiary’s sourceAmount when applied
Refund amount to be deducted from the beneficiary’s displayAmount when applied
Refund amount to be deducted from the beneficiary’s internalAmount when applied
Net amount owed in source currency (sourceAmount - sourceAmountRefundModifier)
Net amount owed in display currency (displayAmount - displayAmountRefundModifier)
Net amount owed in internal currency (internalAmount - internalAmountRefundModifier)
Flag indicating whether net amounts have been transferred (disbursed) from TripPay to the beneficiary
Additional key-value metadata for the beneficiary (e.g. bank details, supplier identifiers)
object
object
Final per-night rate in hotel currency (base + modifiers). Computed at instantiation.
object
Monetary amount value
ISO 4217 currency code
Final per-night rate in wink currency (base + modifiers). Computed at instantiation.
object
Monetary amount value
ISO 4217 currency code
Final per-night rate in user specified currency (base + modifiers). Computed at instantiation.
object
Monetary amount value
ISO 4217 currency code
A beneficiary is a registered account entitled to a portion of booking funds. Funds are allocated by type (SALE, COMMISSION, PLATFORM_FEE, etc.) and tracked across source, display, and internal (platform) currencies. Refund modifiers record adjustments from cancellations.
object
Unique identifier of the beneficiary’s account in the TripPay system
Display name of the beneficiary account (e.g. hotel, affiliate, or platform name)
Contact email address for the beneficiary account
Profile or dashboard URL for the beneficiary account
Category of the beneficiary: SALE (property), COMMISSION (affiliate), PLATFORM_FEE (Wink), TRIP_PAY (platform internal), or agency fees
Charge rule: either a fixed percentage of the total stay or the remainder after other beneficiaries are deducted
object
PERCENTAGE: apply the percent field to the total booking price. REMAINDER: this beneficiary receives whatever is left after other beneficiaries are satisfied (typically used for the hotel).
The percentage value (0.0–1.0) to apply to the total booking amount when type=PERCENTAGE. For example, 0.050 = 5% of the booking price. Ignored when type=REMAINDER.
ISO 4217 currency code for the originating source (supplier’s local currency, e.g. hotel in Thailand uses THB)
ISO 4217 currency code for display to the user (e.g. booking shown in USD)
ISO 4217 currency code for internal platform ledger (always USD)
Gross amount owed to this beneficiary in source currency (before refunds)
Gross amount owed to this beneficiary in display currency (before refunds)
Gross amount owed to this beneficiary in internal currency (before refunds)
Cumulative refund reduction applied to sourceAmount (sum of all applied PendingRefunds)
Cumulative refund reduction applied to displayAmount (sum of all applied PendingRefunds)
Cumulative refund reduction applied to internalAmount (sum of all applied PendingRefunds)
Pending refunds awaiting settlement. Once a refund transitions from PENDING to APPLIED, it moves out of this list and into the corresponding *AmountRefundModifier property
object
Unique identifier linking this pending refund to the parent booking’s refund record
Refund amount to be deducted from the beneficiary’s sourceAmount when applied
Refund amount to be deducted from the beneficiary’s displayAmount when applied
Refund amount to be deducted from the beneficiary’s internalAmount when applied
Net amount owed in source currency (sourceAmount - sourceAmountRefundModifier)
Net amount owed in display currency (displayAmount - displayAmountRefundModifier)
Net amount owed in internal currency (internalAmount - internalAmountRefundModifier)
Flag indicating whether net amounts have been transferred (disbursed) from TripPay to the beneficiary
Additional key-value metadata for the beneficiary (e.g. bank details, supplier identifiers)
object
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
User-defined currency final price.
object
Monetary amount value
ISO 4217 currency code
Source currency final price.
object
Monetary amount value
ISO 4217 currency code
Internal currency final price.
object
Monetary amount value
ISO 4217 currency code
object
Lightweight representation of an exchange rate quote between a source and target currency pair
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Lightweight representation of an exchange rate quote between a source and target currency pair
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
A beneficiary is a registered account entitled to a portion of booking funds. Funds are allocated by type (SALE, COMMISSION, PLATFORM_FEE, etc.) and tracked across source, display, and internal (platform) currencies. Refund modifiers record adjustments from cancellations.
object
Unique identifier of the beneficiary’s account in the TripPay system
Display name of the beneficiary account (e.g. hotel, affiliate, or platform name)
Contact email address for the beneficiary account
Profile or dashboard URL for the beneficiary account
Category of the beneficiary: SALE (property), COMMISSION (affiliate), PLATFORM_FEE (Wink), TRIP_PAY (platform internal), or agency fees
Charge rule: either a fixed percentage of the total stay or the remainder after other beneficiaries are deducted
object
PERCENTAGE: apply the percent field to the total booking price. REMAINDER: this beneficiary receives whatever is left after other beneficiaries are satisfied (typically used for the hotel).
The percentage value (0.0–1.0) to apply to the total booking amount when type=PERCENTAGE. For example, 0.050 = 5% of the booking price. Ignored when type=REMAINDER.
ISO 4217 currency code for the originating source (supplier’s local currency, e.g. hotel in Thailand uses THB)
ISO 4217 currency code for display to the user (e.g. booking shown in USD)
ISO 4217 currency code for internal platform ledger (always USD)
Gross amount owed to this beneficiary in source currency (before refunds)
Gross amount owed to this beneficiary in display currency (before refunds)
Gross amount owed to this beneficiary in internal currency (before refunds)
Cumulative refund reduction applied to sourceAmount (sum of all applied PendingRefunds)
Cumulative refund reduction applied to displayAmount (sum of all applied PendingRefunds)
Cumulative refund reduction applied to internalAmount (sum of all applied PendingRefunds)
Pending refunds awaiting settlement. Once a refund transitions from PENDING to APPLIED, it moves out of this list and into the corresponding *AmountRefundModifier property
object
Unique identifier linking this pending refund to the parent booking’s refund record
Refund amount to be deducted from the beneficiary’s sourceAmount when applied
Refund amount to be deducted from the beneficiary’s displayAmount when applied
Refund amount to be deducted from the beneficiary’s internalAmount when applied
Net amount owed in source currency (sourceAmount - sourceAmountRefundModifier)
Net amount owed in display currency (displayAmount - displayAmountRefundModifier)
Net amount owed in internal currency (internalAmount - internalAmountRefundModifier)
Flag indicating whether net amounts have been transferred (disbursed) from TripPay to the beneficiary
Additional key-value metadata for the beneficiary (e.g. bank details, supplier identifiers)
object
object
A beneficiary is a registered account entitled to a portion of booking funds. Funds are allocated by type (SALE, COMMISSION, PLATFORM_FEE, etc.) and tracked across source, display, and internal (platform) currencies. Refund modifiers record adjustments from cancellations.
object
Unique identifier of the beneficiary’s account in the TripPay system
Display name of the beneficiary account (e.g. hotel, affiliate, or platform name)
Contact email address for the beneficiary account
Profile or dashboard URL for the beneficiary account
Category of the beneficiary: SALE (property), COMMISSION (affiliate), PLATFORM_FEE (Wink), TRIP_PAY (platform internal), or agency fees
Charge rule: either a fixed percentage of the total stay or the remainder after other beneficiaries are deducted
object
PERCENTAGE: apply the percent field to the total booking price. REMAINDER: this beneficiary receives whatever is left after other beneficiaries are satisfied (typically used for the hotel).
The percentage value (0.0–1.0) to apply to the total booking amount when type=PERCENTAGE. For example, 0.050 = 5% of the booking price. Ignored when type=REMAINDER.
ISO 4217 currency code for the originating source (supplier’s local currency, e.g. hotel in Thailand uses THB)
ISO 4217 currency code for display to the user (e.g. booking shown in USD)
ISO 4217 currency code for internal platform ledger (always USD)
Gross amount owed to this beneficiary in source currency (before refunds)
Gross amount owed to this beneficiary in display currency (before refunds)
Gross amount owed to this beneficiary in internal currency (before refunds)
Cumulative refund reduction applied to sourceAmount (sum of all applied PendingRefunds)
Cumulative refund reduction applied to displayAmount (sum of all applied PendingRefunds)
Cumulative refund reduction applied to internalAmount (sum of all applied PendingRefunds)
Pending refunds awaiting settlement. Once a refund transitions from PENDING to APPLIED, it moves out of this list and into the corresponding *AmountRefundModifier property
object
Unique identifier linking this pending refund to the parent booking’s refund record
Refund amount to be deducted from the beneficiary’s sourceAmount when applied
Refund amount to be deducted from the beneficiary’s displayAmount when applied
Refund amount to be deducted from the beneficiary’s internalAmount when applied
Net amount owed in source currency (sourceAmount - sourceAmountRefundModifier)
Net amount owed in display currency (displayAmount - displayAmountRefundModifier)
Net amount owed in internal currency (internalAmount - internalAmountRefundModifier)
Flag indicating whether net amounts have been transferred (disbursed) from TripPay to the beneficiary
Additional key-value metadata for the beneficiary (e.g. bank details, supplier identifiers)
object
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
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
Localized descriptions of this fee in multiple languages. At least one entry in English is required.
Simplified localized description containing text content and its language code.
object
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
The fixed fee amount in the property’s local currency.
object
Monetary amount value
ISO 4217 currency code
How this fee is charged: per day, per stay, per person per day, or per person per stay.
The localized unit price of the extra charge
object
Hotel to user currency exchange rate.
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Hotel to wink currency exchange rate.
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
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
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
The localized price of the extra charge
object
Hotel to user currency exchange rate.
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Hotel to wink currency exchange rate.
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
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
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
The selected room configuration that created this record
object
Number of adult guests in this room type
Child guests in this room, with age groups
Child guest with age and quantity in a room configuration
object
Count of children of this age group in the room
Age of each child in this group (years)
Number of identical rooms with this configuration
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.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
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.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
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.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
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
Monetary amount value
ISO 4217 currency code
If you are selling this blocking at a discount, indicate the discounted selling price. Leave empty if there is no discount.
object
Monetary amount value
ISO 4217 currency code
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.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
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 rate plan identifier restricting this add-on to guests on a specific rate plan.
Localized transactional blocking
object
Unique transactional identifier
Internal name of transactional blocking.
Localized descriptions describing inventory.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
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
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Hotel to wink currency exchange rate.
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
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
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
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.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
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.
Simplified localized description containing text content and its language code.
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.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
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
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Hotel to wink currency exchange rate.
object
ISO 4217 source currency code
ISO 4217 target currency code
Exchange rate from source to target currency
Unix epoch milliseconds when the quote was recorded
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
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
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
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.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
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.
Simplified localized description containing text content and its language code.
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.
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Descriptive reason container carrying an identifier, a name, an optional attribute map, and a list of human-readable reason strings used for verification or validation feedback
object
Unique identifier of the entity or rule this reason is associated with
Human-readable name of the entity or rule associated with this reason
Optional key-value attribute map providing additional context for the reason
object
List of human-readable reason strings explaining why verification failed or an action is required
Descriptive reason container carrying an identifier, a name, an optional attribute map, and a list of human-readable reason strings used for verification or validation feedback
object
Unique identifier of the entity or rule this reason is associated with
Human-readable name of the entity or rule associated with this reason
Optional key-value attribute map providing additional context for the reason
object
List of human-readable reason strings explaining why verification failed or an action is required
Example
[ { "identifier": "the-siam-residences/deluxe-suite", "roomName": "Deluxe Suite", "accessibleMasterRates": [ { "identifier": "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "name": "Flexible Rate" } ], "inaccessibleMasterRates": [ { "identifier": "4d7c2b6e-9f3a-5b1c-0d8e-7f5a1b9c3d62", "name": "Non-refundable Rate", "reasons": [ "Rate not available for selected dates" ] } ], "accessibleInventory": [ { "identifier": "5e8d3c7f-0a4b-6c2d-1e9f-8a6b2c0d4e73" } ], "accessibleRatePlans": [ { "identifier": "6f9e4d8a-1b5c-7d3e-2f0a-9b7c3d1e5f84", "name": "Standard Plan", "reasons": [ "Rate plan matches itinerary" ] } ], "inaccessibleRatePlans": [ { "identifier": "7a0f5e9b-2c6d-8e4f-3a1b-0c8d4e2f6a95", "name": "Corporate Plan", "reasons": [ "Corporate code required" ] } ], "accessibleAvailability": [ { "available": true, "room": { "identifier": "8b1a6f0c-3d7e-9f5a-4b2c-1d9e5f3a7b06" } } ], "inaccessibleAvailability": [ { "identifier": "9c2b7a1d-4e8f-0a6b-5c3d-2e0f6a4b8c17", "name": "Presidential Suite", "reasons": [ "No availability for selected dates" ] } ] }]Bad Request — missing or invalid request parameter or body
object
object
Example
Unauthorized — authentication is required or the session has expired
object
object
Example
Forbidden — authenticated but lacking the required permission or scope
object
object
Example
Not Found — the requested resource does not exist
object
object
Example
Method Not Allowed — the HTTP verb is not supported on this endpoint
object
object
Example
Unsupported Media Type — use application/json
object
object
Example
Internal Server Error — an unexpected failure occurred on the server
object
object
Example
Service Unavailable — a downstream dependency is unreachable