Get master rate
const url = 'https://api.wink.travel/api/managing-entity/d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69/extranet/master-rate/5e8a3b7c-0d4f-4a2b-8c1d-9e6f2a0b4c73';const options = { method: 'GET', headers: {'Wink-Version': '2.0', Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://api.wink.travel/api/managing-entity/d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69/extranet/master-rate/5e8a3b7c-0d4f-4a2b-8c1d-9e6f2a0b4c73 \ --header 'Authorization: Bearer <token>' \ --header 'Wink-Version: 2.0'Returns a single master rate (combination of room type, rate plan, and optional perks) by its identifier for the given property. Requires INVENTORY:READ permission on the managing entity.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Property (managing entity) identifier that owns the master rate.
Example
d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69Master rate identifier to retrieve.
Example
5e8a3b7c-0d4f-4a2b-8c1d-9e6f2a0b4c73Header Parameters
Section titled “Header Parameters”Responses
Section titled “Responses”Master rate successfully retrieved.
Lightweight projection of a master rate, used by consumers outside the master-rate module.
object
Datetime this record was first created
Whether this master rate is enabled for sale across all sales channels
Property (managing entity) identifier that owns this master rate.
Unique identifier for this record.
Datetime this record was last updated
Internal name of master rate. Auto-generated by combining room type and rate plan names.
Perks (incentives) offered with this master rate to encourage bookings
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.
Rate plan details for this master rate
object
Everything included except alcohol
Everything included with alcohol
Days of the week on which guests are allowed to check in. If null, arrivals are permitted on any day.
object
Convenience property to quickly determine if this existing object has any active days enabled.
Set to true to enable Friday.
Set to true to enable Monday.
Set to true to enable Saturday.
Set to true to enable Sunday.
Set to true to enable Thursday.
Set to true to enable Tuesday.
Set to true to enable Wednesday.
Days of the week when this rate plan is available for booking. If null, the rate plan is available on all days.
object
Convenience property to quickly determine if this existing object has any active days enabled.
Set to true to enable Friday.
Set to true to enable Monday.
Set to true to enable Saturday.
Set to true to enable Sunday.
Set to true to enable Thursday.
Set to true to enable Tuesday.
Set to true to enable Wednesday.
When true, indicates breakfast is included.
When true, indicates brunch is included.
The cancellation policy that governs refunds and cancellations for this rate plan.
object
When the cancellation policy is refundable, this flag can be set and indicates there is more rules involved than just a no-questions-asked refundable.
Datetime this record was first created
Property this cancellation is associated with
Unique identifier for this record.
Datetime this record was last updated
In case the ‘Refundable cancellation charge’ is set, a different no show charge can be applied.
If the guest does not honor the non-refundable deadline rule, this charge dictates what she owes after the deadline passes.
When the cancellation policy is non-refundable, this flag can be set and indicates there is more rules involved to calculate what the guest will owe in case of a cancellation.
The non-refundable charge might can have a deadline. If that deadline passes, the guest might be charged more.
Whether this cancellation policy is refundable or not
If advanceCancellationFreeOfCharge rules is not honored, this property explains what the guest will be charged.
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
Optional overrides of the cancellation policy for specific date ranges. Allows a property to apply different cancellation terms during peak seasons, events, or special periods. Leave null for no date-specific exceptions.
object
List of cancellation policy exceptions
object
Cancellation policy details for this exception
object
Advance notice window within which a cancellation is free of charge
Fee structure applied when a guest fails to show up without cancelling
Penalty charge applied when a non-refundable booking is cancelled after the deadline
Charge applied for cancelling a non-refundable rate
Deadline before arrival after which a booking becomes non-refundable
Charge retained when a refundable booking is cancelled
Cancellation policy identifier
End date for when this cancellation policy should end overriding the default cancellation policy.
Start date for when this cancellation policy should start to override the default cancellation policy.
Datetime this record was first created
Days of the week on which guests are allowed to check out. If null, departures are permitted on any day.
object
Convenience property to quickly determine if this existing object has any active days enabled.
Set to true to enable Friday.
Set to true to enable Monday.
Set to true to enable Saturday.
Set to true to enable Sunday.
Set to true to enable Thursday.
Set to true to enable Tuesday.
Set to true to enable Wednesday.
When true, indicates dinner is included.
A pricing modifier for guests checking in early. May include a surcharge or credit. If null, no early check-in charge applies.
object
A localized amount, always non-negative. Direction (surcharge vs. discount) is determined by which field this charge is assigned to, not the sign of this value.
object
Monetary amount value
ISO 4217 currency code
A fraction between 0 and 1 (inclusive) representing a percentage of the total stay amount for an early check-in or late check-out, e.g. 0.25 for 25%. Direction (surcharge vs. discount) is determined by which field this charge is assigned to, not the sign of this value.
When the type is FIXED, fixedAmount is required. When the type is PERCENTAGE, percent is required.
Whether rate plan is active or not.
A pricing modifier applied for each additional child guest. Typically used for child discounts or family rate adjustments. If null, no extra child adjustment applies.
object
A localized amount, always non-negative. Direction (surcharge vs. discount) is determined by which field this charge is assigned to, not the sign of this value.
object
Monetary amount value
ISO 4217 currency code
A fraction between 0 and 1 (inclusive) representing a percentage of the total stay amount for an early check-in or late check-out, e.g. 0.25 for 25%. Direction (surcharge vs. discount) is determined by which field this charge is assigned to, not the sign of this value.
When the type is FIXED, fixedAmount is required. When the type is PERCENTAGE, percent is required.
A pricing modifier applied for each additional adult guest beyond the base occupancy. For example, a per-person surcharge for extra occupants. If null, no extra adult adjustment applies.
object
A localized amount, always non-negative. Direction (surcharge vs. discount) is determined by which field this charge is assigned to, not the sign of this value.
object
Monetary amount value
ISO 4217 currency code
A fraction between 0 and 1 (inclusive) representing a percentage of the total stay amount for an early check-in or late check-out, e.g. 0.25 for 25%. Direction (surcharge vs. discount) is determined by which field this charge is assigned to, not the sign of this value.
When the type is FIXED, fixedAmount is required. When the type is PERCENTAGE, percent is required.
The property (managing entity) that owns this rate plan.
Unique identifier for this record.
Datetime this record was last updated
A pricing modifier for guests staying late after standard checkout time. May include a surcharge or credit. If null, no late check-out charge applies.
object
A localized amount, always non-negative. Direction (surcharge vs. discount) is determined by which field this charge is assigned to, not the sign of this value.
object
Monetary amount value
ISO 4217 currency code
A fraction between 0 and 1 (inclusive) representing a percentage of the total stay amount for an early check-in or late check-out, e.g. 0.25 for 25%. Direction (surcharge vs. discount) is determined by which field this charge is assigned to, not the sign of this value.
When the type is FIXED, fixedAmount is required. When the type is PERCENTAGE, percent is required.
When true, guests earn loyalty points toward the property’s loyalty program with this rate plan. When false, this rate plan does not accrue points.
When true, indicates lunch is included.
Maximum number of days in advance a guest may book this rate plan. For example, 180 allows bookings up to 6 months ahead.
Maximum guest age allowed for this rate plan, typically used for family or age-restricted rates.
Maximum consecutive nights allowed for a booking under this rate plan. For example, 30 caps bookings at 30 nights.
Maximum number of guests allowed under this rate plan.
Minimum number of days in advance a guest must book this rate plan. For example, 3 requires booking at least 3 days before arrival.
Minimum guest age required to book this rate plan, typically used for senior discounts or adult-only rates.
Minimum consecutive nights required for a booking under this rate plan. For example, 2 requires a minimum 2-night stay.
Minimum number of guests required to qualify for this rate plan.
A descriptive name for this rate plan, such as ‘Best Available Rate’, ‘Non-Refundable’, or ‘Corporate Rate’.
When true, indicates if the rate is a prepaid rate.
Additional fees applied to this rate plan, such as resort facilities fees, parking fees, or cleaning charges. Fees can be charged per day, per stay, per person, or combinations thereof.
An additional fee attached to a rate plan, such as a resort facility fee, cleaning fee, or parking fee. The fee amount and how it is charged (per day, per stay, per person, etc.) are defined per fee entry.
object
Localized descriptions of this fee in multiple languages. At least one entry in English is required.
Simplified localized description containing text content and its language code.
object
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.
Days of the week on which at least one night must fall within the stay. Useful for rates requiring weekend stays or specific weekday requirements. If null, no specific day-of-week stay requirements apply.
object
Convenience property to quickly determine if this existing object has any active days enabled.
Set to true to enable Friday.
Set to true to enable Monday.
Set to true to enable Saturday.
Set to true to enable Sunday.
Set to true to enable Thursday.
Set to true to enable Tuesday.
Set to true to enable Wednesday.
The date on which this rate plan is no longer available for booking. If both sellStartDate and sellEndDate are set, the rate can only be sold within that date range.
The date on which this rate plan becomes available for booking. If both sellStartDate and sellEndDate are set, the rate can only be sold within that date range.
A pricing modifier applied when a single guest books this rate plan. For example, a 10% discount for solo travelers. If null, no single occupancy adjustment applies.
object
A localized amount, always non-negative. Direction (surcharge vs. discount) is determined by which field this charge is assigned to, not the sign of this value.
object
Monetary amount value
ISO 4217 currency code
A fraction between 0 and 1 (inclusive) representing a percentage of the total stay amount for an early check-in or late check-out, e.g. 0.25 for 25%. Direction (surcharge vs. discount) is determined by which field this charge is assigned to, not the sign of this value.
When the type is FIXED, fixedAmount is required. When the type is PERCENTAGE, percent is required.
The latest date a guest can check in to use this rate plan. If both stayStartDate and stayEndDate are set, the rate can only be used for stays within that date range.
The earliest date a guest can check in to use this rate plan. If both stayStartDate and stayEndDate are set, the rate can only be used for stays within that date range.
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
Room type details for this master rate
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
Typical one night rate during regular remand period
object
Monetary amount value
ISO 4217 currency code
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.
Typical one night rate in a distressed period
object
Monetary amount value
ISO 4217 currency code
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.
Purchasable items for this inventory.
This is one bookable item that can stand alongside a restaurant / meeting room etc.
object
Base price of booking this inventory.
object
Monetary amount value
ISO 4217 currency code
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
If you are selling this inventory at a discount, indicate the discounted selling price. Leave empty if there is no discount.
object
Monetary amount value
ISO 4217 currency code
Unique transactional identifier
Whether there is a limit to maximum group size.
Whether there is a limit to minimum group size.
List of images / videos of item.
Multimedia that contains less information than Multimedia object
object
Media angle
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
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.
Calculates the percent difference between basePrice and discountedPrice.
Calculates the percent difference between basePrice and discountedPrice.
How this inventory item should be priced.
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.
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
{ "enabled": true, "hotelIdentifier": "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "id": "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47", "name": "Premium King - Best Available Rate", "perkTypes": [ { "guaranteed": true, "id": "PERK_GUARANTEED_UPGRADE", "level": 3 } ], "ratePlan": { "identifier": "5e8a3b7c-0d4f-4a2b-8c1d-9e6f2a0b4c73", "name": "Best Available Rate" }, "roomType": { "identifier": "6f9b4c8d-1e5a-4b3c-9d2e-8a7f0c1b5e43", "name": "Premium King Room" }}Bad Request — missing or invalid request parameter or body
object
object
Example
Unauthorized — authentication is required or the session has expired
object
object
Example
Forbidden — authenticated but lacking the required permission or scope
object
object
Example
Not Found — the requested resource does not exist
object
object
Example
Method Not Allowed — the HTTP verb is not supported on this endpoint
object
object
Example
Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version
object
object
Example
Unsupported Media Type — use application/json
object
object
Example
Internal Server Error — an unexpected failure occurred on the server
object
object
Example
Service Unavailable — a downstream dependency is unreachable