Latest
const url = 'https://api.wink.travel/api/managing-entity/d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69/studio/search/latest';const options = { method: 'POST', headers: { 'Wink-Version': '2.0', Authorization: 'Bearer <token>', 'Content-Type': 'application/json' }, body: '{"page":0,"size":24,"userSession":{"currency":"USD","itinerary":{"children":4,"endDate":"2026-07-18","guests":4,"hours":72,"items":[{"adults":2,"children":[{"age":7,"quantity":2}],"quantity":2}],"nights":3,"room":{"adults":2,"children":[{"age":7,"quantity":2}],"quantity":2},"rooms":2,"startDate":"2026-07-15"},"language":"en","lifestyle":"LIFESTYLE_RELAX","promotionalCodes":["SUMMER2026"],"selectedRoomConfigurationIndex":0}}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.wink.travel/api/managing-entity/d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69/studio/search/latest \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --header 'Wink-Version: 2.0' \ --data '{ "page": 0, "size": 24, "userSession": { "currency": "USD", "itinerary": { "children": 4, "endDate": "2026-07-18", "guests": 4, "hours": 72, "items": [ { "adults": 2, "children": [ { "age": 7, "quantity": 2 } ], "quantity": 2 } ], "nights": 3, "room": { "adults": 2, "children": [ { "age": 7, "quantity": 2 } ], "quantity": 2 }, "rooms": 2, "startDate": "2026-07-15" }, "language": "en", "lifestyle": "LIFESTYLE_RELAX", "promotionalCodes": [ "SUMMER2026" ], "selectedRoomConfigurationIndex": 0 } }'Returns the most recently added properties you can sell, newest first, each priced for the itinerary in the user session.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Search on behalf of this managing entity.
Example
d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69Header Parameters
Section titled “Header Parameters”Request Bodyrequired
Section titled “Request Bodyrequired”The user session and the page to return
Studio paged search request carrying the user session
object
The page to paginate to. Note: Page uses a 0-based index, at most 1000.
Example
0The result size to return.
Example
24User session is the current search state. The itinerary the prices are computed for is in here.
object
User’s currency preference (ISO 4217 code)
Example
USDDates and travel info.
object
Total number of children across all rooms
Example
4Check-out date (alternative to nights; nights takes precedence if both provided)
Example
2026-07-18Total number of adult guests across all rooms
Example
4Duration in hours (rounded up) between check-in and check-out. Used for hourly bookings; e.g., meeting rooms or day-use venues.
Example
72DEPRECATED pre-collapse room list, accepted for backwards compatibility and never returned. Send room instead. Only the first entry is used and any others are ignored: this API searches one room configuration per request. Use room.quantity to book several identical rooms.
Room occupancy and guest composition for a single or multiple identical rooms
object
Number of adult guests in this room type
Example
2Child guests in this room, with age groups
Child guest with age and quantity in a room configuration
object
Age of each child in this group (years)
Example
7Count of children of this age group in the room
Example
2Example
{ "age": 7, "quantity": 2}Number of identical rooms with this configuration
Example
2Example
{ "adults": 2, "children": [ { "age": 7, "quantity": 2 } ], "quantity": 2}Number of nights for the stay (alternative to endDate; takes precedence if both provided)
Example
3The room configuration being booked, and how many identical rooms of it
object
Number of adult guests in this room type
Example
2Child guests in this room, with age groups
Child guest with age and quantity in a room configuration
object
Age of each child in this group (years)
Example
7Count of children of this age group in the room
Example
2Example
{ "age": 7, "quantity": 2}Number of identical rooms with this configuration
Example
2Example
{ "adults": 2, "children": [ { "age": 7, "quantity": 2 } ], "quantity": 2}Total number of rooms in this itinerary
Example
2Check-in date (must be today or in the future)
Example
2026-07-15Example
{ "children": 4, "endDate": "2026-07-18", "guests": 4, "hours": 72, "items": [ { "adults": 2, "children": [ { "age": 7, "quantity": 2 } ], "quantity": 2 } ], "nights": 3, "room": { "adults": 2, "children": [ { "age": 7, "quantity": 2 } ], "quantity": 2 }, "rooms": 2, "startDate": "2026-07-15"}User’s language preference (ISO 639-1 code)
Example
enPreferred lifestyle category to filter accommodations
Example
LIFESTYLE_RELAXIndex of the currently selected room configuration for rate retrieval
Example
0Example
{ "currency": "USD", "itinerary": { "children": 4, "endDate": "2026-07-18", "guests": 4, "hours": 72, "items": [ { "adults": 2, "children": [ { "age": 7, "quantity": 2 } ], "quantity": 2 } ], "nights": 3, "room": { "adults": 2, "children": [ { "age": 7, "quantity": 2 } ], "quantity": 2 }, "rooms": 2, "startDate": "2026-07-15" }, "language": "en", "lifestyle": "LIFESTYLE_RELAX", "promotionalCodes": [ "SUMMER2026" ], "selectedRoomConfigurationIndex": 0}Example
{ "page": 0, "size": 24, "userSession": { "currency": "USD", "itinerary": { "children": 4, "endDate": "2026-07-18", "guests": 4, "hours": 72, "items": [ { "adults": 2, "children": [ { "age": 7, "quantity": 2 } ], "quantity": 2 } ], "nights": 3, "room": { "adults": 2, "children": [ { "age": 7, "quantity": 2 } ], "quantity": 2 }, "rooms": 2, "startDate": "2026-07-15" }, "language": "en", "lifestyle": "LIFESTYLE_RELAX", "promotionalCodes": [ "SUMMER2026" ], "selectedRoomConfigurationIndex": 0 }}Responses
Section titled “Responses”OK
A property found by the studio search, with its best prices and the sales channel the best offer resolves through
object
The property with the best price of each of its room types. available is false, and lowestPrice null, when nothing can be priced for the itinerary.
object
Flag to indicate whether this inventory is available or not. This data point is identifier to the available flag on the price child data point.
Distance in metres from the searched point, when the query was a near-point search.
Property details
object
Number of activites property has listed on its profile.
Number of add-ons property has on its profile.
Property address.
object
Address line 1
Address line 2
City name
Country
Country
County
Address 1, Address 2, City, State, Postal / Zip code, Country
Postal / zip code
State
Aggregate Green Index score if the property has answered our questionnaire available in the Extranet.
Aggregate score based on all current user reviews.
Supported OTA specification ARC code. See OTA geoname data
Number of attractions property has listed on its profile.
Whether property is available
Number of bookings for this property on the wink.travel platform.
Name of hotel brand
Name of hotel chain if applicable.
City location
object
Ascii name of city
Country
object
Country capital
Continent code
Currency code
Currency name
Country GeoNames identifier
ISO code
Country name
ISO 3166-1 alpha-2 country code for the country this location belongs to
GeoNames specific feature code identifying the place type (e.g. PPL=populated place, PPLC=national capital, ISL=island)
GeoName identifier
Coordinate points of the city
object
Name of city
Country sub division
object
Sub-country ascii name
Sub-country GeoNames identifier
Sub-country name
Country sub sub division
object
ASCII-transliterated name of the county or district, safe for URLs and sorting
GeoNames.org unique identifier for this subdivision
Official name of the county or district in its local script
IANA timezone identifier for the location
GeoNameLightweight type
Url name
Currency code for property.
Short and long welcome text
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Use as title or short text description
General manager of the property.
object
Localized welcome message from GM.
Simplified localized description containing text content and its language code.
object
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Profile image of the general manager.
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Name of GM currently managing the property.
Supported OTA specification HAC code. See OTA geoname data
Supported OTA specification PCT code. See OTA geoname data
Unique hotel record identifier.
Property images.
Multimedia that contains less information than Multimedia object
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Timestamp of the last update to this property aggregate record.
Hotel local name if different from the trade name or if it is the local language.
Geo-location
object
Supported OTA specification LOC code. See OTA geoname data
Number of meeting rooms property has on its profile.
Hotel trade name
Number of rooms / keys for this property.
Number of places property has listed on its profile.
Basic property policy record.
object
When the guest can check in, hotel-local time as 24-hour HH:mm, 00:00 to 23:59.
When the guest has to check out, hotel-local time as 24-hour HH:mm, 00:00 to 23:59.
Indicates whether property allows children
When a property allows children, it can also indicate what the minimum age is for children to be allowed.
Indicates the availability of internet on the property.
Indicates where internet is available in and around the property.
Indicates how guests can access the Internet on the property.
Indicates what type of parking is available at the property.
Indicates whether parking is available at the property.
If pets are allowed, property can tell travelers if there is a charge applicable for the pet.
object
Monetary amount value
ISO 4217 currency code
If pets are allowed, property can further limit on weight.
Indicates whether pets are allowed on the property. Note: There are thousand different kinds of pets. Just because the property allows small dogs does not mean the guest can bring a python. Always best to check with property.
Supported OTA specification PHY code. See OTA geoname data
Supported OTA specification SEC code. See OTA geoname data
Contact details for reservations desk
object
Contact E-mail
Contact first name
First and last name
Contact last name
Contact phone number
Contact secondary Email
Summary
Number of restaurants property has on its profile.
Demand score (0-100) derived from booking volume and review rating. Recomputed monthly; used to rank properties in search results.
Supported OTA specification SEG code. See OTA geoname data
Property’s social network accounts
Social network
object
URL or social network identifier to social network profile
Type of social network.
Number of spas property has on its profile.
Official or self-designated property star rating. Note that in some regions there are 6-star hotels. They are the same as 5-star hotels everywhere else.
Array of awards and third party reviews given to property by certified / non-certified providers.
Recognition for the ancillary blocking.
object
Recognition category.
The date the award was received
Recognition identifier.
Use this to let hotels indicate what the total score for this award is.
When true, this indicates the property has received official permission from the award provider to use the rating in publications and marketing materials; when false this permission has not been granted.
The name of the entity that administers this recognition.
The actual award or rating received by the hotel facility.
Provides the symbol used in the rating. Used in conjunction with the Rating.
Type of rating system the recognition operated on. This allows us to display the score properly.
Count of total reviews left by users at this property.
Event shorter name
Unique URL-friendly name slug of hotel
Property videos.
Multimedia that contains less information than Multimedia object
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Year the property was constructed.
Best-priced room at property
object
Whether this room type is available with this configuration
The sum of all perks the master rate had made available.
Price details for this room type configuration.
object
The active / selected cancellation policy for this room configuration
object
When the cancellation policy is refundable, this flag can be set and indicates there is more rules involved than just a no-questions-asked refundable.
Datetime this record was first created
Property this cancellation is associated with
Unique identifier for this record.
Datetime this record was last updated
In case the ‘Refundable cancellation charge’ is set, a different no show charge can be applied.
If the guest does not honor the non-refundable deadline rule, this charge dictates what she owes after the deadline passes.
When the cancellation policy is non-refundable, this flag can be set and indicates there is more rules involved to calculate what the guest will owe in case of a cancellation.
The non-refundable charge might can have a deadline. If that deadline passes, the guest might be charged more.
Whether this cancellation policy is refundable or not
If advanceCancellationFreeOfCharge rules is not honored, this property explains what the guest will be charged.
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
Add-ons that are available with this room configuration
object
The original add-on record created by the property.
object
Modify add-on availability with this flag.
End month and day or date for which the add-on is available (seasonal availability).
Start month and day or date for which the add-on is available (seasonal availability).
Base price of booking this add-on.
object
Monetary amount value
ISO 4217 currency code
Level 1 taxonomy: property-level (ADD_ON) or a specific venue type. Null is treated as ADD_ON.
Level 2 taxonomy: the ids of the specific venues of the category this add-on belongs to. EMPTY MEANS ALL items of the category. Only meaningful when category is venue-scoped.
Closing time of the add-on (if applicable). Leave empty if always available.
Indicate whether sales channels receive commission for selling this add-on.
Datetime this record was first created
Optional list of date ranges restricting add-on availability to specific periods. Empty means available on every date.
object
Retrieve data range ending with and including this end date
Retrieve data range starting with and including this start date
Indicates which days this add-on is open.
object
Convenience property to quickly determine if this existing object has any active days enabled.
Set to true to enable Friday.
Set to true to enable Monday.
Set to true to enable Saturday.
Set to true to enable Sunday.
Set to true to enable Thursday.
Set to true to enable Tuesday.
Set to true to enable Wednesday.
Localized descriptions describing this add-on.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Use as title or short text description
If this add-on is sold at a discount, the discounted selling price.
object
Monetary amount value
ISO 4217 currency code
Indicates whether this add-on is featured.
Hotel identifier.
Unique identifier for this record.
Datetime this record was last updated
Make this add-on mandatory for all guests by enabling this flag.
Maximum group size this add-on can be booked for.
Minimum group size this add-on can be booked for.
List of images / videos of this add-on.
Multimedia that contains less information than Multimedia object
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Internal name of the add-on.
Opening time of the add-on (if applicable). Leave empty if always available.
How this add-on should be priced.
Publish lifecycle state: DRAFT (incomplete, not announced) or PUBLISHED (complete/live).
Rate plan identifiers this add-on is restricted to. EMPTY MEANS AVAILABLE TO ALL rate plans.
Whether this add-on is an appointment that must be booked into a specific time slot. Independent of pricingType.
Room type identifiers this add-on is restricted to. EMPTY MEANS AVAILABLE TO ALL room types.
Use this property to sort an add-on in a list of add-ons.
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
The commission percentage.
Whether this package is commissionable based on the incoming sales channel.
Indicates whether the blocking from sales channel is direct or not. If you are a travel agent doing your own acquiring, this flag has to be true to make a booking.
Localized transactional blocking
object
Localized descriptions describing inventory.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Use as title or short text description
Unique transactional identifier
Whether this item is added to every room booked automatically, at a quantity set by its pricing type. The guest cannot change or remove it.
Whether there is a limit to maximum group size.
Whether there is a limit to minimum group size.
List of images / videos of item.
Multimedia that contains less information than Multimedia object
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Internal name of transactional blocking.
Localized offer details if rate plan discount applies.
Simplified localized description containing text content and its language code.
object
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Localized price
object
Channel discount percent
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in wink currency
Premium modifiers in wink currency
Promotional modifiers in wink currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Premium percent
Promotional discount percent
How many of this item is included in this price
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in hotel currency
Premium modifiers in hotel currency
Promotional modifiers in hotel currency
Hotel to wink currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Hotel to user currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in user specified currency
Premium modifiers in user specified currency
Promotional modifiers in user specified currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
How this inventory item should be priced.
If a package is linked to a rate plan the user could be entitled to a promotional discount if she enters a code. When this field is populated, it means the discount was applied to the package.
Rate plan identifiers this item may be sold with. Empty means every rate plan. A venue price list is property-wide, so the client filters it per room.
Room type identifiers this item may be sold with. Empty means every room type. A venue price list is property-wide, so the client filters it per room.
The actual amount of adults as determined by the hotel’s policy
The actual amount of children as determined by the hotel’s policy
The commission percentage.
Whether this package is commissionable based on the incoming sales channel.
The selected room configuration that created this record
object
Number of adult guests in this room type
Child guests in this room, with age groups
Child guest with age and quantity in a room configuration
object
Age of each child in this group (years)
Count of children of this age group in the room
Number of identical rooms with this configuration
Indicates whether the blocking from sales channel is direct or not. If you are a travel agent doing your own acquiring, this flag has to be true to make a booking.
SimpleDateTimeItinerary endDate
Per rate plan level extra charges with localized prices
object
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
List of extra charges that applies to the rate plan.
object
The localized price of the extra charge
object
Channel discount percent
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in wink currency
Premium modifiers in wink currency
Promotional modifiers in wink currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Premium percent
Promotional discount percent
How many of this item is included in this price
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in hotel currency
Premium modifiers in hotel currency
Promotional modifiers in hotel currency
Hotel to wink currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Hotel to user currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in user specified currency
Premium modifiers in user specified currency
Promotional modifiers in user specified currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
What the guest is paying extra for
object
Localized descriptions of this fee in multiple languages. At least one entry in English is required.
Simplified localized description containing text content and its language code.
object
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
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
Channel discount percent
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in wink currency
Premium modifiers in wink currency
Promotional modifiers in wink currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Premium percent
Promotional discount percent
How many of this item is included in this price
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in hotel currency
Premium modifiers in hotel currency
Promotional modifiers in hotel currency
Hotel to wink currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Hotel to user currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in user specified currency
Premium modifiers in user specified currency
Promotional modifiers in user specified currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
This is one localized bookable item that can stand alongside a restaurant / meeting room etc.
object
Localized descriptions describing inventory.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Use as title or short text description
Unique transactional identifier
Whether this item is added to every room booked automatically, at a quantity set by its pricing type. The guest cannot change or remove it.
Whether there is a limit to maximum group size.
Whether there is a limit to minimum group size.
List of images / videos of item.
Multimedia that contains less information than Multimedia object
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Internal name of transactional blocking.
Localized offer details if rate plan discount applies.
Simplified localized description containing text content and its language code.
object
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Localized price
object
Channel discount percent
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in wink currency
Premium modifiers in wink currency
Promotional modifiers in wink currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Premium percent
Promotional discount percent
How many of this item is included in this price
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in hotel currency
Premium modifiers in hotel currency
Promotional modifiers in hotel currency
Hotel to wink currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Hotel to user currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in user specified currency
Premium modifiers in user specified currency
Promotional modifiers in user specified currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
How this inventory item should be priced.
If a package is linked to a rate plan the user could be entitled to a promotional discount if she enters a code. When this field is populated, it means the discount was applied to the package.
Rate plan identifiers this item may be sold with. Empty means every rate plan. A venue price list is property-wide, so the client filters it per room.
Room type identifiers this item may be sold with. Empty means every room type. A venue price list is property-wide, so the client filters it per room.
Perks that accompany the master rate
object
Datetime this record was first created
Localized descriptions of this perk in multiple languages. Each element provides a name, description, and language code (e.g., ‘en’, ‘fr’, ‘de’).
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Use as title or short text description
Whether this perk is guaranteed to be provided or available on a best-effort basis. Guaranteed perks take priority in allocation.
Unique identifier for this record.
Datetime this record was last updated
Platform tier/value assigned to this perk (0=standard, higher=premium). Used for internal prioritization and matching with rate tiers.
Display order when showing this perk in a list (ascending sort). Lower numbers appear first; 999 is reserved for disabled/unlisted perks.
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
The combined value of these perkTypes
Calculated price
object
Available
Chanel discount percent
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
Contact email address for the beneficiary account
Unique identifier of the beneficiary’s account in the TripPay system
Display name of the beneficiary account (e.g. hotel, affiliate, or platform name)
Profile or dashboard URL for the beneficiary account
Charge rule: either a fixed percentage of the total stay or the remainder after other beneficiaries are deducted
object
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.
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).
Gross amount owed to this beneficiary in display currency (before refunds)
Cumulative refund reduction applied to displayAmount (sum of all applied PendingRefunds)
ISO 4217 currency code for display to the user (e.g. booking shown in USD)
Gross amount owed to this beneficiary in internal currency (before refunds)
Cumulative refund reduction applied to internalAmount (sum of all applied PendingRefunds)
ISO 4217 currency code for internal platform ledger (always USD)
Additional key-value metadata for the beneficiary (e.g. bank details, supplier identifiers)
object
Net amount owed in display currency: displayAmount - displayAmountRefundModifier. For COMMISSION, AFFILIATE_AGENCY_FEE and SALE beneficiaries on a booking whose breakdown carries a payment collection fee, the net also reflects that fee: the partner’s commission is reduced by its share of the fee and the hotel’s sale is increased by the same amount. This is the amount the beneficiary is credited.
Net amount owed in internal currency: internalAmount - internalAmountRefundModifier. For COMMISSION, AFFILIATE_AGENCY_FEE and SALE beneficiaries on a booking whose breakdown carries a payment collection fee, the net also reflects that fee: the partner’s commission is reduced by its share of the fee and the hotel’s sale is increased by the same amount. This is the amount the beneficiary is credited.
Net amount owed in source currency: sourceAmount - sourceAmountRefundModifier. For COMMISSION, AFFILIATE_AGENCY_FEE and SALE beneficiaries on a booking whose breakdown carries a payment collection fee, the net also reflects that fee: the partner’s commission is reduced by its share of the fee and the hotel’s sale is increased by the same amount. This is the amount the beneficiary is credited.
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
Refund amount to be deducted from the beneficiary’s displayAmount when applied
Refund amount to be deducted from the beneficiary’s internalAmount when applied
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
Flag indicating whether net amounts have been transferred (disbursed) from TripPay to the beneficiary
Gross amount owed to this beneficiary in source currency (before refunds)
Cumulative refund reduction applied to sourceAmount (sum of all applied PendingRefunds)
ISO 4217 currency code for the originating source (supplier’s local currency, e.g. hotel in Thailand uses THB)
Category of the beneficiary: SALE (property), COMMISSION (affiliate), PLATFORM_FEE (Wink), TRIP_PAY (platform internal), or agency fees
Lightweight representation of an exchange rate quote between a source and target currency pair
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Lightweight representation of an exchange rate quote between a source and target currency pair
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
object
The payment collection (Stripe acquiring) fee apportioned to this booking, in all three currency planes. When present, the partner commission nets are reduced by commission% x fee and the hotel (SALE) nets increased by the same amount. Null = no correction (not yet captured, or not applicable).
object
Payment collection (Stripe acquiring) fee for this booking in the guest’s display currency
Payment collection (Stripe acquiring) fee for this booking in the internal platform currency
Payment collection (Stripe acquiring) fee for this booking in the hotel’s source currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in wink currency
Extra child modifier in wink currency
Extra person modifier in wink currency
Rate premiums modifiers in wink currency
Rate discount modifiers in wink currency
Singe occupant modifier in wink currency
Internal currency final price.
object
Monetary amount value
ISO 4217 currency code
Maximum occupancy
Minimum occupancy
Localized text of the discount
Simplified localized description containing text content and its language code.
object
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Premium percent
Promotional codes
Promotional discount percent
Quantity
Source
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in hotel’s currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in hotel currency
Extra child modifier in hotel currency
Extra person modifier in hotel currency.
Rate premiums modifiers in hotel currency
Rate discount modifiers in hotel currency
Single occupant modifier in hotel currency
Hotel to wink currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Hotel to user currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Source currency final price.
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in user specified currency
Extra child modifier in user specified currcency
Extra person modifier in user specified currency
Rate premiums modifiers in user specified currency
Rate discount modifiers in user specified currency
Single occupant modifier in user specified currency
User-defined currency final price.
object
Monetary amount value
ISO 4217 currency code
Localized transactional blocking
object
Localized descriptions describing inventory.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Use as title or short text description
Unique transactional identifier
Whether this item is added to every room booked automatically, at a quantity set by its pricing type. The guest cannot change or remove it.
Whether there is a limit to maximum group size.
Whether there is a limit to minimum group size.
List of images / videos of item.
Multimedia that contains less information than Multimedia object
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Internal name of transactional blocking.
Localized offer details if rate plan discount applies.
Simplified localized description containing text content and its language code.
object
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Localized price
object
Channel discount percent
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in wink currency
Premium modifiers in wink currency
Promotional modifiers in wink currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Premium percent
Promotional discount percent
How many of this item is included in this price
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in hotel currency
Premium modifiers in hotel currency
Promotional modifiers in hotel currency
Hotel to wink currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Hotel to user currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in user specified currency
Premium modifiers in user specified currency
Promotional modifiers in user specified currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
How this inventory item should be priced.
If a package is linked to a rate plan the user could be entitled to a promotional discount if she enters a code. When this field is populated, it means the discount was applied to the package.
Rate plan identifiers this item may be sold with. Empty means every rate plan. A venue price list is property-wide, so the client filters it per room.
Room type identifiers this item may be sold with. Empty means every room type. A venue price list is property-wide, so the client filters it per room.
Specified rate plan
object
Everything included except alcohol
Everything included with alcohol
Who this rate plan is sold to. PUBLIC means anyone; any other audience restricts the rate plan to guests who qualify for it. Defaults to PUBLIC when absent.
When true, indicates breakfast is included.
When true, indicates brunch is included.
When true, indicates dinner is included.
Rate plan identifier
When true, indicates lunch is included.
Provides the name of the rate plan.
Number of nights the guests will be staying
Specified master rate identifier
Specified master rate internal name
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
SimpleDateTimeItinerary startDate
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Room type identifier.
When this room type is displayed in conjunction with many others, this sort property will often times be populated to indicate how the room types should be sorted and displayed.
The potential discount the user is entitled to if user is a member / authenticated.
Indicative price band (as low as / but no more than) in the property’s currency, for the caller’s channel scope. Absent when the property has no band, and not returned by the rank-by-agency search.
object
Indicative lowest nightly price for this property, in the property’s own currency, for the caller’s channel scope. Not a quote: it ignores the searched dates and availability.
object
Monetary amount value
ISO 4217 currency code
Indicative highest nightly price for this property, in the property’s own currency, for the caller’s channel scope. Not a quote: it ignores the searched dates and availability.
object
Monetary amount value
ISO 4217 currency code
Best-priced room types
object
Whether this room type is available with this configuration
The sum of all perks the master rate had made available.
Price details for this room type configuration.
object
The active / selected cancellation policy for this room configuration
object
When the cancellation policy is refundable, this flag can be set and indicates there is more rules involved than just a no-questions-asked refundable.
Datetime this record was first created
Property this cancellation is associated with
Unique identifier for this record.
Datetime this record was last updated
In case the ‘Refundable cancellation charge’ is set, a different no show charge can be applied.
If the guest does not honor the non-refundable deadline rule, this charge dictates what she owes after the deadline passes.
When the cancellation policy is non-refundable, this flag can be set and indicates there is more rules involved to calculate what the guest will owe in case of a cancellation.
The non-refundable charge might can have a deadline. If that deadline passes, the guest might be charged more.
Whether this cancellation policy is refundable or not
If advanceCancellationFreeOfCharge rules is not honored, this property explains what the guest will be charged.
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
Add-ons that are available with this room configuration
object
The original add-on record created by the property.
object
Modify add-on availability with this flag.
End month and day or date for which the add-on is available (seasonal availability).
Start month and day or date for which the add-on is available (seasonal availability).
Base price of booking this add-on.
object
Monetary amount value
ISO 4217 currency code
Level 1 taxonomy: property-level (ADD_ON) or a specific venue type. Null is treated as ADD_ON.
Level 2 taxonomy: the ids of the specific venues of the category this add-on belongs to. EMPTY MEANS ALL items of the category. Only meaningful when category is venue-scoped.
Closing time of the add-on (if applicable). Leave empty if always available.
Indicate whether sales channels receive commission for selling this add-on.
Datetime this record was first created
Optional list of date ranges restricting add-on availability to specific periods. Empty means available on every date.
object
Retrieve data range ending with and including this end date
Retrieve data range starting with and including this start date
Indicates which days this add-on is open.
object
Convenience property to quickly determine if this existing object has any active days enabled.
Set to true to enable Friday.
Set to true to enable Monday.
Set to true to enable Saturday.
Set to true to enable Sunday.
Set to true to enable Thursday.
Set to true to enable Tuesday.
Set to true to enable Wednesday.
Localized descriptions describing this add-on.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Use as title or short text description
If this add-on is sold at a discount, the discounted selling price.
object
Monetary amount value
ISO 4217 currency code
Indicates whether this add-on is featured.
Hotel identifier.
Unique identifier for this record.
Datetime this record was last updated
Make this add-on mandatory for all guests by enabling this flag.
Maximum group size this add-on can be booked for.
Minimum group size this add-on can be booked for.
List of images / videos of this add-on.
Multimedia that contains less information than Multimedia object
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Internal name of the add-on.
Opening time of the add-on (if applicable). Leave empty if always available.
How this add-on should be priced.
Publish lifecycle state: DRAFT (incomplete, not announced) or PUBLISHED (complete/live).
Rate plan identifiers this add-on is restricted to. EMPTY MEANS AVAILABLE TO ALL rate plans.
Whether this add-on is an appointment that must be booked into a specific time slot. Independent of pricingType.
Room type identifiers this add-on is restricted to. EMPTY MEANS AVAILABLE TO ALL room types.
Use this property to sort an add-on in a list of add-ons.
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
The commission percentage.
Whether this package is commissionable based on the incoming sales channel.
Indicates whether the blocking from sales channel is direct or not. If you are a travel agent doing your own acquiring, this flag has to be true to make a booking.
Localized transactional blocking
object
Localized descriptions describing inventory.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Use as title or short text description
Unique transactional identifier
Whether this item is added to every room booked automatically, at a quantity set by its pricing type. The guest cannot change or remove it.
Whether there is a limit to maximum group size.
Whether there is a limit to minimum group size.
List of images / videos of item.
Multimedia that contains less information than Multimedia object
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Internal name of transactional blocking.
Localized offer details if rate plan discount applies.
Simplified localized description containing text content and its language code.
object
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Localized price
object
Channel discount percent
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in wink currency
Premium modifiers in wink currency
Promotional modifiers in wink currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Premium percent
Promotional discount percent
How many of this item is included in this price
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in hotel currency
Premium modifiers in hotel currency
Promotional modifiers in hotel currency
Hotel to wink currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Hotel to user currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in user specified currency
Premium modifiers in user specified currency
Promotional modifiers in user specified currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
How this inventory item should be priced.
If a package is linked to a rate plan the user could be entitled to a promotional discount if she enters a code. When this field is populated, it means the discount was applied to the package.
Rate plan identifiers this item may be sold with. Empty means every rate plan. A venue price list is property-wide, so the client filters it per room.
Room type identifiers this item may be sold with. Empty means every room type. A venue price list is property-wide, so the client filters it per room.
The actual amount of adults as determined by the hotel’s policy
The actual amount of children as determined by the hotel’s policy
The commission percentage.
Whether this package is commissionable based on the incoming sales channel.
The selected room configuration that created this record
object
Number of adult guests in this room type
Child guests in this room, with age groups
Child guest with age and quantity in a room configuration
object
Age of each child in this group (years)
Count of children of this age group in the room
Number of identical rooms with this configuration
Indicates whether the blocking from sales channel is direct or not. If you are a travel agent doing your own acquiring, this flag has to be true to make a booking.
SimpleDateTimeItinerary endDate
Per rate plan level extra charges with localized prices
object
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
List of extra charges that applies to the rate plan.
object
The localized price of the extra charge
object
Channel discount percent
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in wink currency
Premium modifiers in wink currency
Promotional modifiers in wink currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Premium percent
Promotional discount percent
How many of this item is included in this price
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in hotel currency
Premium modifiers in hotel currency
Promotional modifiers in hotel currency
Hotel to wink currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Hotel to user currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in user specified currency
Premium modifiers in user specified currency
Promotional modifiers in user specified currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
What the guest is paying extra for
object
Localized descriptions of this fee in multiple languages. At least one entry in English is required.
Simplified localized description containing text content and its language code.
object
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
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
Channel discount percent
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in wink currency
Premium modifiers in wink currency
Promotional modifiers in wink currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Premium percent
Promotional discount percent
How many of this item is included in this price
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in hotel currency
Premium modifiers in hotel currency
Promotional modifiers in hotel currency
Hotel to wink currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Hotel to user currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in user specified currency
Premium modifiers in user specified currency
Promotional modifiers in user specified currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
This is one localized bookable item that can stand alongside a restaurant / meeting room etc.
object
Localized descriptions describing inventory.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Use as title or short text description
Unique transactional identifier
Whether this item is added to every room booked automatically, at a quantity set by its pricing type. The guest cannot change or remove it.
Whether there is a limit to maximum group size.
Whether there is a limit to minimum group size.
List of images / videos of item.
Multimedia that contains less information than Multimedia object
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Internal name of transactional blocking.
Localized offer details if rate plan discount applies.
Simplified localized description containing text content and its language code.
object
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Localized price
object
Channel discount percent
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in wink currency
Premium modifiers in wink currency
Promotional modifiers in wink currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Premium percent
Promotional discount percent
How many of this item is included in this price
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in hotel currency
Premium modifiers in hotel currency
Promotional modifiers in hotel currency
Hotel to wink currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Hotel to user currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in user specified currency
Premium modifiers in user specified currency
Promotional modifiers in user specified currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
How this inventory item should be priced.
If a package is linked to a rate plan the user could be entitled to a promotional discount if she enters a code. When this field is populated, it means the discount was applied to the package.
Rate plan identifiers this item may be sold with. Empty means every rate plan. A venue price list is property-wide, so the client filters it per room.
Room type identifiers this item may be sold with. Empty means every room type. A venue price list is property-wide, so the client filters it per room.
Perks that accompany the master rate
object
Datetime this record was first created
Localized descriptions of this perk in multiple languages. Each element provides a name, description, and language code (e.g., ‘en’, ‘fr’, ‘de’).
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Use as title or short text description
Whether this perk is guaranteed to be provided or available on a best-effort basis. Guaranteed perks take priority in allocation.
Unique identifier for this record.
Datetime this record was last updated
Platform tier/value assigned to this perk (0=standard, higher=premium). Used for internal prioritization and matching with rate tiers.
Display order when showing this perk in a list (ascending sort). Lower numbers appear first; 999 is reserved for disabled/unlisted perks.
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
The combined value of these perkTypes
Calculated price
object
Available
Chanel discount percent
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
Contact email address for the beneficiary account
Unique identifier of the beneficiary’s account in the TripPay system
Display name of the beneficiary account (e.g. hotel, affiliate, or platform name)
Profile or dashboard URL for the beneficiary account
Charge rule: either a fixed percentage of the total stay or the remainder after other beneficiaries are deducted
object
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.
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).
Gross amount owed to this beneficiary in display currency (before refunds)
Cumulative refund reduction applied to displayAmount (sum of all applied PendingRefunds)
ISO 4217 currency code for display to the user (e.g. booking shown in USD)
Gross amount owed to this beneficiary in internal currency (before refunds)
Cumulative refund reduction applied to internalAmount (sum of all applied PendingRefunds)
ISO 4217 currency code for internal platform ledger (always USD)
Additional key-value metadata for the beneficiary (e.g. bank details, supplier identifiers)
object
Net amount owed in display currency: displayAmount - displayAmountRefundModifier. For COMMISSION, AFFILIATE_AGENCY_FEE and SALE beneficiaries on a booking whose breakdown carries a payment collection fee, the net also reflects that fee: the partner’s commission is reduced by its share of the fee and the hotel’s sale is increased by the same amount. This is the amount the beneficiary is credited.
Net amount owed in internal currency: internalAmount - internalAmountRefundModifier. For COMMISSION, AFFILIATE_AGENCY_FEE and SALE beneficiaries on a booking whose breakdown carries a payment collection fee, the net also reflects that fee: the partner’s commission is reduced by its share of the fee and the hotel’s sale is increased by the same amount. This is the amount the beneficiary is credited.
Net amount owed in source currency: sourceAmount - sourceAmountRefundModifier. For COMMISSION, AFFILIATE_AGENCY_FEE and SALE beneficiaries on a booking whose breakdown carries a payment collection fee, the net also reflects that fee: the partner’s commission is reduced by its share of the fee and the hotel’s sale is increased by the same amount. This is the amount the beneficiary is credited.
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
Refund amount to be deducted from the beneficiary’s displayAmount when applied
Refund amount to be deducted from the beneficiary’s internalAmount when applied
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
Flag indicating whether net amounts have been transferred (disbursed) from TripPay to the beneficiary
Gross amount owed to this beneficiary in source currency (before refunds)
Cumulative refund reduction applied to sourceAmount (sum of all applied PendingRefunds)
ISO 4217 currency code for the originating source (supplier’s local currency, e.g. hotel in Thailand uses THB)
Category of the beneficiary: SALE (property), COMMISSION (affiliate), PLATFORM_FEE (Wink), TRIP_PAY (platform internal), or agency fees
Lightweight representation of an exchange rate quote between a source and target currency pair
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Lightweight representation of an exchange rate quote between a source and target currency pair
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
object
The payment collection (Stripe acquiring) fee apportioned to this booking, in all three currency planes. When present, the partner commission nets are reduced by commission% x fee and the hotel (SALE) nets increased by the same amount. Null = no correction (not yet captured, or not applicable).
object
Payment collection (Stripe acquiring) fee for this booking in the guest’s display currency
Payment collection (Stripe acquiring) fee for this booking in the internal platform currency
Payment collection (Stripe acquiring) fee for this booking in the hotel’s source currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in wink currency
Extra child modifier in wink currency
Extra person modifier in wink currency
Rate premiums modifiers in wink currency
Rate discount modifiers in wink currency
Singe occupant modifier in wink currency
Internal currency final price.
object
Monetary amount value
ISO 4217 currency code
Maximum occupancy
Minimum occupancy
Localized text of the discount
Simplified localized description containing text content and its language code.
object
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Premium percent
Promotional codes
Promotional discount percent
Quantity
Source
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in hotel’s currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in hotel currency
Extra child modifier in hotel currency
Extra person modifier in hotel currency.
Rate premiums modifiers in hotel currency
Rate discount modifiers in hotel currency
Single occupant modifier in hotel currency
Hotel to wink currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Hotel to user currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Source currency final price.
object
Monetary amount value
ISO 4217 currency code
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in user specified currency
Extra child modifier in user specified currcency
Extra person modifier in user specified currency
Rate premiums modifiers in user specified currency
Rate discount modifiers in user specified currency
Single occupant modifier in user specified currency
User-defined currency final price.
object
Monetary amount value
ISO 4217 currency code
Localized transactional blocking
object
Localized descriptions describing inventory.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Use as title or short text description
Unique transactional identifier
Whether this item is added to every room booked automatically, at a quantity set by its pricing type. The guest cannot change or remove it.
Whether there is a limit to maximum group size.
Whether there is a limit to minimum group size.
List of images / videos of item.
Multimedia that contains less information than Multimedia object
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Internal name of transactional blocking.
Localized offer details if rate plan discount applies.
Simplified localized description containing text content and its language code.
object
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Localized price
object
Channel discount percent
Base total in wink currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in wink currency
Premium modifiers in wink currency
Promotional modifiers in wink currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Premium percent
Promotional discount percent
How many of this item is included in this price
Base total in hotel currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in hotel currency
Premium modifiers in hotel currency
Promotional modifiers in hotel currency
Hotel to wink currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Hotel to user currency exchange rate.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Base total in user specified currency.
object
Monetary amount value
ISO 4217 currency code
Channel / Membership modifier in user specified currency
Premium modifiers in user specified currency
Promotional modifiers in user specified currency
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
How this inventory item should be priced.
If a package is linked to a rate plan the user could be entitled to a promotional discount if she enters a code. When this field is populated, it means the discount was applied to the package.
Rate plan identifiers this item may be sold with. Empty means every rate plan. A venue price list is property-wide, so the client filters it per room.
Room type identifiers this item may be sold with. Empty means every room type. A venue price list is property-wide, so the client filters it per room.
Specified rate plan
object
Everything included except alcohol
Everything included with alcohol
Who this rate plan is sold to. PUBLIC means anyone; any other audience restricts the rate plan to guests who qualify for it. Defaults to PUBLIC when absent.
When true, indicates breakfast is included.
When true, indicates brunch is included.
When true, indicates dinner is included.
Rate plan identifier
When true, indicates lunch is included.
Provides the name of the rate plan.
Number of nights the guests will be staying
Specified master rate identifier
Specified master rate internal name
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
SimpleDateTimeItinerary startDate
Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed
object
Monetary amount value
ISO 4217 currency code
Room type identifier.
When this room type is displayed in conjunction with many others, this sort property will often times be populated to indicate how the room types should be sorted and displayed.
Unique property room types
A lightweight projection of a room type, carrying all occupancy, bedroom configuration, pricing and classification details needed for availability and booking flows.
object
Modify blocking availability with this flag.
Defaults to property address.
object
Address line 1
Address line 2
City name
Country
Country
County
Address 1, Address 2, City, State, Postal / Zip code, Country
Postal / zip code
State
OpenTravel room amenity codes (e.g., 1=Balcony, 7=Air Conditioning). See OTA geoname data
Number of bathrooms
A room type can have more than one bed configuration.
A named bedroom layout configuration for a room type, containing one or more bedrooms each with their own bed setup.
object
List of bedrooms within this configuration layout.
A single bedroom within a room type, specifying the bedroom type and its bed configuration.
object
List of bed configurations for this bedroom. Each entry specifies a bed type and quantity.
A single bed type and its quantity within a bedroom, described using the OpenTravel bed type code.
object
OpenTravel bed type code (e.g., 1=Double, 2=Twin, 7=Queen, 8=King). See OTA geoname data.
Number of beds of this type in the room.
Bedroom type classification (e.g., MASTER, QUEEN, JUNIOR, DORMITORY, BEDROOM_1…BEDROOM_10).
Unique identifier for this bedroom configuration layout.
Human-readable name of this room layout configuration.
Indicates if this inventory can be added to a booking or if it is read-only marketing material only.
Indicate whether sales channels receive commission for selling this inventory.
Indicates that the room (suite) is a composite of smaller units.
Number of rooms of this room type that makes up a larger unit (composite) such as a two bedroom suite could be comprised of two king rooms plus other room types. A 0 means disabled.
Associate a contact person for this inventory (if applicable).
object
Contact E-mail
Contact first name
First and last name
Contact last name
Contact phone number
Contact secondary Email
Summary
Datetime this record was first created
Localized descriptions describing inventory.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Use as title or short text description
Supported OTA specification PHY code. See OTA geoname data
Indicates whether this inventory is featured. Use this flag as a way to signify that this inventory is special.
Floor number on which this room type is located.
Hotel identifier.
Unique identifier for this record.
The number of pax the room price was meant for
The number of children the room price was meant for
Datetime this record was last updated
Indicate the type of lifestyle this inventory should be associated with.
Number of living rooms
Geo-location point where blocking takes place. Defaults to location of property.
object
Maximum number of adults allowed in a room type.
Maximum number of children allowed in a room type.
Maximum number of cribs allowed in a room type.
Maximum number of guest allowed in a room type.
Maximum number of rollaway beds allowed in this room type.
Supported OTA specification AQC code. See OTA geoname data
Minimum number of guests allowed in a room type.
List of images / videos of blocking.
Multimedia that contains less information than Multimedia object
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Media width in pixels.
Internal name of inventory.
Non-smoking indicator
Level of expensiveness.
Supported OTA specification PRX code. See OTA geoname data
Publish lifecycle state: DRAFT (incomplete, not announced) or PUBLISHED (complete/live).
Defines the number of rooms of this type
Inventory-level recognition.
Recognition for the ancillary blocking.
object
Recognition category.
The date the award was received
Recognition identifier.
Use this to let hotels indicate what the total score for this award is.
When true, this indicates the property has received official permission from the award provider to use the rating in publications and marketing materials; when false this permission has not been granted.
The name of the entity that administers this recognition.
The actual award or rating received by the hotel facility.
Provides the symbol used in the rating. Used in conjunction with the Rating.
Type of rating system the recognition operated on. This allows us to display the score properly.
OpenTravel architectural style code (e.g., 1=Modern, 2=Traditional, 3=Victorian). See OTA geoname data
OpenTravel segment category code (e.g., 1=Moderate, 4=Standard, 8=Deluxe). See OTA geoname data
OpenTravel guest room info code (e.g., 1=Suite, 2=Standard, 12=Villa, 16=Bungalow). See OTA geoname data
Used to request or specify a gender assignment for a room. Note: Typically used by Hosteliers.
OpenTravel room location type code (e.g., 1=Near Exit, 2=Close to Elevator, 3=Low Floor, 4=High Floor). See OTA geoname data
OpenTravel room view type code (e.g., 1=Ocean View, 2=Pool View, 3=Garden View). See OTA geoname data
Supported OTA specification SEC code. See OTA geoname data
If TRUE, the room requires or has sharing available. Note: Typically used by Hosteliers.
Number of square meters that defines the size of this room type.
Social network accounts for blocking (if applicable).
Social network
object
URL or social network identifier to social network profile
Type of social network.
Use this property to sort an blocking in a list of activities.
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
Exchange rate quote between the property’s source currency and the user’s currency that was used to populate price.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
Exchange rate quote between the property’s source currency and the user’s desired currency that was used to populate price.
object
Exchange rate from source to target currency
ISO 4217 source currency code
ISO 4217 target currency code
Unix epoch milliseconds when the quote was recorded
The sales channel the hotel’s lowest displayed price was computed on (a direct channel is preferred per rate over the Wink Network). For a hotel with no price, the owner’s direct channel if it has one, otherwise the Wink Network; null when neither exists.
object
A way to blacklist a specific channel a property doesn’t want to send blocking to.
System override by supplier to disable channel. E.g. Platform disables supplier.
Amount of sales commission earned through this channel and all its children [unless configured at the child level].
Datetime this record was first created
Flag the supplier can use to enable / disable this channel
Unique identifier for this record.
Datetime this record was last updated
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.
Percent discount on this channel and all its children [unless configured at the child level].
Promotion bundles for this channel
A lightweight projection of a promotion bundle containing the full set of qualifying conditions and metadata.
object
Simplified localized description containing text content and its language code.
object
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Datetime this record was first created
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
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Simplified localized description containing text content and its language code.
object
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Whether this promotion ancillary is enabled or not.
Hotel identifier.
Unique identifier for this record.
Promotions that go together to make up this ancillary.
object
Restrict promotion to users who want to book in advance.
Restrict promotion to specific days of the week the guest is arriving.
Restrict promotion to specific days of the week the promotion is available.
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).
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
City name
Continent code
Continent name
Country ISO code
Country name
GeoNameLightweight identifiers taken from https://geonames.org.
Locale code
Sub-division 1 code
Sub-division 1 name
Sub-division 2 code
Sub-division 2 name
Timezone
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
Continent code (two-letter ISO)
Continent name
Country ISO 3166-1 alpha-2 code
Country name
GeoNames identifier
Datetime this record was first created
Restrict promotion to specific days of the week the guest is departing.
Simplified localized description containing text content and its language code.
object
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Whether this promotion is enabled or not.
Qualifier that restricts a promotion to guests within a circular geographic area defined by a center point and radius.
object
Latitude of the center point for the geo-location radius check.
Longitude of the center point for the geo-location radius check.
Radius in kilometers around the center point within which the guest must be located.
Unique identifier of the property this promotion belongs to.
Unique identifier for this record.
Qualifier that restricts a promotion to guests whose IP address falls within a specified IPv4 range.
object
Ending IP address of the range (inclusive).
Starting IP address of the range (inclusive).
Restrict promotion to users who want to book a room close to the date.
Datetime this record was last updated
Restrict promotion to users who want to stay a certain number of days.
The discount or premium amount and its type (fixed or percentage).
Internal name of promotion.
Restrict promotion to either prepaid / non-prepaid rates.
This determines whether this discount should be applied per night, per stay or per person - per night
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.
Restrict promotion to either refundable / non-refundable rates.
Restrict promotion to specific days of the week the guest has to stay.
Restrict promotion by restricting to how many rooms the user wants.
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).
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 guests whose system timezone matches the specified IANA timezone name.
object
IANA timezone name of the booker’s location (e.g. Asia/Bangkok).
Set whether you want the price to go up or down when the rules of this promotion have been satisfied.
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
Datetime this record was last updated
Optional: override the combined discount of all bundle items with a single fixed or percentage amount.
Internal name of promotion ancillary.
Determines whether this discount should be applied per night, per stay or per person - per night; Required if amount override is not null
Required if manual override modifier is not null
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
Promotions for this channel
A lightweight projection of a special rate (promotion) containing all qualifying conditions and metadata.
object
Restrict promotion to users who want to book in advance.
Restrict promotion to specific days of the week the guest is arriving.
Restrict promotion to specific days of the week the promotion is available.
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).
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
City name
Continent code
Continent name
Country ISO code
Country name
GeoNameLightweight identifiers taken from https://geonames.org.
Locale code
Sub-division 1 code
Sub-division 1 name
Sub-division 2 code
Sub-division 2 name
Timezone
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
Continent code (two-letter ISO)
Continent name
Country ISO 3166-1 alpha-2 code
Country name
GeoNames identifier
Datetime this record was first created
Restrict promotion to specific days of the week the guest is departing.
Simplified localized description containing text content and its language code.
object
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Whether this promotion is enabled or not.
Qualifier that restricts a promotion to guests within a circular geographic area defined by a center point and radius.
object
Latitude of the center point for the geo-location radius check.
Longitude of the center point for the geo-location radius check.
Radius in kilometers around the center point within which the guest must be located.
Unique identifier of the property this promotion belongs to.
Unique identifier for this record.
Qualifier that restricts a promotion to guests whose IP address falls within a specified IPv4 range.
object
Ending IP address of the range (inclusive).
Starting IP address of the range (inclusive).
Restrict promotion to users who want to book a room close to the date.
Datetime this record was last updated
Restrict promotion to users who want to stay a certain number of days.
The discount or premium amount and its type (fixed or percentage).
Internal name of promotion.
Restrict promotion to either prepaid / non-prepaid rates.
This determines whether this discount should be applied per night, per stay or per person - per night
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.
Restrict promotion to either refundable / non-refundable rates.
Restrict promotion to specific days of the week the guest has to stay.
Restrict promotion by restricting to how many rooms the user wants.
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).
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 guests whose system timezone matches the specified IANA timezone name.
object
IANA timezone name of the booker’s location (e.g. Asia/Bangkok).
Set whether you want the price to go up or down when the rules of this promotion have been satisfied.
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
Whether the sales channel is a self-acquiring entity.
What type of segment of channel is this.
Channel is owned by this supplier identifier.
Name of property / supplier that owns this channel
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
Example
[ { "property": { "hotel": { "activities": 3, "addOns": 5, "address": { "city": "Bangkok", "countryCode": "TH", "line1": "3/2 Khao Road", "postalCode": "10300", "state": "Bangkok" }, "aggregateGreendexRating": 7, "aggregateReviewRating": 8.7, "architecturalStyle": "7", "attractions": 5, "available": true, "bookings": 6054, "brand": "The Siam Residences", "chain": "The Siam Collection", "currencyCode": "THB", "descriptions": [ { "description": "An elegant riverside sanctuary in the heart of Bangkok.", "language": "en", "title": "Luxury Riverside Retreat" } ], "hotelAmenityCodes": [ "1", "7" ], "hotelCategory": "45", "hotelIdentifier": "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "images": [ { "identifier": "the-siam-residences/lobby-entrance", "multimediaIdentifier": "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "published": true, "sort": 10, "type": "IMAGE" } ], "lifestyleTypes": [ "LIFESTYLE_HEALTH_FITNESS" ], "localName": "เดอะสยาม เรสซิเดนซ์", "location": { "coordinates": [ 100.5581533, 13.7370197 ], "type": "Point" }, "locationCategory": "34", "meetingRooms": 2, "name": "The Siam Residences, Bangkok", "numberOfRooms": 32, "places": 9, "propertyAccessibilityCodes": [ "1" ], "propertySecurityCodes": [ "7" ], "reservations": { "firstName": "Somchai", "lastName": "Phattanapong", "phone": "+66-2-123-4567" }, "restaurants": 2, "score": 70, "segmentCategory": "7", "socials": [ { "handle": "thesiamresidences", "platform": "INSTAGRAM" } ], "spas": 1, "starRating": 5, "thirdPartyReviews": [], "totalReviews": 989, "uniqueId": "siam-residences-bkk", "urlName": "the-siam-residences-bangkok-thailand", "videos": [], "whenBuilt": "1927" }, "lowestPrice": { "price": { "activeCancellationPolicy": { "advanceCancellationFreeOfCharge": "UNTIL_EIGHTEEN_HUNDRED_HOURS_ON_DAY_OF_ARRIVAL", "createdDate": "2026-01-14T09:30:00", "hotelIdentifier": "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "id": "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "lastUpdate": "2026-02-03T16:45:12", "noShowCharge": "SAME_AS_CANCELLATION_FEE", "nonRefundableAfterDeadlineCancellationCharge": "ONE_HUNDRED_PERCENT", "nonRefundableCancellationCharge": "SEVENTY_PERCENT", "nonRefundableDeadline": "SEVEN_DAYS_BEFORE_ARRIVAL", "refundable": false, "refundableCancellationCharge": "FIFTY_PERCENT", "version": 3 }, "addOnOffers": [ { "addOn": { "active": true, "applicableEnd": "1970-12-1", "applicableStart": "1970-1-1", "basePrice": { "amount": 1250, "currency": "USD" }, "category": "ADD_ON", "closes": "17:30", "commissionable": true, "createdDate": "2026-01-14T09:30:00", "dateRanges": [ { "endDate": "2020-12-31", "startDate": "2020-12-24" } ], "daysOfWeek": { "disabled": true, "fri": true, "mon": true, "sat": true, "sun": true, "thu": true, "tue": true, "wed": true }, "descriptions": [ { "creator": "USER", "description": "Spacious suite with floor-to-ceiling windows overlooking the Chao Phraya River, featuring a king-size bed, private balcony, and marble bathroom.", "language": "en", "md5ContentHash": "a3f1c8e2d74b60912a5c3e9b1d7f4e82", "name": "Deluxe River View Suite" } ], "discountedPrice": { "amount": 1250, "currency": "USD" }, "featuredInd": false, "hotelIdentifier": "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "id": "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "lastUpdate": "2026-02-03T16:45:12", "mandatory": true, "maxPax": 4, "minPax": 1, "multimedias": [ { "angle": null, "attribution": [], "category": "2", "descriptions": [ { "description": "Elegant lobby of The Siam Residences", "language": "en", "title": "Lobby Entrance" } ], "height": 1600, "identifier": "the-siam-residences/lobby-entrance", "isLandscape": true, "lifestyleType": null, "multimediaIdentifier": "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "published": true, "sort": 10, "source": "CLOUDINARY", "type": "IMAGE", "width": 2560 } ], "name": "Airport Pickup", "opens": "09:00", "pricingType": "PER_USE", "publishStatus": "PUBLISHED", "requiresTimeSlot": false, "sort": 1, "version": 3 }, "commission": 0.1, "direct": true, "priceList": [ { "descriptions": [ { "creator": "USER", "description": "Spacious suite with floor-to-ceiling windows overlooking the Chao Phraya River, featuring a king-size bed, private balcony, and marble bathroom.", "language": "en", "md5ContentHash": "a3f1c8e2d74b60912a5c3e9b1d7f4e82", "name": "Deluxe River View Suite" } ], "identifier": "travel-blocking-1", "mandatory": false, "maxPax": 10, "minPax": 2, "multimedias": [ { "angle": null, "attribution": [], "category": "2", "descriptions": [ { "description": "Elegant lobby of The Siam Residences", "language": "en", "title": "Lobby Entrance" } ], "height": 1600, "identifier": "the-siam-residences/lobby-entrance", "isLandscape": true, "lifestyleType": null, "multimediaIdentifier": "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "published": true, "sort": 10, "source": "CLOUDINARY", "type": "IMAGE", "width": 2560 } ], "name": "1 hour session", "offerDetails": [ { "creator": "USER", "description": "This is a longer description in the specified language.", "language": "en", "md5ContentHash": "d41d8cd98f00b204e9800998ecf8427e" } ], "price": { "internalBaseTotal": { "amount": 1250, "currency": "USD" }, "internalChannelModifier": -10, "internalPremiumModifier": 40, "internalPromotionalModifier": -40, "internalTotal": { "amount": 1250, "currency": "USD" }, "quantity": 1, "sourceBaseTotal": { "amount": 1250, "currency": "USD" }, "sourceChannelModifier": -10, "sourcePremiumModifier": 40, "sourcePromotionalModifier": -40, "sourceToInternalCurrencyQuote": { "exchangeRate": 33.5, "source": "USD", "target": "THB", "timestamp": 1705233000000 }, "sourceToUserCurrencyQuote": { "exchangeRate": 33.5, "source": "USD", "target": "THB", "timestamp": 1705233000000 }, "sourceTotal": { "amount": 1250, "currency": "USD" }, "userSpecifiedCurrencyBaseTotal": { "amount": 1250, "currency": "USD" }, "userSpecifiedCurrencyChannelModifier": -10, "userSpecifiedCurrencyPremiumModifier": 40, "userSpecifiedCurrencyPromotionalModifier": -40, "userSpecifiedCurrencyTotal": { "amount": 1250, "currency": "USD" } } } ] } ], "commission": 0.1, "configuration": { "adults": 2, "children": [ { "age": 7, "quantity": 2 } ], "quantity": 2 }, "direct": true, "extraCharges": { "internalTotal": { "amount": 1250, "currency": "USD" }, "items": [ { "price": { "internalBaseTotal": { "amount": 1250, "currency": "USD" }, "internalChannelModifier": -10, "internalPremiumModifier": 40, "internalPromotionalModifier": -40, "internalTotal": { "amount": 1250, "currency": "USD" }, "quantity": 1, "sourceBaseTotal": { "amount": 1250, "currency": "USD" }, "sourceChannelModifier": -10, "sourcePremiumModifier": 40, "sourcePromotionalModifier": -40, "sourceToInternalCurrencyQuote": { "exchangeRate": 33.5, "source": "USD", "target": "THB", "timestamp": 1705233000000 }, "sourceToUserCurrencyQuote": { "exchangeRate": 33.5, "source": "USD", "target": "THB", "timestamp": 1705233000000 }, "sourceTotal": { "amount": 1250, "currency": "USD" }, "userSpecifiedCurrencyBaseTotal": { "amount": 1250, "currency": "USD" }, "userSpecifiedCurrencyChannelModifier": -10, "userSpecifiedCurrencyPremiumModifier": 40, "userSpecifiedCurrencyPromotionalModifier": -40, "userSpecifiedCurrencyTotal": { "amount": 1250, "currency": "USD" } }, "ratePlanLevelFee": { "descriptions": [ { "creator": "USER", "description": "This is a longer description in the specified language.", "language": "en", "md5ContentHash": "d41d8cd98f00b204e9800998ecf8427e" } ], "fixedAmount": 450, "type": "PER_DAY" }, "unitPrice": { "internalBaseTotal": { "amount": 1250, "currency": "USD" }, "internalChannelModifier": -10, "internalPremiumModifier": 40, "internalPromotionalModifier": -40, "internalTotal": { "amount": 1250, "currency": "USD" }, "quantity": 1, "sourceBaseTotal": { "amount": 1250, "currency": "USD" }, "sourceChannelModifier": -10, "sourcePremiumModifier": 40, "sourcePromotionalModifier": -40, "sourceToInternalCurrencyQuote": { "exchangeRate": 33.5, "source": "USD", "target": "THB", "timestamp": 1705233000000 }, "sourceToUserCurrencyQuote": { "exchangeRate": 33.5, "source": "USD", "target": "THB", "timestamp": 1705233000000 }, "sourceTotal": { "amount": 1250, "currency": "USD" }, "userSpecifiedCurrencyBaseTotal": { "amount": 1250, "currency": "USD" }, "userSpecifiedCurrencyChannelModifier": -10, "userSpecifiedCurrencyPremiumModifier": 40, "userSpecifiedCurrencyPromotionalModifier": -40, "userSpecifiedCurrencyTotal": { "amount": 1250, "currency": "USD" } } } ], "sourceTotal": { "amount": 1250, "currency": "USD" }, "userSpecifiedCurrencyTotal": { "amount": 1250, "currency": "USD" } }, "internalTotal": { "amount": 1250, "currency": "USD" }, "list": [ { "descriptions": [ { "creator": "USER", "description": "Spacious suite with floor-to-ceiling windows overlooking the Chao Phraya River, featuring a king-size bed, private balcony, and marble bathroom.", "language": "en", "md5ContentHash": "a3f1c8e2d74b60912a5c3e9b1d7f4e82", "name": "Deluxe River View Suite" } ], "identifier": "travel-blocking-1", "mandatory": false, "maxPax": 10, "minPax": 2, "multimedias": [ { "angle": null, "attribution": [], "category": "2", "descriptions": [ { "description": "Elegant lobby of The Siam Residences", "language": "en", "title": "Lobby Entrance" } ], "height": 1600, "identifier": "the-siam-residences/lobby-entrance", "isLandscape": true, "lifestyleType": null, "multimediaIdentifier": "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "published": true, "sort": 10, "source": "CLOUDINARY", "type": "IMAGE", "width": 2560 } ], "name": "1 hour session", "offerDetails": [ { "creator": "USER", "description": "This is a longer description in the specified language.", "language": "en", "md5ContentHash": "d41d8cd98f00b204e9800998ecf8427e" } ], "price": { "internalBaseTotal": { "amount": 1250, "currency": "USD" }, "internalChannelModifier": -10, "internalPremiumModifier": 40, "internalPromotionalModifier": -40, "internalTotal": { "amount": 1250, "currency": "USD" }, "quantity": 1, "sourceBaseTotal": { "amount": 1250, "currency": "USD" }, "sourceChannelModifier": -10, "sourcePremiumModifier": 40, "sourcePromotionalModifier": -40, "sourceToInternalCurrencyQuote": { "exchangeRate": 33.5, "source": "USD", "target": "THB", "timestamp": 1705233000000 }, "sourceToUserCurrencyQuote": { "exchangeRate": 33.5, "source": "USD", "target": "THB", "timestamp": 1705233000000 }, "sourceTotal": { "amount": 1250, "currency": "USD" }, "userSpecifiedCurrencyBaseTotal": { "amount": 1250, "currency": "USD" }, "userSpecifiedCurrencyChannelModifier": -10, "userSpecifiedCurrencyPremiumModifier": 40, "userSpecifiedCurrencyPromotionalModifier": -40, "userSpecifiedCurrencyTotal": { "amount": 1250, "currency": "USD" } } } ], "perkTypes": [ { "descriptions": [ { "description": "Guaranteed upgrade to the next available room category at check-in", "language": "en", "name": "Guaranteed Room Upgrade" } ], "guaranteed": true, "id": "PERK_GUARANTEED_UPGRADE", "level": 3, "sort": 5 } ], "price": { "financialBreakdown": { "beneficiaryList": [ { "accountIdentifier": "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "accountName": "The Siam Residences, Bangkok", "accountUrl": "https://trvl.as/the-siam-residences-bangkok", "amountDue": { "percent": 0.05 }, "displayAmount": 450, "displayAmountRefundModifier": 45, "displayCurrency": "USD", "internalAmount": 450, "internalAmountRefundModifier": 45, "internalCurrency": "USD", "netDisplayAmount": 450, "netInternalAmount": 450, "netSourceAmount": 450, "pendingRefunds": [ { "displayAmountRefundModifier": 45, "internalAmountRefundModifier": 45, "refundIdentifier": "ref-d5b8a3c2-9e6f-4a1b-8d34", "sourceAmountRefundModifier": 45 } ], "reconciled": false, "sourceAmount": 450, "sourceAmountRefundModifier": 45, "sourceCurrency": "THB" } ], "displayPriceQuote": { "exchangeRate": 33.5, "source": "USD", "target": "THB", "timestamp": 1705233000000 }, "internalPriceQuote": { "exchangeRate": 33.5, "source": "USD", "target": "THB", "timestamp": 1705233000000 } }, "internalAveragePricePerNight": { "amount": 1250, "currency": "USD" }, "internalBaseTotal": { "amount": 1250, "currency": "USD" }, "internalChannelModifier": -10, "internalExtraChildModifier": 15, "internalExtraPaxModifier": 15, "internalPremiumModifier": 40, "internalPromotionalModifier": -40, "internalSingleOccupantModifier": -15, "internalTotal": { "amount": 1250, "currency": "USD" }, "offerDetails": [ { "creator": "USER", "description": "This is a longer description in the specified language.", "language": "en", "md5ContentHash": "d41d8cd98f00b204e9800998ecf8427e" } ], "sourceAveragePricePerNight": { "amount": 1250, "currency": "USD" }, "sourceBaseTotal": { "amount": 1250, "currency": "USD" }, "sourceChannelModifier": -10, "sourceExtraChildModifier": 15, "sourceExtraPaxModifier": 15, "sourcePremiumModifier": 40, "sourcePromotionalModifier": -40, "sourceSingleOccupantModifier": -15, "sourceToInternalCurrencyQuote": { "exchangeRate": 33.5, "source": "USD", "target": "THB", "timestamp": 1705233000000 }, "sourceToUserCurrencyQuote": { "exchangeRate": 33.5, "source": "USD", "target": "THB", "timestamp": 1705233000000 }, "sourceTotal": { "amount": 1250, "currency": "USD" }, "userSpecifiedCurrencyAveragePricePerNight": { "amount": 1250, "currency": "USD" }, "userSpecifiedCurrencyBaseTotal": { "amount": 1250, "currency": "USD" }, "userSpecifiedCurrencyChannelModifier": -10, "userSpecifiedCurrencyExtraChildModifier": 15, "userSpecifiedCurrencyExtraPaxModifier": 15, "userSpecifiedCurrencyPremiumModifier": 40, "userSpecifiedCurrencyPromotionalModifier": -40, "userSpecifiedCurrencySingleOccupantModifier": -15, "userSpecifiedCurrencyTotal": { "amount": 1250, "currency": "USD" } }, "priceList": [ { "descriptions": [ { "creator": "USER", "description": "Spacious suite with floor-to-ceiling windows overlooking the Chao Phraya River, featuring a king-size bed, private balcony, and marble bathroom.", "language": "en", "md5ContentHash": "a3f1c8e2d74b60912a5c3e9b1d7f4e82", "name": "Deluxe River View Suite" } ], "identifier": "travel-blocking-1", "mandatory": false, "maxPax": 10, "minPax": 2, "multimedias": [ { "angle": null, "attribution": [], "category": "2", "descriptions": [ { "description": "Elegant lobby of The Siam Residences", "language": "en", "title": "Lobby Entrance" } ], "height": 1600, "identifier": "the-siam-residences/lobby-entrance", "isLandscape": true, "lifestyleType": null, "multimediaIdentifier": "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "published": true, "sort": 10, "source": "CLOUDINARY", "type": "IMAGE", "width": 2560 } ], "name": "1 hour session", "offerDetails": [ { "creator": "USER", "description": "This is a longer description in the specified language.", "language": "en", "md5ContentHash": "d41d8cd98f00b204e9800998ecf8427e" } ], "price": { "internalBaseTotal": { "amount": 1250, "currency": "USD" }, "internalChannelModifier": -10, "internalPremiumModifier": 40, "internalPromotionalModifier": -40, "internalTotal": { "amount": 1250, "currency": "USD" }, "quantity": 1, "sourceBaseTotal": { "amount": 1250, "currency": "USD" }, "sourceChannelModifier": -10, "sourcePremiumModifier": 40, "sourcePromotionalModifier": -40, "sourceToInternalCurrencyQuote": { "exchangeRate": 33.5, "source": "USD", "target": "THB", "timestamp": 1705233000000 }, "sourceToUserCurrencyQuote": { "exchangeRate": 33.5, "source": "USD", "target": "THB", "timestamp": 1705233000000 }, "sourceTotal": { "amount": 1250, "currency": "USD" }, "userSpecifiedCurrencyBaseTotal": { "amount": 1250, "currency": "USD" }, "userSpecifiedCurrencyChannelModifier": -10, "userSpecifiedCurrencyPremiumModifier": 40, "userSpecifiedCurrencyPromotionalModifier": -40, "userSpecifiedCurrencyTotal": { "amount": 1250, "currency": "USD" } } } ], "ratePlan": { "allInclusive": false, "allInclusivePlusAlcohol": false, "breakfast": false, "brunch": false, "dinner": false, "lunch": false, "name": "BAR 1" }, "sourceTotal": { "amount": 1250, "currency": "USD" }, "userSpecifiedCurrencyTotal": { "amount": 1250, "currency": "USD" } } }, "priceBand": { "asLowAs": { "amount": 1250, "currency": "USD" }, "butNoMoreThan": { "amount": 1250, "currency": "USD" } }, "priceList": [ { "price": { "activeCancellationPolicy": { "advanceCancellationFreeOfCharge": "UNTIL_EIGHTEEN_HUNDRED_HOURS_ON_DAY_OF_ARRIVAL", "createdDate": "2026-01-14T09:30:00", "hotelIdentifier": "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "id": "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "lastUpdate": "2026-02-03T16:45:12", "noShowCharge": "SAME_AS_CANCELLATION_FEE", "nonRefundableAfterDeadlineCancellationCharge": "ONE_HUNDRED_PERCENT", "nonRefundableCancellationCharge": "SEVENTY_PERCENT", "nonRefundableDeadline": "SEVEN_DAYS_BEFORE_ARRIVAL", "refundable": false, "refundableCancellationCharge": "FIFTY_PERCENT", "version": 3 }, "addOnOffers": [ { "addOn": { "active": true, "applicableEnd": "1970-12-1", "applicableStart": "1970-1-1", "basePrice": { "amount": 1250, "currency": "USD" }, "category": "ADD_ON", "closes": "17:30", "commissionable": true, "createdDate": "2026-01-14T09:30:00", "dateRanges": [ { "endDate": "2020-12-31", "startDate": "2020-12-24" } ], "daysOfWeek": { "disabled": true, "fri": true, "mon": true, "sat": true, "sun": true, "thu": true, "tue": true, "wed": true }, "descriptions": [ { "creator": "USER", "description": "Spacious suite with floor-to-ceiling windows overlooking the Chao Phraya River, featuring a king-size bed, private balcony, and marble bathroom.", "language": "en", "md5ContentHash": "a3f1c8e2d74b60912a5c3e9b1d7f4e82", "name": "Deluxe River View Suite" } ], "discountedPrice": { "amount": 1250, "currency": "USD" }, "featuredInd": false, "hotelIdentifier": "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "id": "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "lastUpdate": "2026-02-03T16:45:12", "mandatory": true, "maxPax": 4, "minPax": 1, "multimedias": [ { "angle": null, "attribution": [], "category": "2", "descriptions": [ { "description": "Elegant lobby of The Siam Residences", "language": "en", "title": "Lobby Entrance" } ], "height": 1600, "identifier": "the-siam-residences/lobby-entrance", "isLandscape": true, "lifestyleType": null, "multimediaIdentifier": "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "published": true, "sort": 10, "source": "CLOUDINARY", "type": "IMAGE", "width": 2560 } ], "name": "Airport Pickup", "opens": "09:00", "pricingType": "PER_USE", "publishStatus": "PUBLISHED", "requiresTimeSlot": false, "sort": 1, "version": 3 }, "commission": 0.1, "direct": true, "priceList": [ { "descriptions": [ { "creator": "USER", "description": "Spacious suite with floor-to-ceiling windows overlooking the Chao Phraya River, featuring a king-size bed, private balcony, and marble bathroom.", "language": "en", "md5ContentHash": "a3f1c8e2d74b60912a5c3e9b1d7f4e82", "name": "Deluxe River View Suite" } ], "identifier": "travel-blocking-1", "mandatory": false, "maxPax": 10, "minPax": 2, "multimedias": [ { "angle": null, "attribution": [], "category": "2", "descriptions": [ { "description": "Elegant lobby of The Siam Residences", "language": "en", "title": "Lobby Entrance" } ], "height": 1600, "identifier": "the-siam-residences/lobby-entrance", "isLandscape": true, "lifestyleType": null, "multimediaIdentifier": "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "published": true, "sort": 10, "source": "CLOUDINARY", "type": "IMAGE", "width": 2560 } ], "name": "1 hour session", "offerDetails": [ { "creator": "USER", "description": "This is a longer description in the specified language.", "language": "en", "md5ContentHash": "d41d8cd98f00b204e9800998ecf8427e" } ], "price": { "internalBaseTotal": { "amount": 1250, "currency": "USD" }, "internalChannelModifier": -10, "internalPremiumModifier": 40, "internalPromotionalModifier": -40, "internalTotal": { "amount": 1250, "currency": "USD" }, "quantity": 1, "sourceBaseTotal": { "amount": 1250, "currency": "USD" }, "sourceChannelModifier": -10, "sourcePremiumModifier": 40, "sourcePromotionalModifier": -40, "sourceToInternalCurrencyQuote": { "exchangeRate": 33.5, "source": "USD", "target": "THB", "timestamp": 1705233000000 }, "sourceToUserCurrencyQuote": { "exchangeRate": 33.5, "source": "USD", "target": "THB", "timestamp": 1705233000000 }, "sourceTotal": { "amount": 1250, "currency": "USD" }, "userSpecifiedCurrencyBaseTotal": { "amount": 1250, "currency": "USD" }, "userSpecifiedCurrencyChannelModifier": -10, "userSpecifiedCurrencyPremiumModifier": 40, "userSpecifiedCurrencyPromotionalModifier": -40, "userSpecifiedCurrencyTotal": { "amount": 1250, "currency": "USD" } } } ] } ], "commission": 0.1, "configuration": { "adults": 2, "children": [ { "age": 7, "quantity": 2 } ], "quantity": 2 }, "direct": true, "extraCharges": { "internalTotal": { "amount": 1250, "currency": "USD" }, "items": [ { "price": { "internalBaseTotal": { "amount": 1250, "currency": "USD" }, "internalChannelModifier": -10, "internalPremiumModifier": 40, "internalPromotionalModifier": -40, "internalTotal": { "amount": 1250, "currency": "USD" }, "quantity": 1, "sourceBaseTotal": { "amount": 1250, "currency": "USD" }, "sourceChannelModifier": -10, "sourcePremiumModifier": 40, "sourcePromotionalModifier": -40, "sourceToInternalCurrencyQuote": { "exchangeRate": 33.5, "source": "USD", "target": "THB", "timestamp": 1705233000000 }, "sourceToUserCurrencyQuote": { "exchangeRate": 33.5, "source": "USD", "target": "THB", "timestamp": 1705233000000 }, "sourceTotal": { "amount": 1250, "currency": "USD" }, "userSpecifiedCurrencyBaseTotal": { "amount": 1250, "currency": "USD" }, "userSpecifiedCurrencyChannelModifier": -10, "userSpecifiedCurrencyPremiumModifier": 40, "userSpecifiedCurrencyPromotionalModifier": -40, "userSpecifiedCurrencyTotal": { "amount": 1250, "currency": "USD" } }, "ratePlanLevelFee": { "descriptions": [ { "creator": "USER", "description": "This is a longer description in the specified language.", "language": "en", "md5ContentHash": "d41d8cd98f00b204e9800998ecf8427e" } ], "fixedAmount": 450, "type": "PER_DAY" }, "unitPrice": { "internalBaseTotal": { "amount": 1250, "currency": "USD" }, "internalChannelModifier": -10, "internalPremiumModifier": 40, "internalPromotionalModifier": -40, "internalTotal": { "amount": 1250, "currency": "USD" }, "quantity": 1, "sourceBaseTotal": { "amount": 1250, "currency": "USD" }, "sourceChannelModifier": -10, "sourcePremiumModifier": 40, "sourcePromotionalModifier": -40, "sourceToInternalCurrencyQuote": { "exchangeRate": 33.5, "source": "USD", "target": "THB", "timestamp": 1705233000000 }, "sourceToUserCurrencyQuote": { "exchangeRate": 33.5, "source": "USD", "target": "THB", "timestamp": 1705233000000 }, "sourceTotal": { "amount": 1250, "currency": "USD" }, "userSpecifiedCurrencyBaseTotal": { "amount": 1250, "currency": "USD" }, "userSpecifiedCurrencyChannelModifier": -10, "userSpecifiedCurrencyPremiumModifier": 40, "userSpecifiedCurrencyPromotionalModifier": -40, "userSpecifiedCurrencyTotal": { "amount": 1250, "currency": "USD" } } } ], "sourceTotal": { "amount": 1250, "currency": "USD" }, "userSpecifiedCurrencyTotal": { "amount": 1250, "currency": "USD" } }, "internalTotal": { "amount": 1250, "currency": "USD" }, "list": [ { "descriptions": [ { "creator": "USER", "description": "Spacious suite with floor-to-ceiling windows overlooking the Chao Phraya River, featuring a king-size bed, private balcony, and marble bathroom.", "language": "en", "md5ContentHash": "a3f1c8e2d74b60912a5c3e9b1d7f4e82", "name": "Deluxe River View Suite" } ], "identifier": "travel-blocking-1", "mandatory": false, "maxPax": 10, "minPax": 2, "multimedias": [ { "angle": null, "attribution": [], "category": "2", "descriptions": [ { "description": "Elegant lobby of The Siam Residences", "language": "en", "title": "Lobby Entrance" } ], "height": 1600, "identifier": "the-siam-residences/lobby-entrance", "isLandscape": true, "lifestyleType": null, "multimediaIdentifier": "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "published": true, "sort": 10, "source": "CLOUDINARY", "type": "IMAGE", "width": 2560 } ], "name": "1 hour session", "offerDetails": [ { "creator": "USER", "description": "This is a longer description in the specified language.", "language": "en", "md5ContentHash": "d41d8cd98f00b204e9800998ecf8427e" } ], "price": { "internalBaseTotal": { "amount": 1250, "currency": "USD" }, "internalChannelModifier": -10, "internalPremiumModifier": 40, "internalPromotionalModifier": -40, "internalTotal": { "amount": 1250, "currency": "USD" }, "quantity": 1, "sourceBaseTotal": { "amount": 1250, "currency": "USD" }, "sourceChannelModifier": -10, "sourcePremiumModifier": 40, "sourcePromotionalModifier": -40, "sourceToInternalCurrencyQuote": { "exchangeRate": 33.5, "source": "USD", "target": "THB", "timestamp": 1705233000000 }, "sourceToUserCurrencyQuote": { "exchangeRate": 33.5, "source": "USD", "target": "THB", "timestamp": 1705233000000 }, "sourceTotal": { "amount": 1250, "currency": "USD" }, "userSpecifiedCurrencyBaseTotal": { "amount": 1250, "currency": "USD" }, "userSpecifiedCurrencyChannelModifier": -10, "userSpecifiedCurrencyPremiumModifier": 40, "userSpecifiedCurrencyPromotionalModifier": -40, "userSpecifiedCurrencyTotal": { "amount": 1250, "currency": "USD" } } } ], "perkTypes": [ { "descriptions": [ { "description": "Guaranteed upgrade to the next available room category at check-in", "language": "en", "name": "Guaranteed Room Upgrade" } ], "guaranteed": true, "id": "PERK_GUARANTEED_UPGRADE", "level": 3, "sort": 5 } ], "price": { "financialBreakdown": { "beneficiaryList": [ { "accountIdentifier": "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "accountName": "The Siam Residences, Bangkok", "accountUrl": "https://trvl.as/the-siam-residences-bangkok", "amountDue": { "percent": 0.05 }, "displayAmount": 450, "displayAmountRefundModifier": 45, "displayCurrency": "USD", "internalAmount": 450, "internalAmountRefundModifier": 45, "internalCurrency": "USD", "netDisplayAmount": 450, "netInternalAmount": 450, "netSourceAmount": 450, "pendingRefunds": [ { "displayAmountRefundModifier": 45, "internalAmountRefundModifier": 45, "refundIdentifier": "ref-d5b8a3c2-9e6f-4a1b-8d34", "sourceAmountRefundModifier": 45 } ], "reconciled": false, "sourceAmount": 450, "sourceAmountRefundModifier": 45, "sourceCurrency": "THB" } ], "displayPriceQuote": { "exchangeRate": 33.5, "source": "USD", "target": "THB", "timestamp": 1705233000000 }, "internalPriceQuote": { "exchangeRate": 33.5, "source": "USD", "target": "THB", "timestamp": 1705233000000 } }, "internalAveragePricePerNight": { "amount": 1250, "currency": "USD" }, "internalBaseTotal": { "amount": 1250, "currency": "USD" }, "internalChannelModifier": -10, "internalExtraChildModifier": 15, "internalExtraPaxModifier": 15, "internalPremiumModifier": 40, "internalPromotionalModifier": -40, "internalSingleOccupantModifier": -15, "internalTotal": { "amount": 1250, "currency": "USD" }, "offerDetails": [ { "creator": "USER", "description": "This is a longer description in the specified language.", "language": "en", "md5ContentHash": "d41d8cd98f00b204e9800998ecf8427e" } ], "sourceAveragePricePerNight": { "amount": 1250, "currency": "USD" }, "sourceBaseTotal": { "amount": 1250, "currency": "USD" }, "sourceChannelModifier": -10, "sourceExtraChildModifier": 15, "sourceExtraPaxModifier": 15, "sourcePremiumModifier": 40, "sourcePromotionalModifier": -40, "sourceSingleOccupantModifier": -15, "sourceToInternalCurrencyQuote": { "exchangeRate": 33.5, "source": "USD", "target": "THB", "timestamp": 1705233000000 }, "sourceToUserCurrencyQuote": { "exchangeRate": 33.5, "source": "USD", "target": "THB", "timestamp": 1705233000000 }, "sourceTotal": { "amount": 1250, "currency": "USD" }, "userSpecifiedCurrencyAveragePricePerNight": { "amount": 1250, "currency": "USD" }, "userSpecifiedCurrencyBaseTotal": { "amount": 1250, "currency": "USD" }, "userSpecifiedCurrencyChannelModifier": -10, "userSpecifiedCurrencyExtraChildModifier": 15, "userSpecifiedCurrencyExtraPaxModifier": 15, "userSpecifiedCurrencyPremiumModifier": 40, "userSpecifiedCurrencyPromotionalModifier": -40, "userSpecifiedCurrencySingleOccupantModifier": -15, "userSpecifiedCurrencyTotal": { "amount": 1250, "currency": "USD" } }, "priceList": [ { "descriptions": [ { "creator": "USER", "description": "Spacious suite with floor-to-ceiling windows overlooking the Chao Phraya River, featuring a king-size bed, private balcony, and marble bathroom.", "language": "en", "md5ContentHash": "a3f1c8e2d74b60912a5c3e9b1d7f4e82", "name": "Deluxe River View Suite" } ], "identifier": "travel-blocking-1", "mandatory": false, "maxPax": 10, "minPax": 2, "multimedias": [ { "angle": null, "attribution": [], "category": "2", "descriptions": [ { "description": "Elegant lobby of The Siam Residences", "language": "en", "title": "Lobby Entrance" } ], "height": 1600, "identifier": "the-siam-residences/lobby-entrance", "isLandscape": true, "lifestyleType": null, "multimediaIdentifier": "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "published": true, "sort": 10, "source": "CLOUDINARY", "type": "IMAGE", "width": 2560 } ], "name": "1 hour session", "offerDetails": [ { "creator": "USER", "description": "This is a longer description in the specified language.", "language": "en", "md5ContentHash": "d41d8cd98f00b204e9800998ecf8427e" } ], "price": { "internalBaseTotal": { "amount": 1250, "currency": "USD" }, "internalChannelModifier": -10, "internalPremiumModifier": 40, "internalPromotionalModifier": -40, "internalTotal": { "amount": 1250, "currency": "USD" }, "quantity": 1, "sourceBaseTotal": { "amount": 1250, "currency": "USD" }, "sourceChannelModifier": -10, "sourcePremiumModifier": 40, "sourcePromotionalModifier": -40, "sourceToInternalCurrencyQuote": { "exchangeRate": 33.5, "source": "USD", "target": "THB", "timestamp": 1705233000000 }, "sourceToUserCurrencyQuote": { "exchangeRate": 33.5, "source": "USD", "target": "THB", "timestamp": 1705233000000 }, "sourceTotal": { "amount": 1250, "currency": "USD" }, "userSpecifiedCurrencyBaseTotal": { "amount": 1250, "currency": "USD" }, "userSpecifiedCurrencyChannelModifier": -10, "userSpecifiedCurrencyPremiumModifier": 40, "userSpecifiedCurrencyPromotionalModifier": -40, "userSpecifiedCurrencyTotal": { "amount": 1250, "currency": "USD" } } } ], "ratePlan": { "allInclusive": false, "allInclusivePlusAlcohol": false, "breakfast": false, "brunch": false, "dinner": false, "lunch": false, "name": "BAR 1" }, "sourceTotal": { "amount": 1250, "currency": "USD" }, "userSpecifiedCurrencyTotal": { "amount": 1250, "currency": "USD" } } } ], "roomTypeList": [ { "active": true, "address": { "address1": "234 Near da beach", "address2": "Pebble #5001", "city": "Bangkok", "country": "United States", "countryCode": "TH", "county": "Alameda county", "fullAddress": "11 At home, Suite 3C, New York City, NY 10010, United States", "postalCode": "90210", "state": "CA" }, "bathroomCount": 0, "bedroomConfigurationList": [ { "bedroomList": [ { "bedList": [ { "bedTypeCode": "1", "quantity": 2 } ], "type": "MASTER" } ], "identifier": "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "name": "Master Suite Layout" } ], "bookable": true, "commissionable": true, "composite": false, "compositeCount": 2, "contact": { "firstName": "Alexandra", "fullName": "Alexandra Beaumont", "lastName": "Beaumont", "phoneNumber": "+12125551212", }, "createdDate": "2026-01-14T09:30:00", "descriptions": [ { "creator": "USER", "description": "Spacious suite with floor-to-ceiling windows overlooking the Chao Phraya River, featuring a king-size bed, private balcony, and marble bathroom.", "language": "en", "md5ContentHash": "a3f1c8e2d74b60912a5c3e9b1d7f4e82", "name": "Deluxe River View Suite" } ], "featuredInd": false, "floor": "3", "hotelIdentifier": "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "id": "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "includedAdultOccupancy": 2, "includedChildOccupancy": 0, "lastUpdate": "2026-02-03T16:45:12", "lifestyleType": "LIFESTYLE_HEALTH_FITNESS", "livingRoomCount": 0, "location": { "coordinates": [ 100.5581533, 13.7370197 ], "type": "POINT" }, "maxAdultOccupancy": 1, "maxChildOccupancy": 0, "maxCribs": 1, "maxOccupancy": 2, "maxRollaways": 0, "minAgeAppropriateCode": "1", "minOccupancy": 1, "multimedias": [ { "angle": null, "attribution": [], "category": "2", "descriptions": [ { "description": "Elegant lobby of The Siam Residences", "language": "en", "title": "Lobby Entrance" } ], "height": 1600, "identifier": "the-siam-residences/lobby-entrance", "isLandscape": true, "lifestyleType": null, "multimediaIdentifier": "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "published": true, "sort": 10, "source": "CLOUDINARY", "type": "IMAGE", "width": 2560 } ], "name": "Archery lesson", "nonSmoking": true, "pricePoint": "THREE", "proximityCode": "1", "publishStatus": "PUBLISHED", "quantity": 40, "recognitionList": [ { "category": "AWARD", "date": "2026-01-14", "identifier": "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "maxRating": 10, "officialAppointmentInd": true, "provider": "Michelin", "rating": 8.5, "ratingSymbol": "*", "type": "PERCENT_RATING" } ], "roomArchitectureCode": "1", "roomCategory": "1", "roomClassificationCode": "1", "roomGender": "Female", "roomLocationCode": "1", "roomViewCode": "1", "sharedRoomInd": false, "size": 55, "socials": [ { "location": "https://www.instagram.com/thesiamresidences", "type": "INSTAGRAM" } ], "sort": 1, "version": 3 } ], "sourceToInternalCurrencyQuote": { "exchangeRate": 33.5, "source": "USD", "target": "THB", "timestamp": 1705233000000 }, "sourceToUserCurrencyQuote": { "exchangeRate": 33.5, "source": "USD", "target": "THB", "timestamp": 1705233000000 } }, "salesChannel": { "blacklisted": false, "channelDisabled": false, "commission": 0.2, "createdDate": "2026-01-14T09:30:00", "enabled": true, "id": "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "lastUpdate": "2026-02-03T16:45:12", "ownerIdentifier": "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "ownerName": "The Siam Residences", "percentDiscount": 0.15, "rateModifierBundles": [ { "aggregatedItemDescriptions": [ { "creator": "USER", "description": "This is a longer description in the specified language.", "language": "en", "md5ContentHash": "d41d8cd98f00b204e9800998ecf8427e" } ], "createdDate": "2026-01-14T09:30:00", "descriptions": [ { "creator": "USER", "description": "This is a longer description in the specified language.", "language": "en", "md5ContentHash": "d41d8cd98f00b204e9800998ecf8427e" } ], "effectiveDescriptions": [ { "creator": "USER", "description": "This is a longer description in the specified language.", "language": "en", "md5ContentHash": "d41d8cd98f00b204e9800998ecf8427e" } ], "enabled": true, "hotelIdentifier": "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "id": "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "items": [ { "addOnIdentifiers": [ "880e8400-e29b-41d4-a716-446655440333" ], "blackoutDates": [ { "effectiveDate": "2026-04-13", "expireDate": "2026-04-15" } ], "cityRateQualifiers": [ { "city": { "countryCode": "TH", "geoNameId": "1609350", "latitude": 13.7563, "longitude": 100.5018, "name": "Bangkok" } } ], "continentRateQualifiers": [ { "continent": "NA" } ], "countryRateQualifiers": [ { "country": { "continentCode": "AS", "geoNameId": "1609350", "isoAlpha2": "TH", "isoAlpha3": "THA", "name": "Thailand" } } ], "createdDate": "2026-01-14T09:30:00", "descriptions": [ { "creator": "USER", "description": "This is a longer description in the specified language.", "language": "en", "md5ContentHash": "d41d8cd98f00b204e9800998ecf8427e" } ], "enabled": true, "geoLocationRateQualifiers": [ { "latitude": 13.7563, "longitude": 100.5018, "radiusInKilometers": 50 } ], "hotelIdentifier": "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "id": "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "ipRangeRateQualifiers": [ { "endIPRange": "192.168.1.255", "startIPRange": "192.168.1.0" } ], "lastUpdate": "2026-02-03T16:45:12", "masterRateIdentifiers": [ "770e8400-e29b-41d4-a716-446655440222" ], "name": "Early bird", "pricingType": "PER_PERSON_PER_NIGHT", "promotionRateQualifiers": [ { "promotion": "EARLYBIRD2026" } ], "ratePlanIdentifiers": [ "990e8400-e29b-41d4-a716-446655440444" ], "sellDateRateQualifiers": [ { "effectiveDate": "2026-05-01", "expireDate": "2026-08-31" } ], "stayDateRateQualifiers": [ { "effectiveDate": "2026-06-01", "expireDate": "2026-08-31" } ], "timezoneRateQualifiers": [ { "timezone": "Asia/Bangkok" } ], "type": "DISCOUNT", "version": 3 } ], "lastUpdate": "2026-02-03T16:45:12", "name": "Early bird - Long Term", "pricingType": "PER_NIGHT", "type": "DISCOUNT", "version": 3 } ], "rateModifiers": [ { "addOnIdentifiers": [ "880e8400-e29b-41d4-a716-446655440333" ], "blackoutDates": [ { "effectiveDate": "2026-04-13", "expireDate": "2026-04-15" } ], "cityRateQualifiers": [ { "city": { "countryCode": "TH", "geoNameId": "1609350", "latitude": 13.7563, "longitude": 100.5018, "name": "Bangkok" } } ], "continentRateQualifiers": [ { "continent": "NA" } ], "countryRateQualifiers": [ { "country": { "continentCode": "AS", "geoNameId": "1609350", "isoAlpha2": "TH", "isoAlpha3": "THA", "name": "Thailand" } } ], "createdDate": "2026-01-14T09:30:00", "descriptions": [ { "creator": "USER", "description": "This is a longer description in the specified language.", "language": "en", "md5ContentHash": "d41d8cd98f00b204e9800998ecf8427e" } ], "enabled": true, "geoLocationRateQualifiers": [ { "latitude": 13.7563, "longitude": 100.5018, "radiusInKilometers": 50 } ], "hotelIdentifier": "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "id": "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "ipRangeRateQualifiers": [ { "endIPRange": "192.168.1.255", "startIPRange": "192.168.1.0" } ], "lastUpdate": "2026-02-03T16:45:12", "masterRateIdentifiers": [ "770e8400-e29b-41d4-a716-446655440222" ], "name": "Early bird", "pricingType": "PER_PERSON_PER_NIGHT", "promotionRateQualifiers": [ { "promotion": "EARLYBIRD2026" } ], "ratePlanIdentifiers": [ "990e8400-e29b-41d4-a716-446655440444" ], "sellDateRateQualifiers": [ { "effectiveDate": "2026-05-01", "expireDate": "2026-08-31" } ], "stayDateRateQualifiers": [ { "effectiveDate": "2026-06-01", "expireDate": "2026-08-31" } ], "timezoneRateQualifiers": [ { "timezone": "Asia/Bangkok" } ], "type": "DISCOUNT", "version": 3 } ], "selfAcquires": false, "subType": "DIRECT", "supplierIdentifier": "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "supplierName": "The Siam Residences, Bangkok", "version": 3 } }]Bad Request — missing or invalid request parameter or body
object
object
Example generated
{ "detail": "example", "instance": "https://example.com", "properties": { "additionalProperty": "example" }, "status": 1, "title": "example", "type": "https://example.com"}Unauthorized — authentication is required or the session has expired
object
object
Example generated
{ "detail": "example", "instance": "https://example.com", "properties": { "additionalProperty": "example" }, "status": 1, "title": "example", "type": "https://example.com"}Forbidden — authenticated but lacking the required permission or scope
object
object
Example generated
{ "detail": "example", "instance": "https://example.com", "properties": { "additionalProperty": "example" }, "status": 1, "title": "example", "type": "https://example.com"}Not Found — the requested resource does not exist
object
object
Example generated
{ "detail": "example", "instance": "https://example.com", "properties": { "additionalProperty": "example" }, "status": 1, "title": "example", "type": "https://example.com"}Method Not Allowed — the HTTP verb is not supported on this endpoint
object
object
Example generated
{ "detail": "example", "instance": "https://example.com", "properties": { "additionalProperty": "example" }, "status": 1, "title": "example", "type": "https://example.com"}Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version
object
object
Example generated
{ "detail": "example", "instance": "https://example.com", "properties": { "additionalProperty": "example" }, "status": 1, "title": "example", "type": "https://example.com"}Unsupported Media Type — use application/json
object
object
Example generated
{ "detail": "example", "instance": "https://example.com", "properties": { "additionalProperty": "example" }, "status": 1, "title": "example", "type": "https://example.com"}Internal Server Error — an unexpected failure occurred on the server
object
object
Example generated
{ "detail": "example", "instance": "https://example.com", "properties": { "additionalProperty": "example" }, "status": 1, "title": "example", "type": "https://example.com"}Service Unavailable — a downstream dependency is unreachable
object
object
Example generated
{ "detail": "example", "instance": "https://example.com", "properties": { "additionalProperty": "example" }, "status": 1, "title": "example", "type": "https://example.com"}