By filters

Deprecated

POST

/api/public/{managingEntityIdentifier}/search/filtered

const url = 'https://api.wink.travel/api/public/d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69/search/filtered?customizationIdentifier=2c5b9e3a-7f1d-4a8c-b6e2-0d4f1a9b3c72';
const options = {
  method: 'POST',
  headers: {
    'Wink-Version': '2.0',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: '{"filters":{"aggregateReviewRating":8,"architecturalStyles":7,"cities":["1609350"],"continents":["AS"],"countries":["1605651"],"hotelCategories":1,"hotelStars":5,"inventoryName":"Deluxe Suite","inventoryTypes":["GUEST_ROOM"],"locationCategories":1701,"name":"Bangkok Luxury Hotels","primaryOrderBy":"4","propertyName":"The Siam","radiusInMeters":5000,"segmentCategories":7,"showChildFriendly":false,"showDirectOnly":false,"showEcoFriendly":false,"showPetFriendly":false,"showPopular":false},"page":0,"size":10,"userSession":{"currency":"USD","itinerary":{"children":4,"endDate":"2026-07-18","guests":4,"hours":72,"items":[{"adults":2,"children":[{"age":7,"quantity":2}],"quantity":2}],"nights":3,"room":{"adults":2,"children":[{"age":7,"quantity":2}],"quantity":2},"rooms":2,"startDate":"2026-07-15"},"language":"en","lifestyle":"LIFESTYLE_RELAX","promotionalCodes":["SUMMER2026"],"selectedRoomConfigurationIndex":0}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url 'https://api.wink.travel/api/public/d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69/search/filtered?customizationIdentifier=2c5b9e3a-7f1d-4a8c-b6e2-0d4f1a9b3c72' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Wink-Version: 2.0' \
  --data '{ "filters": { "aggregateReviewRating": 8, "architecturalStyles": 7, "cities": [ "1609350" ], "continents": [ "AS" ], "countries": [ "1605651" ], "hotelCategories": 1, "hotelStars": 5, "inventoryName": "Deluxe Suite", "inventoryTypes": [ "GUEST_ROOM" ], "locationCategories": 1701, "name": "Bangkok Luxury Hotels", "primaryOrderBy": "4", "propertyName": "The Siam", "radiusInMeters": 5000, "segmentCategories": 7, "showChildFriendly": false, "showDirectOnly": false, "showEcoFriendly": false, "showPetFriendly": false, "showPopular": false }, "page": 0, "size": 10, "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 a page of properties with best prices matching the same filters a saved search stores: region, categories, amenities, stars, review rating, property name, or a point with a radius. filters.showDirectOnly limits results to properties you hold a direct sales channel with.

Authorizations

oauth2ClientCredentials

Parameters

Path Parameters

managingEntityIdentifier

required

string

Managing entity identifier

Example

d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69

Query Parameters

customizationIdentifier

string

Booking engine customization identifier; when omitted the managing entity’s default configuration is used

Example

2c5b9e3a-7f1d-4a8c-b6e2-0d4f1a9b3c72

Header Parameters

Wink-Version

string

default: 2.0.0

Allowed values: 2.0

Request Body^required

The filters, the user session and the page to return

application/json

Search by the filters a dynamic list stores: properties matching them, priced for the user session

object

filters

required

Region, category, amenity, star, review and property-name filters, or a point with a radius. showDirectOnly limits results to properties you hold a direct sales channel with. propertyName is a literal, case-insensitive part of the property name, not a regular expression. name (the list’s own name), inventoryTypes, inventoryName and the order-by fields are ignored: search returns properties by their rooms.

object

aggregateReviewRating

Filter on aggregate review score the hotel has

integer format: int32

Example

architecturalStyles

Supported OTA specification ARC code. See OTA geoname data

Array<string>

Example

cities

City filter

Array<string>

continents

Continent filter

Array<string>

countries

Country filter

Array<string>

hotelCategories

Supported OTA specification PCT code. See OTA geoname data

Array<string>

Example

hotelStars

Filter on number of stars the hotel has.

integer format: int32

Example

inventoryName

Regex expression filter matching on inventory name

string

Example

Deluxe Suite

inventoryTypes

Filter on inventory types

Array<string>

Allowed values: GUEST_ROOM ADD_ON MEETING_ROOM RESTAURANT SPA ATTRACTION PLACE ACTIVITY

lifestyles

Filter on lifestyles

Array<string>

Allowed values: LIFESTYLE_HEALTH_FITNESS LIFESTYLE_RELAX LIFESTYLE_ADULT_ONLY LIFESTYLE_ADVENTURE LIFESTYLE_BUSINESS LIFESTYLE_LGBT LIFESTYLE_SINGLE_PARENT LIFESTYLE_SOLO_FEMALE LIFESTYLE_BEAUTY LIFESTYLE_FOODIE LIFESTYLE_FAMILY LIFESTYLE_ROMANCE LIFESTYLE_COUPLE LIFESTYLE_SOLO LIFESTYLE_BACKPACKER LIFESTYLE_SHOPPING LIFESTYLE_SPORTS LIFESTYLE_MOUNTAIN LIFESTYLE_BEACH LIFESTYLE_CITY LIFESTYLE_COUNTRY LIFESTYLE_CULTURE LIFESTYLE_ECO

locationCategories

Supported OTA specification LOC code. See OTA geoname data

Array<string>

Example

name

Name of dynamic list for when user want to persist it

string

Example

Bangkok Luxury Hotels

nearPoint

Find hotels close to certain location

object

coordinates

Array<number>

type

string

number format: double

primaryOrderBy

Control how you want the search results sorted. Options are:

1: Inventory name
2: Price: High to low
3: Price: Low to high
4: Commission: High to low
5: Commission: Low to high
6: Discount: High to low
7: Discount: Low to high

string

Example

propertyName

A literal, case-insensitive part of the property name, not a regular expression: The Siam matches The Siam Guest House.

string

Example

The Siam

radiusInMeters

Use this in conjunction with nearPoint. Control the distance from point we are searching for.

integer format: int64

Example

segmentCategories

Supported OTA specification SEG code. See OTA geoname data

Array<string>

false

Example

{
  "aggregateReviewRating": 8,
  "architecturalStyles": 7,
  "cities": [
    "1609350"
  ],
  "continents": [
    "AS"
  ],
  "countries": [
    "1605651"
  ],
  "hotelCategories": 1,
  "hotelStars": 5,
  "inventoryName": "Deluxe Suite",
  "inventoryTypes": [
    "GUEST_ROOM"
  ],
  "locationCategories": 1701,
  "name": "Bangkok Luxury Hotels",
  "primaryOrderBy": "4",
  "propertyName": "The Siam",
  "radiusInMeters": 5000,
  "segmentCategories": 7,
  "showChildFriendly": false,
  "showDirectOnly": false,
  "showEcoFriendly": false,
  "showPetFriendly": false,
  "showPopular": false
}

page

required

The page to paginate to. Note: Page uses a 0-based index.

integer format: int32

Example

size

required

The result size to return.

integer format: int32

default: 6 >= 1 <= 20

Example

userSession

required

User session is the current search state. SimpleDateTimeItinerary and other data points are all included here.

object

currency

User’s currency preference (ISO 4217 code)

string

Example

USD

itinerary

required

Dates and travel info.

object

children

Total number of children across all rooms

integer format: int32

Example

endDate

Check-out date (alternative to nights; nights takes precedence if both provided)

string format: date

Example

2026-07-18

guests

Total number of adult guests across all rooms

integer format: int32

Example

hours

Duration in hours (rounded up) between check-in and check-out. Used for hourly bookings; e.g., meeting rooms or day-use venues.

integer format: int64

Example

items

DEPRECATED 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.

Array<object>

Room occupancy and guest composition for a single or multiple identical rooms

object

adults

required

Number of adult guests in this room type

integer format: int32

default: 1 >= 1

Example

children

Child guests in this room, with age groups

Array<object>

Child guest with age and quantity in a room configuration

object

age

required

Age of each child in this group (years)

integer format: int32

Example

quantity

required

Count of children of this age group in the room

integer format: int32

>= 1

Example

{
  "age": 7,
  "quantity": 2
}

quantity

Number of identical rooms with this configuration

integer format: int32

default: 1 >= 1

Example

{
  "adults": 2,
  "children": [
    {
      "age": 7,
      "quantity": 2
    }
  ],
  "quantity": 2
}

nights

Number of nights for the stay (alternative to endDate; takes precedence if both provided)

integer format: int32

Example

room

The room configuration being booked, and how many identical rooms of it

object

adults

required

Number of adult guests in this room type

integer format: int32

default: 1 >= 1

Example

children

Child guests in this room, with age groups

Array<object>

Child guest with age and quantity in a room configuration

object

age

required

Age of each child in this group (years)

integer format: int32

Example

quantity

required

Count of children of this age group in the room

integer format: int32

>= 1

Example

{
  "age": 7,
  "quantity": 2
}

quantity

Number of identical rooms with this configuration

integer format: int32

default: 1 >= 1

Example

{
  "adults": 2,
  "children": [
    {
      "age": 7,
      "quantity": 2
    }
  ],
  "quantity": 2
}

rooms

Total number of rooms in this itinerary

integer format: int32

Example

startDate

required

Check-in date (must be today or in the future)

string format: date

Example

2026-07-15

Example

{
  "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

User’s language preference (ISO 639-1 code)

string

Example

en

lifestyle

Preferred lifestyle category to filter accommodations

string

Example

LIFESTYLE_RELAX

promotionalCodes

Array<string>

selectedRoomConfigurationIndex

Index of the currently selected room configuration for rate retrieval

integer format: int32

Example

{
  "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

{
  "filters": {
    "aggregateReviewRating": 8,
    "architecturalStyles": 7,
    "cities": [
      "1609350"
    ],
    "continents": [
      "AS"
    ],
    "countries": [
      "1605651"
    ],
    "hotelCategories": 1,
    "hotelStars": 5,
    "inventoryName": "Deluxe Suite",
    "inventoryTypes": [
      "GUEST_ROOM"
    ],
    "locationCategories": 1701,
    "name": "Bangkok Luxury Hotels",
    "primaryOrderBy": "4",
    "propertyName": "The Siam",
    "radiusInMeters": 5000,
    "segmentCategories": 7,
    "showChildFriendly": false,
    "showDirectOnly": false,
    "showEcoFriendly": false,
    "showPetFriendly": false,
    "showPopular": false
  },
  "page": 0,
  "size": 10,
  "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

200

application/json

Owned pagination envelope: a page of content plus flat page metadata.

object

content

The elements on this page.

Array<object>

object

available

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.

boolean

distanceInMeters

Distance in metres from the searched point, when the query was a near-point search.

number format: double

hotel

required

Property details

object

activities

Number of activites property has listed on its profile.

integer format: int32

addOns

Number of add-ons property has on its profile.

integer format: int32

address

Property address.

object

address1

Address line 1

string

address2

Address line 2

string

city

City name

string

country

Country

string

countryCode

Country

string

/^[A-Z]{2}$/

county

County

string

fullAddress

Address 1, Address 2, City, State, Postal / Zip code, Country

string

postalCode

Postal / zip code

string

state

State

string

aggregateGreendexRating

Aggregate Green Index score if the property has answered our questionnaire available in the Extranet.

number format: float

default: 0.0

aggregateReviewRating

Aggregate score based on all current user reviews.

number format: float

default: 0.0

architecturalStyle

Supported OTA specification ARC code. See OTA geoname data

string

attractions

Number of attractions property has listed on its profile.

integer format: int32

available

Whether property is available

boolean

bookings

Number of bookings for this property on the wink.travel platform.

integer format: int64

brand

Name of hotel brand

string

chain

Name of hotel chain if applicable.

string

city

City location

object

asciiName

Ascii name of city

string

country

Country

object

capital

Country capital

string

continent

Continent code

string

currencyCode

Currency code

string

/^[A-Z]{3}$/

currencyName

Currency name

string

geoNameId

Country GeoNames identifier

string

iso

ISO code

string

name

Country name

string

countryCode

ISO 3166-1 alpha-2 country code for the country this location belongs to

string

/^[A-Z]{2}$/

featureCode

GeoNames specific feature code identifying the place type (e.g. PPL=populated place, PPLC=national capital, ISL=island)

string

geoNameId

GeoName identifier

string

location

Coordinate points of the city

object

coordinates

Array<number>

type

string

number format: double

name

Name of city

string

subCountry

Country sub division

object

asciiName

Sub-country ascii name

string

geoNameId

Sub-country GeoNames identifier

string

name

Sub-country name

string

subSubCountry

Country sub sub division

object

asciiName

ASCII-transliterated name of the county or district, safe for URLs and sorting

string

geoNameId

GeoNames.org unique identifier for this subdivision

string

name

Official name of the county or district in its local script

string

timezone

IANA timezone identifier for the location

string

type

GeoNameLightweight type

string

Allowed values: CITY ISLAND OTHER

urlName

Url name

string

/^[a-z0-9][a-z0-9-]*[a-z0-9]$/

currencyCode

Currency code for property.

string

/^[A-Z]{3}$/

descriptions

Short and long welcome text

Array<object>

Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.

object

description

required

Longer text description

string

>= 1 characters <= 2147483647 characters

language

required

Indicate which language this description is written in.

string

default: en >= 2 characters <= 2 characters /^[a-z]{2}(-[A-Z]{2})?$/

name

required

Use as title or short text description

string

generalManager

General manager of the property.

object

descriptions

Localized welcome message from GM.

Array<object>

Simplified localized description containing text content and its language code.

object

description

required

Longer text description

string

>= 1 characters <= 2147483647 characters

language

required

Indicate which language this description is written in.

string

default: en >= 2 characters <= 2 characters /^[a-z]{2}(-[A-Z]{2})?$/

image

Profile image of the general manager.

object

attribution

Whether image has attribution properties

Array<object>

object

name

required

Name of contributor

string

>= 1 characters

url

URL to contributor

string format: uri

category

Supported OTA specification PIC code. See OTA geoname data

string

descriptions

Localized media captions to give user some context about where this media was taken.

Array<object>

Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.

object

description

required

Longer text description

string

>= 1 characters <= 2147483647 characters

language

required

Indicate which language this description is written in.

string

default: en >= 2 characters <= 2 characters /^[a-z]{2}(-[A-Z]{2})?$/

name

required

Use as title or short text description

string

entityId

required

Cloudinary public id; build your own delivery URLs from it

string

height

required

Media height in pixels.

integer format: int32

>= 1

identifier

required

Deprecated, use entityId. Same value; will be removed.

string

>= 1 characters

lifestyleType

Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.

string

sort

required

Sort allows you to control how you want to sort this record in a list of media records.

integer format: int32

default: 999

source

required

Currently ONLY using Cloudinary to store all image / video assets.

string

default: CLOUDINARY

Allowed values: YOUTUBE CLOUDINARY

type

required

Whether Cloudinary media is a VIDEO or IMAGE.

string

Allowed values: IMAGE VIDEO AUDIO RAW

urls

Ready-to-use delivery URLs. Absent when no URL applies to this asset.

object

external

Watch URL for media hosted outside our CDN (for example YouTube).

string

large

Image scaled to at most 1920px wide.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

medium

Image scaled to at most 1024px wide.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

original

Full-size image, not resized.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

poster

Still frame to show before the video plays.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

preview

Short low-bandwidth video preview.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

stream

Video stream at full size.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

thumbnail

Small still, at most 320px wide. For videos this is a frame of the video.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

width

required

Media width in pixels.

integer format: int32

>= 1

name

required

Name of GM currently managing the property.

string

hotelAmenityCodes

Supported OTA specification HAC code. See OTA geoname data

Array<string>

hotelCategory

Supported OTA specification PCT code. See OTA geoname data

string

hotelIdentifier

Unique hotel record identifier.

string format: uuid

images

Property images.

Array<object>

An image or video of a property or one of its facilities, with ready-to-use delivery URLs.

object

attribution

Whether image has attribution properties

Array<object>

object

name

required

Name of contributor

string

>= 1 characters

url

URL to contributor

string format: uri

category

Supported OTA specification PIC code. See OTA geoname data

string

descriptions

Localized media captions to give user some context about where this media was taken.

Array<object>

Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.

object

description

required

Longer text description

string

>= 1 characters <= 2147483647 characters

language

required

Indicate which language this description is written in.

string

default: en >= 2 characters <= 2 characters /^[a-z]{2}(-[A-Z]{2})?$/

name

required

Use as title or short text description

string

entityId

required

Cloudinary public id; build your own delivery URLs from it

string

height

required

Media height in pixels.

integer format: int32

>= 1

identifier

required

Deprecated, use entityId. Same value; will be removed.

string

>= 1 characters

lifestyleType

Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.

string

sort

required

Sort allows you to control how you want to sort this record in a list of media records.

integer format: int32

default: 999

source

required

Currently ONLY using Cloudinary to store all image / video assets.

string

default: CLOUDINARY

Allowed values: YOUTUBE CLOUDINARY

type

required

Whether Cloudinary media is a VIDEO or IMAGE.

string

Allowed values: IMAGE VIDEO AUDIO RAW

urls

Ready-to-use delivery URLs. Absent when no URL applies to this asset.

object

external

Watch URL for media hosted outside our CDN (for example YouTube).

string

large

Image scaled to at most 1920px wide.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

medium

Image scaled to at most 1024px wide.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

original

Full-size image, not resized.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

poster

Still frame to show before the video plays.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

preview

Short low-bandwidth video preview.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

stream

Video stream at full size.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

thumbnail

Small still, at most 320px wide. For videos this is a frame of the video.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

width

required

Media width in pixels.

integer format: int32

>= 1

lastUpdate

Timestamp of the last update to this property aggregate record.

string format: date-time

lifestyleTypes

Array<string>

localName

Hotel local name if different from the trade name or if it is the local language.

string

location

Geo-location

object

coordinates

Array<number>

type

string

number format: double

locationCategory

Supported OTA specification LOC code. See OTA geoname data

string

meetingRooms

Number of meeting rooms property has on its profile.

integer format: int32

name

Hotel trade name

string

numberOfRooms

Number of rooms / keys for this property.

integer format: int32

places

Number of places property has listed on its profile.

integer format: int32

policy

Basic property policy record.

object

checkInTime

required

When the guest can check in, hotel-local time as 24-hour HH:mm, 00:00 to 23:59.

string

>= 1 characters /^([01][0-9]|2[0-3]):[0-5][0-9]$/

checkOutTime

required

When the guest has to check out, hotel-local time as 24-hour HH:mm, 00:00 to 23:59.

string

>= 1 characters /^([01][0-9]|2[0-3]):[0-5][0-9]$/

childrenAllowed

required

Indicates whether property allows children

boolean

childrenMinimumAge

When a property allows children, it can also indicate what the minimum age is for children to be allowed.

integer format: int32

internetAvailability

required

Indicates the availability of internet on the property.

string

Allowed values: YES NO YES_PAID

internetConnectionLocation

Indicates where internet is available in and around the property.

string

Allowed values: ENTIRE_PROPERTY PUBLIC_AREAS ALL_ROOMS SOME_ROOMS BUSINESS_CENTER

internetConnectionType

Indicates how guests can access the Internet on the property.

string

Allowed values: WIFI CABLE

parkingAccess

Indicates what type of parking is available at the property.

string

Allowed values: PRIVATE PUBLIC

parkingAvailability

required

Indicates whether parking is available at the property.

string

Allowed values: YES NO YES_PAID

petCharge

If pets are allowed, property can tell travelers if there is a charge applicable for the pet.

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

petMaxWeightInKilos

If pets are allowed, property can further limit on weight.

integer format: int32

petsAllowed

required

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.

boolean

propertyAccessibilityCodes

Supported OTA specification PHY code. See OTA geoname data

Array<string>

propertySecurityCodes

Supported OTA specification SEC code. See OTA geoname data

Array<string>

reservations

Contact details for reservations desk

object

email

Contact E-mail

string format: email

firstName

Contact first name

string

fullName

First and last name

string

lastName

Contact last name

string

phoneNumber

Contact phone number

string

/^\+?[1-9]\d{1,14}$/

secondaryEmail

Contact secondary Email

string format: email

summary

Summary

string

restaurants

Number of restaurants property has on its profile.

integer format: int32

score

Demand score (0-100) derived from booking volume and review rating. Recomputed monthly; used to rank properties in search results.

integer format: int32

segmentCategory

Supported OTA specification SEG code. See OTA geoname data

string

socials

Property’s social network accounts

Array<object>

Social network

object

location

URL or social network identifier to social network profile

string

type

Type of social network.

string

Allowed values: FACEBOOK INSTAGRAM SKYPE TRIP_ADVISOR TWITTER GOOGLE_PLUS WHATSAPP LINE WECHAT VIBER SNAPCHAT WEIBO RENREN WEBSITE QQ TIKTOK

spas

Number of spas property has on its profile.

integer format: int32

starRating

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.

integer format: int32

<= 6

thirdPartyReviews

Array of awards and third party reviews given to property by certified / non-certified providers.

Array<object>

Recognition for the ancillary blocking.

object

category

required

Recognition category.

string

Allowed values: THIRD_PARTY_REVIEW PUBLICATION AWARD

date

The date the award was received

string format: date

identifier

required

Recognition identifier.

string format: uuid

>= 1 characters

maxRating

required

Use this to let hotels indicate what the total score for this award is.

number format: float

officialAppointmentInd

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.

boolean

provider

required

The name of the entity that administers this recognition.

string

>= 1 characters

rating

required

The actual award or rating received by the hotel facility.

number format: float

ratingSymbol

Provides the symbol used in the rating. Used in conjunction with the Rating.

string

type

required

Type of rating system the recognition operated on. This allows us to display the score properly.

string

Allowed values: STAR_RATING NUMERIC_RATING PERCENT_RATING

totalReviews

Count of total reviews left by users at this property.

integer format: int32

uniqueId

required

Event shorter name

string

>= 1 characters

urlName

Unique URL-friendly name slug of hotel

string

/^[a-z0-9][a-z0-9-]*[a-z0-9]$/

videos

Property videos.

Array<object>

An image or video of a property or one of its facilities, with ready-to-use delivery URLs.

object

attribution

Whether image has attribution properties

Array<object>

object

name

required

Name of contributor

string

>= 1 characters

url

URL to contributor

string format: uri

category

Supported OTA specification PIC code. See OTA geoname data

string

descriptions

Localized media captions to give user some context about where this media was taken.

Array<object>

Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.

object

description

required

Longer text description

string

>= 1 characters <= 2147483647 characters

language

required

Indicate which language this description is written in.

string

default: en >= 2 characters <= 2 characters /^[a-z]{2}(-[A-Z]{2})?$/

name

required

Use as title or short text description

string

entityId

required

Cloudinary public id; build your own delivery URLs from it

string

height

required

Media height in pixels.

integer format: int32

>= 1

identifier

required

Deprecated, use entityId. Same value; will be removed.

string

>= 1 characters

lifestyleType

Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.

string

sort

required

Sort allows you to control how you want to sort this record in a list of media records.

integer format: int32

default: 999

source

required

Currently ONLY using Cloudinary to store all image / video assets.

string

default: CLOUDINARY

Allowed values: YOUTUBE CLOUDINARY

type

required

Whether Cloudinary media is a VIDEO or IMAGE.

string

Allowed values: IMAGE VIDEO AUDIO RAW

urls

Ready-to-use delivery URLs. Absent when no URL applies to this asset.

object

external

Watch URL for media hosted outside our CDN (for example YouTube).

string

large

Image scaled to at most 1920px wide.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

medium

Image scaled to at most 1024px wide.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

original

Full-size image, not resized.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

poster

Still frame to show before the video plays.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

preview

Short low-bandwidth video preview.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

stream

Video stream at full size.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

thumbnail

Small still, at most 320px wide. For videos this is a frame of the video.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

width

required

Media width in pixels.

integer format: int32

>= 1

whenBuilt

Year the property was constructed.

string

lowestPrice

required

Best-priced room at property

object

available

required

Whether this room type is available with this configuration

boolean

perkValue

required

The sum of all perks the master rate had made available.

integer format: int32

price

required

Price details for this room type configuration.

object

activeCancellationPolicy

required

The active / selected cancellation policy for this room configuration

object

advanceCancellationFreeOfCharge

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.

string

Allowed values: UNTIL_EIGHTEEN_HUNDRED_HOURS_ON_DAY_OF_ARRIVAL UNTIL_FOURTEEN_HUNDRED_HOURS_ON_DAY_OF_ARRIVAL ONE_DAY_BEFORE_ARRIVAL TWO_DAYS_BEFORE_ARRIVAL THREE_DAYS_BEFORE_ARRIVAL FIVE_DAYS_BEFORE_ARRIVAL SEVEN_DAYS_BEFORE_ARRIVAL FOURTEEN_DAYS_BEFORE_ARRIVAL TWENTYONE_DAYS_BEFORE_ARRIVAL THIRTY_DAYS_BEFORE_ARRIVAL FOURTY_TWO_DAYS_BEFORE_ARRIVAL SIXTY_DAYS_BEFORE_ARRIVAL

createdDate

Datetime this record was first created

string | null format: date-time

hotelIdentifier

required

Property this cancellation is associated with

string format: uuid

required

Unique identifier for this record.

string format: uuid

lastUpdate

Datetime this record was last updated

string | null format: date-time

noShowCharge

In case the ‘Refundable cancellation charge’ is set, a different no show charge can be applied.

string

Allowed values: SAME_AS_CANCELLATION_FEE ONE_HUNDRED_PERCENT_OF_TOTAL_CHARGE

nonRefundableAfterDeadlineCancellationCharge

If the guest does not honor the non-refundable deadline rule, this charge dictates what she owes after the deadline passes.

string

Allowed values: FIRST_NIGHT TEN_PERCENT THIRTY_PERCENT FIFTY_PERCENT SEVENTY_PERCENT ONE_HUNDRED_PERCENT

nonRefundableCancellationCharge

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.

string

Allowed values: FIRST_NIGHT TEN_PERCENT THIRTY_PERCENT FIFTY_PERCENT SEVENTY_PERCENT

nonRefundableDeadline

The non-refundable charge might can have a deadline. If that deadline passes, the guest might be charged more.

string

Allowed values: ONE_DAY_BEFORE_ARRIVAL TWO_DAYS_BEFORE_ARRIVAL THREE_DAYS_BEFORE_ARRIVAL FIVE_DAYS_BEFORE_ARRIVAL SEVEN_DAYS_BEFORE_ARRIVAL FOURTEEN_DAYS_BEFORE_ARRIVAL TWENTYONE_DAYS_BEFORE_ARRIVAL THIRTY_DAYS_BEFORE_ARRIVAL FOURTY_TWO_DAYS_BEFORE_ARRIVAL SIXTY_DAYS_BEFORE_ARRIVAL

policyCode

string

refundable

required

Whether this cancellation policy is refundable or not

boolean

refundableCancellationCharge

If advanceCancellationFreeOfCharge rules is not honored, this property explains what the guest will be charged.

string

Allowed values: FIRST_NIGHT THIRTY_PERCENT FIFTY_PERCENT SIXTY_PERCENT SEVENTY_PERCENT NINETY_PERCENT ONE_HUNDRED_PERCENT

version

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.

integer | null format: int64

addOnOffers

Array<object>

Add-ons that are available with this room configuration

object

addOn

required

The original add-on record created by the property.

object

active

required

Modify add-on availability with this flag.

boolean

default: true

applicableEnd

End month and day or date for which the add-on is available (seasonal availability).

string format: date

applicableStart

Start month and day or date for which the add-on is available (seasonal availability).

string format: date

basePrice

Base price of booking this add-on.

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

category

Level 1 taxonomy: property-level (ADD_ON) or a specific venue type. Null is treated as ADD_ON.

string | null

Allowed values: GUEST_ROOM ADD_ON MEETING_ROOM RESTAURANT SPA ATTRACTION PLACE ACTIVITY

categoryItemIds

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.

Array<string> | null

closes

Closing time of the add-on (if applicable). Leave empty if always available.

string

commissionable

required

Indicate whether sales channels receive commission for selling this add-on.

boolean

default: true

createdDate

Datetime this record was first created

string | null format: date-time

dateRanges

Optional list of date ranges restricting add-on availability to specific periods. Empty means available on every date.

Array<object>

object

endDate

required

Retrieve data range ending with and including this end date

string format: date

startDate

required

Retrieve data range starting with and including this start date

string format: date

daysOfWeek

Indicates which days this add-on is open.

object

disabled

Convenience property to quickly determine if this existing object has any active days enabled.

boolean

fri

Set to true to enable Friday.

boolean

mon

Set to true to enable Monday.

boolean

sat

Set to true to enable Saturday.

boolean

sun

Set to true to enable Sunday.

boolean

thu

Set to true to enable Thursday.

boolean

tue

Set to true to enable Tuesday.

boolean

wed

Set to true to enable Wednesday.

boolean

descriptions

Localized descriptions describing this add-on.

Array<object>

Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.

object

description

required

Longer text description

string

>= 1 characters <= 2147483647 characters

language

required

Indicate which language this description is written in.

string

default: en >= 2 characters <= 2 characters /^[a-z]{2}(-[A-Z]{2})?$/

name

required

Use as title or short text description

string

discountedPrice

If this add-on is sold at a discount, the discounted selling price.

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

featuredInd

required

Indicates whether this add-on is featured.

boolean

hotelIdentifier

required

Hotel identifier.

string format: uuid

>= 1 characters

required

Unique identifier for this record.

string format: uuid

>= 1 characters

lastUpdate

Datetime this record was last updated

string | null format: date-time

mandatory

required

Make this add-on mandatory for all guests by enabling this flag.

boolean

maxPax

Maximum group size this add-on can be booked for.

integer format: int32

minPax

Minimum group size this add-on can be booked for.

integer format: int32

multimedias

List of images / videos of this add-on.

Array<object>

An image or video of a property or one of its facilities, with ready-to-use delivery URLs.

object

attribution

Whether image has attribution properties

Array<object>

object

name

required

Name of contributor

string

>= 1 characters

url

URL to contributor

string format: uri

category

Supported OTA specification PIC code. See OTA geoname data

string

descriptions

Localized media captions to give user some context about where this media was taken.

Array<object>

Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.

object

description

required

Longer text description

string

>= 1 characters <= 2147483647 characters

language

required

Indicate which language this description is written in.

string

default: en >= 2 characters <= 2 characters /^[a-z]{2}(-[A-Z]{2})?$/

name

required

Use as title or short text description

string

entityId

required

Cloudinary public id; build your own delivery URLs from it

string

height

required

Media height in pixels.

integer format: int32

>= 1

identifier

required

Deprecated, use entityId. Same value; will be removed.

string

>= 1 characters

lifestyleType

Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.

string

sort

required

Sort allows you to control how you want to sort this record in a list of media records.

integer format: int32

default: 999

source

required

Currently ONLY using Cloudinary to store all image / video assets.

string

default: CLOUDINARY

Allowed values: YOUTUBE CLOUDINARY

type

required

Whether Cloudinary media is a VIDEO or IMAGE.

string

Allowed values: IMAGE VIDEO AUDIO RAW

urls

Ready-to-use delivery URLs. Absent when no URL applies to this asset.

object

external

Watch URL for media hosted outside our CDN (for example YouTube).

string

large

Image scaled to at most 1920px wide.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

medium

Image scaled to at most 1024px wide.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

original

Full-size image, not resized.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

poster

Still frame to show before the video plays.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

preview

Short low-bandwidth video preview.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

stream

Video stream at full size.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

thumbnail

Small still, at most 320px wide. For videos this is a frame of the video.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

width

required

Media width in pixels.

integer format: int32

>= 1

name

required

Internal name of the add-on.

string

>= 1 characters

opens

Opening time of the add-on (if applicable). Leave empty if always available.

string

pricingType

How this add-on should be priced.

string

Allowed values: PER_STAY PER_DAY PER_NIGHT PER_USE PER_HOUR PER_PERSON PER_PERSON_PER_NIGHT PER_PERSON_PER_HOUR PER_ADULT PER_ADULT_PER_NIGHT PER_ADULT_PER_HOUR PER_CHILD PER_CHILD_PER_NIGHT PER_CHILD_PER_HOUR

publishStatus

Publish lifecycle state: DRAFT (incomplete, not announced) or PUBLISHED (complete/live).

string

Allowed values: DRAFT PUBLISHED

ratePlanIds

Rate plan identifiers this add-on is restricted to. EMPTY MEANS AVAILABLE TO ALL rate plans.

Array<string>

requiresTimeSlot

required

Whether this add-on is an appointment that must be booked into a specific time slot. Independent of pricingType.

boolean

roomTypeIds

Room type identifiers this add-on is restricted to. EMPTY MEANS AVAILABLE TO ALL room types.

Array<string>

sort

Use this property to sort an add-on in a list of add-ons.

integer format: int32

version

integer | null format: int64

commission

The commission percentage.

number format: float

commissionable

Whether this package is commissionable based on the incoming sales channel.

boolean

direct

required

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.

boolean

priceList

Array<object>

Localized transactional blocking

object

descriptions

required

Localized descriptions describing inventory.

Array<object>

>= 1 items <= 2147483647 items

Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.

object

description

required

Longer text description

string

>= 1 characters <= 2147483647 characters

language

required

Indicate which language this description is written in.

string

default: en >= 2 characters <= 2 characters /^[a-z]{2}(-[A-Z]{2})?$/

name

required

Use as title or short text description

string

identifier

required

Unique transactional identifier

string format: uuid

>= 1 characters

mandatory

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.

boolean

maxPax

Whether there is a limit to maximum group size.

integer format: int32

minPax

Whether there is a limit to minimum group size.

integer format: int32

multimedias

required

List of images / videos of item.

Array<object>

An image or video of a property or one of its facilities, with ready-to-use delivery URLs.

object

attribution

Whether image has attribution properties

Array<object>

object

name

required

Name of contributor

string

>= 1 characters

url

URL to contributor

string format: uri

category

Supported OTA specification PIC code. See OTA geoname data

string

descriptions

Localized media captions to give user some context about where this media was taken.

Array<object>

Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.

object

description

required

Longer text description

string

>= 1 characters <= 2147483647 characters

language

required

Indicate which language this description is written in.

string

default: en >= 2 characters <= 2 characters /^[a-z]{2}(-[A-Z]{2})?$/

name

required

Use as title or short text description

string

entityId

required

Cloudinary public id; build your own delivery URLs from it

string

height

required

Media height in pixels.

integer format: int32

>= 1

identifier

required

Deprecated, use entityId. Same value; will be removed.

string

>= 1 characters

lifestyleType

Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.

string

sort

required

Sort allows you to control how you want to sort this record in a list of media records.

integer format: int32

default: 999

source

required

Currently ONLY using Cloudinary to store all image / video assets.

string

default: CLOUDINARY

Allowed values: YOUTUBE CLOUDINARY

type

required

Whether Cloudinary media is a VIDEO or IMAGE.

string

Allowed values: IMAGE VIDEO AUDIO RAW

urls

Ready-to-use delivery URLs. Absent when no URL applies to this asset.

object

external

Watch URL for media hosted outside our CDN (for example YouTube).

string

large

Image scaled to at most 1920px wide.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

medium

Image scaled to at most 1024px wide.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

original

Full-size image, not resized.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

poster

Still frame to show before the video plays.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

preview

Short low-bandwidth video preview.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

stream

Video stream at full size.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

thumbnail

Small still, at most 320px wide. For videos this is a frame of the video.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

width

required

Media width in pixels.

integer format: int32

>= 1

name

required

Internal name of transactional blocking.

string

>= 1 characters

offerDetails

Localized offer details if rate plan discount applies.

Array<object>

Simplified localized description containing text content and its language code.

object

description

required

Longer text description

string

>= 1 characters <= 2147483647 characters

language

required

Indicate which language this description is written in.

string

default: en >= 2 characters <= 2 characters /^[a-z]{2}(-[A-Z]{2})?$/

price

required

Localized price

object

channelDiscountPercent

Channel discount percent

number

hasChannelDiscount

boolean

hasPremium

boolean

hasPromotion

boolean

internalBaseTotal

required

Base total in wink currency.

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

internalChannelModifier

Channel / Membership modifier in wink currency

number

internalPremiumModifier

Premium modifiers in wink currency

number

internalPromotionalModifier

Promotional modifiers in wink currency

number

internalTotal

Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

premiumPercent

Premium percent

number

promotionalDiscountPercent

Promotional discount percent

number

quantity

How many of this item is included in this price

integer format: int64

default: 1

sourceBaseTotal

required

Base total in hotel currency.

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

sourceChannelModifier

Channel / Membership modifier in hotel currency

number

sourcePremiumModifier

Premium modifiers in hotel currency

number

sourcePromotionalModifier

Promotional modifiers in hotel currency

number

sourceToInternalCurrencyQuote

required

Hotel to wink currency exchange rate.

object

exchangeRate

required

Exchange rate from source to target currency

number

source

required

ISO 4217 source currency code

string

>= 1 characters

target

required

ISO 4217 target currency code

string

>= 1 characters

timestamp

required

Unix epoch milliseconds when the quote was recorded

integer format: int64

sourceToUserCurrencyQuote

required

Hotel to user currency exchange rate.

object

exchangeRate

required

Exchange rate from source to target currency

number

source

required

ISO 4217 source currency code

string

>= 1 characters

target

required

ISO 4217 target currency code

string

>= 1 characters

timestamp

required

Unix epoch milliseconds when the quote was recorded

integer format: int64

sourceTotal

Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

totalDiscountPercent

number

userSpecifiedCurrencyBaseTotal

required

Base total in user specified currency.

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

userSpecifiedCurrencyChannelModifier

Channel / Membership modifier in user specified currency

number

userSpecifiedCurrencyPremiumModifier

Premium modifiers in user specified currency

number

userSpecifiedCurrencyPromotionalModifier

Promotional modifiers in user specified currency

number

userSpecifiedCurrencyTotal

Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

pricingType

required

How this inventory item should be priced.

string

promotion

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.

string

ratePlanIds

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.

Array<string>

roomTypeIds

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.

Array<string>

adults

required

The actual amount of adults as determined by the hotel’s policy

integer format: int32

available

boolean

children

The actual amount of children as determined by the hotel’s policy

integer format: int32

commission

required

The commission percentage.

number format: float

commissionable

required

Whether this package is commissionable based on the incoming sales channel.

boolean

configuration

required

The selected room configuration that created this record

object

adults

required

Number of adult guests in this room type

integer format: int32

default: 1 >= 1

children

Child guests in this room, with age groups

Array<object>

Child guest with age and quantity in a room configuration

object

age

required

Age of each child in this group (years)

integer format: int32

quantity

required

Count of children of this age group in the room

integer format: int32

>= 1

quantity

Number of identical rooms with this configuration

integer format: int32

default: 1 >= 1

direct

required

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.

boolean

endDate

required

SimpleDateTimeItinerary endDate

string format: date

extraCharges

Per rate plan level extra charges with localized prices

object

internalTotal

Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

items

Items

List of extra charges that applies to the rate plan.

Array<object>

object

price

The localized price of the extra charge

object

channelDiscountPercent

Channel discount percent

number

hasChannelDiscount

boolean

hasPremium

boolean

hasPromotion

boolean

internalBaseTotal

required

Base total in wink currency.

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

internalChannelModifier

Channel / Membership modifier in wink currency

number

internalPremiumModifier

Premium modifiers in wink currency

number

internalPromotionalModifier

Promotional modifiers in wink currency

number

internalTotal

Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

premiumPercent

Premium percent

number

promotionalDiscountPercent

Promotional discount percent

number

quantity

How many of this item is included in this price

integer format: int64

default: 1

sourceBaseTotal

required

Base total in hotel currency.

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

sourceChannelModifier

Channel / Membership modifier in hotel currency

number

sourcePremiumModifier

Premium modifiers in hotel currency

number

sourcePromotionalModifier

Promotional modifiers in hotel currency

number

sourceToInternalCurrencyQuote

required

Hotel to wink currency exchange rate.

object

exchangeRate

required

Exchange rate from source to target currency

number

source

required

ISO 4217 source currency code

string

>= 1 characters

target

required

ISO 4217 target currency code

string

>= 1 characters

timestamp

required

Unix epoch milliseconds when the quote was recorded

integer format: int64

sourceToUserCurrencyQuote

required

Hotel to user currency exchange rate.

object

exchangeRate

required

Exchange rate from source to target currency

number

source

required

ISO 4217 source currency code

string

>= 1 characters

target

required

ISO 4217 target currency code

string

>= 1 characters

timestamp

required

Unix epoch milliseconds when the quote was recorded

integer format: int64

sourceTotal

Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

totalDiscountPercent

number

userSpecifiedCurrencyBaseTotal

required

Base total in user specified currency.

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

userSpecifiedCurrencyChannelModifier

Channel / Membership modifier in user specified currency

number

userSpecifiedCurrencyPremiumModifier

Premium modifiers in user specified currency

number

userSpecifiedCurrencyPromotionalModifier

Promotional modifiers in user specified currency

number

userSpecifiedCurrencyTotal

Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

ratePlanLevelFee

What the guest is paying extra for

object

descriptions

required

Localized descriptions of this fee in multiple languages. At least one entry in English is required.

Array<object>

>= 1 items

Simplified localized description containing text content and its language code.

object

description

required

Longer text description

string

>= 1 characters <= 2147483647 characters

language

required

Indicate which language this description is written in.

string

default: en >= 2 characters <= 2 characters /^[a-z]{2}(-[A-Z]{2})?$/

fixedAmount

required

The fixed fee amount in the property’s local currency.

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

type

required

How this fee is charged: per day, per stay, per person per day, or per person per stay.

string

Allowed values: PER_DAY PER_STAY PER_PERSON_PER_DAY PER_PERSON_PER_STAY

unitPrice

The localized unit price of the extra charge

object

channelDiscountPercent

Channel discount percent

number

hasChannelDiscount

boolean

hasPremium

boolean

hasPromotion

boolean

internalBaseTotal

required

Base total in wink currency.

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

internalChannelModifier

Channel / Membership modifier in wink currency

number

internalPremiumModifier

Premium modifiers in wink currency

number

internalPromotionalModifier

Promotional modifiers in wink currency

number

internalTotal

Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

premiumPercent

Premium percent

number

promotionalDiscountPercent

Promotional discount percent

number

quantity

How many of this item is included in this price

integer format: int64

default: 1

sourceBaseTotal

required

Base total in hotel currency.

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

sourceChannelModifier

Channel / Membership modifier in hotel currency

number

sourcePremiumModifier

Premium modifiers in hotel currency

number

sourcePromotionalModifier

Promotional modifiers in hotel currency

number

sourceToInternalCurrencyQuote

required

Hotel to wink currency exchange rate.

object

exchangeRate

required

Exchange rate from source to target currency

number

source

required

ISO 4217 source currency code

string

>= 1 characters

target

required

ISO 4217 target currency code

string

>= 1 characters

timestamp

required

Unix epoch milliseconds when the quote was recorded

integer format: int64

sourceToUserCurrencyQuote

required

Hotel to user currency exchange rate.

object

exchangeRate

required

Exchange rate from source to target currency

number

source

required

ISO 4217 source currency code

string

>= 1 characters

target

required

ISO 4217 target currency code

string

>= 1 characters

timestamp

required

Unix epoch milliseconds when the quote was recorded

integer format: int64

sourceTotal

Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

totalDiscountPercent

number

userSpecifiedCurrencyBaseTotal

required

Base total in user specified currency.

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

userSpecifiedCurrencyChannelModifier

Channel / Membership modifier in user specified currency

number

userSpecifiedCurrencyPremiumModifier

Premium modifiers in user specified currency

number

userSpecifiedCurrencyPromotionalModifier

Promotional modifiers in user specified currency

number

userSpecifiedCurrencyTotal

Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

sourceTotal

Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

userSpecifiedCurrencyTotal

Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

internalTotal

Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

list

Array<object>

This is one localized bookable item that can stand alongside a restaurant / meeting room etc.

object

descriptions

required

Localized descriptions describing inventory.

Array<object>

>= 1 items <= 2147483647 items

Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.

object

description

required

Longer text description

string

>= 1 characters <= 2147483647 characters

language

required

Indicate which language this description is written in.

string

default: en >= 2 characters <= 2 characters /^[a-z]{2}(-[A-Z]{2})?$/

name

required

Use as title or short text description

string

identifier

required

Unique transactional identifier

string format: uuid

>= 1 characters

mandatory

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.

boolean

maxPax

Whether there is a limit to maximum group size.

integer format: int32

minPax

Whether there is a limit to minimum group size.

integer format: int32

multimedias

required

List of images / videos of item.

Array<object>

An image or video of a property or one of its facilities, with ready-to-use delivery URLs.

object

attribution

Whether image has attribution properties

Array<object>

object

name

required

Name of contributor

string

>= 1 characters

url

URL to contributor

string format: uri

category

Supported OTA specification PIC code. See OTA geoname data

string

descriptions

Localized media captions to give user some context about where this media was taken.

Array<object>

Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.

object

description

required

Longer text description

string

>= 1 characters <= 2147483647 characters

language

required

Indicate which language this description is written in.

string

default: en >= 2 characters <= 2 characters /^[a-z]{2}(-[A-Z]{2})?$/

name

required

Use as title or short text description

string

entityId

required

Cloudinary public id; build your own delivery URLs from it

string

height

required

Media height in pixels.

integer format: int32

>= 1

identifier

required

Deprecated, use entityId. Same value; will be removed.

string

>= 1 characters

lifestyleType

Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.

string

sort

required

Sort allows you to control how you want to sort this record in a list of media records.

integer format: int32

default: 999

source

required

Currently ONLY using Cloudinary to store all image / video assets.

string

default: CLOUDINARY

Allowed values: YOUTUBE CLOUDINARY

type

required

Whether Cloudinary media is a VIDEO or IMAGE.

string

Allowed values: IMAGE VIDEO AUDIO RAW

urls

Ready-to-use delivery URLs. Absent when no URL applies to this asset.

object

external

Watch URL for media hosted outside our CDN (for example YouTube).

string

large

Image scaled to at most 1920px wide.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

medium

Image scaled to at most 1024px wide.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

original

Full-size image, not resized.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

poster

Still frame to show before the video plays.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

preview

Short low-bandwidth video preview.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

stream

Video stream at full size.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

thumbnail

Small still, at most 320px wide. For videos this is a frame of the video.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

width

required

Media width in pixels.

integer format: int32

>= 1

name

required

Internal name of transactional blocking.

string

>= 1 characters

offerDetails

Localized offer details if rate plan discount applies.

Array<object>

Simplified localized description containing text content and its language code.

object

description

required

Longer text description

string

>= 1 characters <= 2147483647 characters

language

required

Indicate which language this description is written in.

string

default: en >= 2 characters <= 2 characters /^[a-z]{2}(-[A-Z]{2})?$/

price

required

Localized price

object

channelDiscountPercent

Channel discount percent

number

hasChannelDiscount

boolean

hasPremium

boolean

hasPromotion

boolean

internalBaseTotal

required

Base total in wink currency.

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

internalChannelModifier

Channel / Membership modifier in wink currency

number

internalPremiumModifier

Premium modifiers in wink currency

number

internalPromotionalModifier

Promotional modifiers in wink currency

number

internalTotal

Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

premiumPercent

Premium percent

number

promotionalDiscountPercent

Promotional discount percent

number

quantity

How many of this item is included in this price

integer format: int64

default: 1

sourceBaseTotal

required

Base total in hotel currency.

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

sourceChannelModifier

Channel / Membership modifier in hotel currency

number

sourcePremiumModifier

Premium modifiers in hotel currency

number

sourcePromotionalModifier

Promotional modifiers in hotel currency

number

sourceToInternalCurrencyQuote

required

Hotel to wink currency exchange rate.

object

exchangeRate

required

Exchange rate from source to target currency

number

source

required

ISO 4217 source currency code

string

>= 1 characters

target

required

ISO 4217 target currency code

string

>= 1 characters

timestamp

required

Unix epoch milliseconds when the quote was recorded

integer format: int64

sourceToUserCurrencyQuote

required

Hotel to user currency exchange rate.

object

exchangeRate

required

Exchange rate from source to target currency

number

source

required

ISO 4217 source currency code

string

>= 1 characters

target

required

ISO 4217 target currency code

string

>= 1 characters

timestamp

required

Unix epoch milliseconds when the quote was recorded

integer format: int64

sourceTotal

Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

totalDiscountPercent

number

userSpecifiedCurrencyBaseTotal

required

Base total in user specified currency.

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

userSpecifiedCurrencyChannelModifier

Channel / Membership modifier in user specified currency

number

userSpecifiedCurrencyPremiumModifier

Premium modifiers in user specified currency

number

userSpecifiedCurrencyPromotionalModifier

Promotional modifiers in user specified currency

number

userSpecifiedCurrencyTotal

Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

pricingType

required

How this inventory item should be priced.

string

promotion

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.

string

ratePlanIds

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.

Array<string>

roomTypeIds

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.

Array<string>

perkTypes

Array<object>

Perks that accompany the master rate

object

createdDate

Datetime this record was first created

string | null format: date-time

descriptions

required

Localized descriptions of this perk in multiple languages. Each element provides a name, description, and language code (e.g., ‘en’, ‘fr’, ‘de’).

Array<object>

>= 1 items

Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.

object

description

required

Longer text description

string

>= 1 characters <= 2147483647 characters

language

required

Indicate which language this description is written in.

string

default: en >= 2 characters <= 2 characters /^[a-z]{2}(-[A-Z]{2})?$/

name

required

Use as title or short text description

string

guaranteed

required

Whether this perk is guaranteed to be provided or available on a best-effort basis. Guaranteed perks take priority in allocation.

boolean

Unique identifier for this record.

string format: uuid

lastUpdate

Datetime this record was last updated

string | null format: date-time

level

required

Platform tier/value assigned to this perk (0=standard, higher=premium). Used for internal prioritization and matching with rate tiers.

integer format: int32

sort

required

Display order when showing this perk in a list (ascending sort). Lower numbers appear first; 999 is reserved for disabled/unlisted perks.

integer format: int32

version

integer | null format: int64

perkValue

The combined value of these perkTypes

integer format: int32

price

required

Calculated price

object

available

Available

boolean

channelDiscountPercent

Chanel discount percent

number

internalAveragePricePerNight

Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

internalBaseTotal

Base total in wink currency.

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

internalChannelModifier

Channel / Membership modifier in wink currency

number

internalExtraChildModifier

Extra child modifier in wink currency

number

internalExtraPaxModifier

Extra person modifier in wink currency

number

internalPremiumModifier

Rate premiums modifiers in wink currency

number

internalPromotionalModifier

Rate discount modifiers in wink currency

number

internalSingleOccupantModifier

Singe occupant modifier in wink currency

number

internalTotal

Internal currency final price.

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

maxOccupancy

Maximum occupancy

integer format: int32

minOccupancy

Minimum occupancy

integer format: int32

offerDetails

Localized text of the discount

Array<object>

Simplified localized description containing text content and its language code.

object

description

required

Longer text description

string

>= 1 characters <= 2147483647 characters

language

required

Indicate which language this description is written in.

string

default: en >= 2 characters <= 2 characters /^[a-z]{2}(-[A-Z]{2})?$/

premiumPercent

Premium percent

number

promotionalCodes

Promotional codes

Array<string>

promotionalDiscountPercent

Promotional discount percent

number

quantity

Quantity

integer format: int32

rateSource

Source

string

sourceAveragePricePerNight

Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

sourceBaseTotal

Base total in hotel’s currency.

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

sourceChannelModifier

Channel / Membership modifier in hotel currency

number

sourceExtraChildModifier

Extra child modifier in hotel currency

number

sourceExtraPaxModifier

Extra person modifier in hotel currency.

number

sourcePremiumModifier

Rate premiums modifiers in hotel currency

number

sourcePromotionalModifier

Rate discount modifiers in hotel currency

number

sourceSingleOccupantModifier

Single occupant modifier in hotel currency

number

sourceToInternalCurrencyQuote

Hotel to wink currency exchange rate.

object

exchangeRate

required

Exchange rate from source to target currency

number

source

required

ISO 4217 source currency code

string

>= 1 characters

target

required

ISO 4217 target currency code

string

>= 1 characters

timestamp

required

Unix epoch milliseconds when the quote was recorded

integer format: int64

sourceToUserCurrencyQuote

Hotel to user currency exchange rate.

object

exchangeRate

required

Exchange rate from source to target currency

number

source

required

ISO 4217 source currency code

string

>= 1 characters

target

required

ISO 4217 target currency code

string

>= 1 characters

timestamp

required

Unix epoch milliseconds when the quote was recorded

integer format: int64

sourceTotal

Source currency final price.

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

totalDiscountPercent

number

userSpecifiedCurrencyAveragePricePerNight

Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

userSpecifiedCurrencyBaseTotal

Base total in user specified currency.

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

userSpecifiedCurrencyChannelModifier

Channel / Membership modifier in user specified currency

number

userSpecifiedCurrencyExtraChildModifier

Extra child modifier in user specified currcency

number

userSpecifiedCurrencyExtraPaxModifier

Extra person modifier in user specified currency

number

userSpecifiedCurrencyPremiumModifier

Rate premiums modifiers in user specified currency

number

userSpecifiedCurrencyPromotionalModifier

Rate discount modifiers in user specified currency

number

userSpecifiedCurrencySingleOccupantModifier

Single occupant modifier in user specified currency

number

userSpecifiedCurrencyTotal

User-defined currency final price.

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

priceList

Array<object>

Localized transactional blocking

object

descriptions

required

Localized descriptions describing inventory.

Array<object>

>= 1 items <= 2147483647 items

Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.

object

description

required

Longer text description

string

>= 1 characters <= 2147483647 characters

language

required

Indicate which language this description is written in.

string

default: en >= 2 characters <= 2 characters /^[a-z]{2}(-[A-Z]{2})?$/

name

required

Use as title or short text description

string

identifier

required

Unique transactional identifier

string format: uuid

>= 1 characters

mandatory

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.

boolean

maxPax

Whether there is a limit to maximum group size.

integer format: int32

minPax

Whether there is a limit to minimum group size.

integer format: int32

multimedias

required

List of images / videos of item.

Array<object>

An image or video of a property or one of its facilities, with ready-to-use delivery URLs.

object

attribution

Whether image has attribution properties

Array<object>

object

name

required

Name of contributor

string

>= 1 characters

url

URL to contributor

string format: uri

category

Supported OTA specification PIC code. See OTA geoname data

string

descriptions

Localized media captions to give user some context about where this media was taken.

Array<object>

Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.

object

description

required

Longer text description

string

>= 1 characters <= 2147483647 characters

language

required

Indicate which language this description is written in.

string

default: en >= 2 characters <= 2 characters /^[a-z]{2}(-[A-Z]{2})?$/

name

required

Use as title or short text description

string

entityId

required

Cloudinary public id; build your own delivery URLs from it

string

height

required

Media height in pixels.

integer format: int32

>= 1

identifier

required

Deprecated, use entityId. Same value; will be removed.

string

>= 1 characters

lifestyleType

Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.

string

sort

required

Sort allows you to control how you want to sort this record in a list of media records.

integer format: int32

default: 999

source

required

Currently ONLY using Cloudinary to store all image / video assets.

string

default: CLOUDINARY

Allowed values: YOUTUBE CLOUDINARY

type

required

Whether Cloudinary media is a VIDEO or IMAGE.

string

Allowed values: IMAGE VIDEO AUDIO RAW

urls

Ready-to-use delivery URLs. Absent when no URL applies to this asset.

object

external

Watch URL for media hosted outside our CDN (for example YouTube).

string

large

Image scaled to at most 1920px wide.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

medium

Image scaled to at most 1024px wide.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

original

Full-size image, not resized.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

poster

Still frame to show before the video plays.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

preview

Short low-bandwidth video preview.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

stream

Video stream at full size.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

thumbnail

Small still, at most 320px wide. For videos this is a frame of the video.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

width

required

Media width in pixels.

integer format: int32

>= 1

name

required

Internal name of transactional blocking.

string

>= 1 characters

offerDetails

Localized offer details if rate plan discount applies.

Array<object>

Simplified localized description containing text content and its language code.

object

description

required

Longer text description

string

>= 1 characters <= 2147483647 characters

language

required

Indicate which language this description is written in.

string

default: en >= 2 characters <= 2 characters /^[a-z]{2}(-[A-Z]{2})?$/

price

required

Localized price

object

channelDiscountPercent

Channel discount percent

number

hasChannelDiscount

boolean

hasPremium

boolean

hasPromotion

boolean

internalBaseTotal

required

Base total in wink currency.

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

internalChannelModifier

Channel / Membership modifier in wink currency

number

internalPremiumModifier

Premium modifiers in wink currency

number

internalPromotionalModifier

Promotional modifiers in wink currency

number

internalTotal

Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

premiumPercent

Premium percent

number

promotionalDiscountPercent

Promotional discount percent

number

quantity

How many of this item is included in this price

integer format: int64

default: 1

sourceBaseTotal

required

Base total in hotel currency.

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

sourceChannelModifier

Channel / Membership modifier in hotel currency

number

sourcePremiumModifier

Premium modifiers in hotel currency

number

sourcePromotionalModifier

Promotional modifiers in hotel currency

number

sourceToInternalCurrencyQuote

required

Hotel to wink currency exchange rate.

object

exchangeRate

required

Exchange rate from source to target currency

number

source

required

ISO 4217 source currency code

string

>= 1 characters

target

required

ISO 4217 target currency code

string

>= 1 characters

timestamp

required

Unix epoch milliseconds when the quote was recorded

integer format: int64

sourceToUserCurrencyQuote

required

Hotel to user currency exchange rate.

object

exchangeRate

required

Exchange rate from source to target currency

number

source

required

ISO 4217 source currency code

string

>= 1 characters

target

required

ISO 4217 target currency code

string

>= 1 characters

timestamp

required

Unix epoch milliseconds when the quote was recorded

integer format: int64

sourceTotal

Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

totalDiscountPercent

number

userSpecifiedCurrencyBaseTotal

required

Base total in user specified currency.

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

userSpecifiedCurrencyChannelModifier

Channel / Membership modifier in user specified currency

number

userSpecifiedCurrencyPremiumModifier

Premium modifiers in user specified currency

number

userSpecifiedCurrencyPromotionalModifier

Promotional modifiers in user specified currency

number

userSpecifiedCurrencyTotal

Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

pricingType

required

How this inventory item should be priced.

string

promotion

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.

string

ratePlanIds

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.

Array<string>

roomTypeIds

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.

Array<string>

ratePlan

required

Specified rate plan

object

allInclusive

required

Everything included except alcohol

boolean

allInclusivePlusAlcohol

required

Everything included with alcohol

boolean

breakfast

required

When true, indicates breakfast is included.

boolean

brunch

required

When true, indicates brunch is included.

boolean

dinner

required

When true, indicates dinner is included.

boolean

earlyCheckInCharge

identifier

required

Rate plan identifier

string format: uuid

>= 1 characters

lateCheckOutCharge

lunch

required

When true, indicates lunch is included.

boolean

name

required

Provides the name of the rate plan.

string

>= 1 characters

rateSource

string

roomNights

required

Number of nights the guests will be staying

integer format: int32

roomRateIdentifier

required

Specified master rate identifier

string

roomRateInternalName

required

Specified master rate internal name

string

sourceTotal

Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

startDate

required

SimpleDateTimeItinerary startDate

string format: date

userSpecifiedCurrencyTotal

Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

roomTypeIdentifier

required

Room type identifier.

string format: uuid

sort

required

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.

integer format: int32

potentialChannelDiscountPercent

required

The potential discount the user is entitled to if user is a member / authenticated.

number format: float

priceBand

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

asLowAs

required

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

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

butNoMoreThan

required

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

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

priceList

required

Best-priced room types

Array<object>

object

available

required

Whether this room type is available with this configuration

boolean

perkValue

required

The sum of all perks the master rate had made available.

integer format: int32

price

required

Price details for this room type configuration.

object

activeCancellationPolicy

required

The active / selected cancellation policy for this room configuration

object

advanceCancellationFreeOfCharge

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.

string

createdDate

Datetime this record was first created

string | null format: date-time

hotelIdentifier

required

Property this cancellation is associated with

string format: uuid

required

Unique identifier for this record.

string format: uuid

lastUpdate

Datetime this record was last updated

string | null format: date-time

noShowCharge

In case the ‘Refundable cancellation charge’ is set, a different no show charge can be applied.

string

Allowed values: SAME_AS_CANCELLATION_FEE ONE_HUNDRED_PERCENT_OF_TOTAL_CHARGE

nonRefundableAfterDeadlineCancellationCharge

If the guest does not honor the non-refundable deadline rule, this charge dictates what she owes after the deadline passes.

string

Allowed values: FIRST_NIGHT TEN_PERCENT THIRTY_PERCENT FIFTY_PERCENT SEVENTY_PERCENT ONE_HUNDRED_PERCENT

nonRefundableCancellationCharge

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.

string

Allowed values: FIRST_NIGHT TEN_PERCENT THIRTY_PERCENT FIFTY_PERCENT SEVENTY_PERCENT

nonRefundableDeadline

The non-refundable charge might can have a deadline. If that deadline passes, the guest might be charged more.

string

policyCode

string

refundable

required

Whether this cancellation policy is refundable or not

boolean

refundableCancellationCharge

If advanceCancellationFreeOfCharge rules is not honored, this property explains what the guest will be charged.

string

Allowed values: FIRST_NIGHT THIRTY_PERCENT FIFTY_PERCENT SIXTY_PERCENT SEVENTY_PERCENT NINETY_PERCENT ONE_HUNDRED_PERCENT

version

integer | null format: int64

addOnOffers

Array<object>

Add-ons that are available with this room configuration

object

addOn

required

The original add-on record created by the property.

object

active

required

Modify add-on availability with this flag.

boolean

default: true

applicableEnd

End month and day or date for which the add-on is available (seasonal availability).

string format: date

applicableStart

Start month and day or date for which the add-on is available (seasonal availability).

string format: date

basePrice

Base price of booking this add-on.

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

category

Level 1 taxonomy: property-level (ADD_ON) or a specific venue type. Null is treated as ADD_ON.

string | null

Allowed values: GUEST_ROOM ADD_ON MEETING_ROOM RESTAURANT SPA ATTRACTION PLACE ACTIVITY

categoryItemIds

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.

Array<string> | null

closes

Closing time of the add-on (if applicable). Leave empty if always available.

string

commissionable

required

Indicate whether sales channels receive commission for selling this add-on.

boolean

default: true

createdDate

Datetime this record was first created

string | null format: date-time

dateRanges

Optional list of date ranges restricting add-on availability to specific periods. Empty means available on every date.

Array<object>

object

endDate

required

Retrieve data range ending with and including this end date

string format: date

startDate

required

Retrieve data range starting with and including this start date

string format: date

daysOfWeek

Indicates which days this add-on is open.

object

disabled

Convenience property to quickly determine if this existing object has any active days enabled.

boolean

fri

Set to true to enable Friday.

boolean

mon

Set to true to enable Monday.

boolean

sat

Set to true to enable Saturday.

boolean

sun

Set to true to enable Sunday.

boolean

thu

Set to true to enable Thursday.

boolean

tue

Set to true to enable Tuesday.

boolean

wed

Set to true to enable Wednesday.

boolean

descriptions

Localized descriptions describing this add-on.

Array<object>

Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.

object

description

required

Longer text description

string

>= 1 characters <= 2147483647 characters

language

required

Indicate which language this description is written in.

string

default: en >= 2 characters <= 2 characters /^[a-z]{2}(-[A-Z]{2})?$/

name

required

Use as title or short text description

string

discountedPrice

If this add-on is sold at a discount, the discounted selling price.

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

featuredInd

required

Indicates whether this add-on is featured.

boolean

hotelIdentifier

required

Hotel identifier.

string format: uuid

>= 1 characters

required

Unique identifier for this record.

string format: uuid

>= 1 characters

lastUpdate

Datetime this record was last updated

string | null format: date-time

mandatory

required

Make this add-on mandatory for all guests by enabling this flag.

boolean

maxPax

Maximum group size this add-on can be booked for.

integer format: int32

minPax

Minimum group size this add-on can be booked for.

integer format: int32

multimedias

List of images / videos of this add-on.

Array<object>

An image or video of a property or one of its facilities, with ready-to-use delivery URLs.

object

attribution

Whether image has attribution properties

Array<object>

object

name

required

Name of contributor

string

>= 1 characters

url

URL to contributor

string format: uri

category

Supported OTA specification PIC code. See OTA geoname data

string

descriptions

Localized media captions to give user some context about where this media was taken.

Array<object>

Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.

object

description

required

Longer text description

string

>= 1 characters <= 2147483647 characters

language

required

Indicate which language this description is written in.

string

default: en >= 2 characters <= 2 characters /^[a-z]{2}(-[A-Z]{2})?$/

name

required

Use as title or short text description

string

entityId

required

Cloudinary public id; build your own delivery URLs from it

string

height

required

Media height in pixels.

integer format: int32

>= 1

identifier

required

Deprecated, use entityId. Same value; will be removed.

string

>= 1 characters

lifestyleType

Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.

string

sort

required

Sort allows you to control how you want to sort this record in a list of media records.

integer format: int32

default: 999

source

required

Currently ONLY using Cloudinary to store all image / video assets.

string

default: CLOUDINARY

Allowed values: YOUTUBE CLOUDINARY

type

required

Whether Cloudinary media is a VIDEO or IMAGE.

string

Allowed values: IMAGE VIDEO AUDIO RAW

urls

Ready-to-use delivery URLs. Absent when no URL applies to this asset.

object

external

Watch URL for media hosted outside our CDN (for example YouTube).

string

large

Image scaled to at most 1920px wide.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

medium

Image scaled to at most 1024px wide.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

original

Full-size image, not resized.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

poster

Still frame to show before the video plays.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

preview

Short low-bandwidth video preview.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

stream

Video stream at full size.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

thumbnail

Small still, at most 320px wide. For videos this is a frame of the video.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

width

required

Media width in pixels.

integer format: int32

>= 1

name

required

Internal name of the add-on.

string

>= 1 characters

opens

Opening time of the add-on (if applicable). Leave empty if always available.

string

pricingType

How this add-on should be priced.

string

publishStatus

Publish lifecycle state: DRAFT (incomplete, not announced) or PUBLISHED (complete/live).

string

Allowed values: DRAFT PUBLISHED

ratePlanIds

Rate plan identifiers this add-on is restricted to. EMPTY MEANS AVAILABLE TO ALL rate plans.

Array<string>

requiresTimeSlot

required

Whether this add-on is an appointment that must be booked into a specific time slot. Independent of pricingType.

boolean

roomTypeIds

Room type identifiers this add-on is restricted to. EMPTY MEANS AVAILABLE TO ALL room types.

Array<string>

sort

Use this property to sort an add-on in a list of add-ons.

integer format: int32

version

integer | null format: int64

commission

The commission percentage.

number format: float

commissionable

Whether this package is commissionable based on the incoming sales channel.

boolean

direct

required

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.

boolean

priceList

Array<object>

Localized transactional blocking

object

descriptions

required

Localized descriptions describing inventory.

Array<object>

>= 1 items <= 2147483647 items

Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.

object

description

required

Longer text description

string

>= 1 characters <= 2147483647 characters

language

required

Indicate which language this description is written in.

string

default: en >= 2 characters <= 2 characters /^[a-z]{2}(-[A-Z]{2})?$/

name

required

Use as title or short text description

string

identifier

required

Unique transactional identifier

string format: uuid

>= 1 characters

mandatory

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.

boolean

maxPax

Whether there is a limit to maximum group size.

integer format: int32

minPax

Whether there is a limit to minimum group size.

integer format: int32

multimedias

required

List of images / videos of item.

Array<object>

An image or video of a property or one of its facilities, with ready-to-use delivery URLs.

object

attribution

Whether image has attribution properties

Array<object>

object

name

required

Name of contributor

string

>= 1 characters

url

URL to contributor

string format: uri

category

Supported OTA specification PIC code. See OTA geoname data

string

descriptions

Localized media captions to give user some context about where this media was taken.

Array<object>

Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.

object

description

required

Longer text description

string

>= 1 characters <= 2147483647 characters

language

required

Indicate which language this description is written in.

string

default: en >= 2 characters <= 2 characters /^[a-z]{2}(-[A-Z]{2})?$/

name

required

Use as title or short text description

string

entityId

required

Cloudinary public id; build your own delivery URLs from it

string

height

required

Media height in pixels.

integer format: int32

>= 1

identifier

required

Deprecated, use entityId. Same value; will be removed.

string

>= 1 characters

lifestyleType

Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.

string

sort

required

Sort allows you to control how you want to sort this record in a list of media records.

integer format: int32

default: 999

source

required

Currently ONLY using Cloudinary to store all image / video assets.

string

default: CLOUDINARY

Allowed values: YOUTUBE CLOUDINARY

type

required

Whether Cloudinary media is a VIDEO or IMAGE.

string

Allowed values: IMAGE VIDEO AUDIO RAW

urls

Ready-to-use delivery URLs. Absent when no URL applies to this asset.

object

external

Watch URL for media hosted outside our CDN (for example YouTube).

string

large

Image scaled to at most 1920px wide.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

medium

Image scaled to at most 1024px wide.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

original

Full-size image, not resized.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

poster

Still frame to show before the video plays.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

preview

Short low-bandwidth video preview.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

stream

Video stream at full size.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

thumbnail

Small still, at most 320px wide. For videos this is a frame of the video.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

width

required

Media width in pixels.

integer format: int32

>= 1

name

required

Internal name of transactional blocking.

string

>= 1 characters

offerDetails

Localized offer details if rate plan discount applies.

Array<object>

Simplified localized description containing text content and its language code.

object

description

required

Longer text description

string

>= 1 characters <= 2147483647 characters

language

required

Indicate which language this description is written in.

string

default: en >= 2 characters <= 2 characters /^[a-z]{2}(-[A-Z]{2})?$/

price

required

Localized price

object

channelDiscountPercent

Channel discount percent

number

hasChannelDiscount

boolean

hasPremium

boolean

hasPromotion

boolean

internalBaseTotal

required

Base total in wink currency.

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

internalChannelModifier

Channel / Membership modifier in wink currency

number

internalPremiumModifier

Premium modifiers in wink currency

number

internalPromotionalModifier

Promotional modifiers in wink currency

number

internalTotal

Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

premiumPercent

Premium percent

number

promotionalDiscountPercent

Promotional discount percent

number

quantity

How many of this item is included in this price

integer format: int64

default: 1

sourceBaseTotal

required

Base total in hotel currency.

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

sourceChannelModifier

Channel / Membership modifier in hotel currency

number

sourcePremiumModifier

Premium modifiers in hotel currency

number

sourcePromotionalModifier

Promotional modifiers in hotel currency

number

sourceToInternalCurrencyQuote

required

Hotel to wink currency exchange rate.

object

exchangeRate

required

Exchange rate from source to target currency

number

source

required

ISO 4217 source currency code

string

>= 1 characters

target

required

ISO 4217 target currency code

string

>= 1 characters

timestamp

required

Unix epoch milliseconds when the quote was recorded

integer format: int64

sourceToUserCurrencyQuote

required

Hotel to user currency exchange rate.

object

exchangeRate

required

Exchange rate from source to target currency

number

source

required

ISO 4217 source currency code

string

>= 1 characters

target

required

ISO 4217 target currency code

string

>= 1 characters

timestamp

required

Unix epoch milliseconds when the quote was recorded

integer format: int64

sourceTotal

Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

totalDiscountPercent

number

userSpecifiedCurrencyBaseTotal

required

Base total in user specified currency.

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

userSpecifiedCurrencyChannelModifier

Channel / Membership modifier in user specified currency

number

userSpecifiedCurrencyPremiumModifier

Premium modifiers in user specified currency

number

userSpecifiedCurrencyPromotionalModifier

Promotional modifiers in user specified currency

number

userSpecifiedCurrencyTotal

Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

pricingType

required

How this inventory item should be priced.

string

promotion

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.

string

ratePlanIds

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.

Array<string>

roomTypeIds

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.

Array<string>

adults

required

The actual amount of adults as determined by the hotel’s policy

integer format: int32

available

boolean

children

The actual amount of children as determined by the hotel’s policy

integer format: int32

commission

required

The commission percentage.

number format: float

commissionable

required

Whether this package is commissionable based on the incoming sales channel.

boolean

configuration

required

The selected room configuration that created this record

object

adults

required

Number of adult guests in this room type

integer format: int32

default: 1 >= 1

children

Child guests in this room, with age groups

Array<object>

Child guest with age and quantity in a room configuration

object

age

required

Age of each child in this group (years)

integer format: int32

quantity

required

Count of children of this age group in the room

integer format: int32

>= 1

quantity

Number of identical rooms with this configuration

integer format: int32

default: 1 >= 1

direct

required

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.

boolean

endDate

required

SimpleDateTimeItinerary endDate

string format: date

extraCharges

Per rate plan level extra charges with localized prices

object

internalTotal

Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

items

Items

List of extra charges that applies to the rate plan.

Array<object>

object

price

The localized price of the extra charge

object

channelDiscountPercent

Channel discount percent

number

hasChannelDiscount

boolean

hasPremium

boolean

hasPromotion

boolean

internalBaseTotal

required

Base total in wink currency.

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

internalChannelModifier

Channel / Membership modifier in wink currency

number

internalPremiumModifier

Premium modifiers in wink currency

number

internalPromotionalModifier

Promotional modifiers in wink currency

number

internalTotal

Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

premiumPercent

Premium percent

number

promotionalDiscountPercent

Promotional discount percent

number

quantity

How many of this item is included in this price

integer format: int64

default: 1

sourceBaseTotal

required

Base total in hotel currency.

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

sourceChannelModifier

Channel / Membership modifier in hotel currency

number

sourcePremiumModifier

Premium modifiers in hotel currency

number

sourcePromotionalModifier

Promotional modifiers in hotel currency

number

sourceToInternalCurrencyQuote

required

Hotel to wink currency exchange rate.

object

exchangeRate

required

Exchange rate from source to target currency

number

source

required

ISO 4217 source currency code

string

>= 1 characters

target

required

ISO 4217 target currency code

string

>= 1 characters

timestamp

required

Unix epoch milliseconds when the quote was recorded

integer format: int64

sourceToUserCurrencyQuote

required

Hotel to user currency exchange rate.

object

exchangeRate

required

Exchange rate from source to target currency

number

source

required

ISO 4217 source currency code

string

>= 1 characters

target

required

ISO 4217 target currency code

string

>= 1 characters

timestamp

required

Unix epoch milliseconds when the quote was recorded

integer format: int64

sourceTotal

Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

totalDiscountPercent

number

userSpecifiedCurrencyBaseTotal

required

Base total in user specified currency.

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

userSpecifiedCurrencyChannelModifier

Channel / Membership modifier in user specified currency

number

userSpecifiedCurrencyPremiumModifier

Premium modifiers in user specified currency

number

userSpecifiedCurrencyPromotionalModifier

Promotional modifiers in user specified currency

number

userSpecifiedCurrencyTotal

Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

ratePlanLevelFee

What the guest is paying extra for

object

descriptions

required

Localized descriptions of this fee in multiple languages. At least one entry in English is required.

Array<object>

>= 1 items

Simplified localized description containing text content and its language code.

object

description

required

Longer text description

string

>= 1 characters <= 2147483647 characters

language

required

Indicate which language this description is written in.

string

default: en >= 2 characters <= 2 characters /^[a-z]{2}(-[A-Z]{2})?$/

fixedAmount

required

The fixed fee amount in the property’s local currency.

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

type

required

How this fee is charged: per day, per stay, per person per day, or per person per stay.

string

Allowed values: PER_DAY PER_STAY PER_PERSON_PER_DAY PER_PERSON_PER_STAY

unitPrice

The localized unit price of the extra charge

object

channelDiscountPercent

Channel discount percent

number

hasChannelDiscount

boolean

hasPremium

boolean

hasPromotion

boolean

internalBaseTotal

required

Base total in wink currency.

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

internalChannelModifier

Channel / Membership modifier in wink currency

number

internalPremiumModifier

Premium modifiers in wink currency

number

internalPromotionalModifier

Promotional modifiers in wink currency

number

internalTotal

Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

premiumPercent

Premium percent

number

promotionalDiscountPercent

Promotional discount percent

number

quantity

How many of this item is included in this price

integer format: int64

default: 1

sourceBaseTotal

required

Base total in hotel currency.

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

sourceChannelModifier

Channel / Membership modifier in hotel currency

number

sourcePremiumModifier

Premium modifiers in hotel currency

number

sourcePromotionalModifier

Promotional modifiers in hotel currency

number

sourceToInternalCurrencyQuote

required

Hotel to wink currency exchange rate.

object

exchangeRate

required

Exchange rate from source to target currency

number

source

required

ISO 4217 source currency code

string

>= 1 characters

target

required

ISO 4217 target currency code

string

>= 1 characters

timestamp

required

Unix epoch milliseconds when the quote was recorded

integer format: int64

sourceToUserCurrencyQuote

required

Hotel to user currency exchange rate.

object

exchangeRate

required

Exchange rate from source to target currency

number

source

required

ISO 4217 source currency code

string

>= 1 characters

target

required

ISO 4217 target currency code

string

>= 1 characters

timestamp

required

Unix epoch milliseconds when the quote was recorded

integer format: int64

sourceTotal

Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

totalDiscountPercent

number

userSpecifiedCurrencyBaseTotal

required

Base total in user specified currency.

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

userSpecifiedCurrencyChannelModifier

Channel / Membership modifier in user specified currency

number

userSpecifiedCurrencyPremiumModifier

Premium modifiers in user specified currency

number

userSpecifiedCurrencyPromotionalModifier

Promotional modifiers in user specified currency

number

userSpecifiedCurrencyTotal

Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

sourceTotal

Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

userSpecifiedCurrencyTotal

Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

internalTotal

Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

list

Array<object>

This is one localized bookable item that can stand alongside a restaurant / meeting room etc.

object

descriptions

required

Localized descriptions describing inventory.

Array<object>

>= 1 items <= 2147483647 items

Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.

object

description

required

Longer text description

string

>= 1 characters <= 2147483647 characters

language

required

Indicate which language this description is written in.

string

default: en >= 2 characters <= 2 characters /^[a-z]{2}(-[A-Z]{2})?$/

name

required

Use as title or short text description

string

identifier

required

Unique transactional identifier

string format: uuid

>= 1 characters

mandatory

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.

boolean

maxPax

Whether there is a limit to maximum group size.

integer format: int32

minPax

Whether there is a limit to minimum group size.

integer format: int32

multimedias

required

List of images / videos of item.

Array<object>

An image or video of a property or one of its facilities, with ready-to-use delivery URLs.

object

attribution

Whether image has attribution properties

Array<object>

object

name

required

Name of contributor

string

>= 1 characters

url

URL to contributor

string format: uri

category

Supported OTA specification PIC code. See OTA geoname data

string

descriptions

Localized media captions to give user some context about where this media was taken.

Array<object>

Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.

object

description

required

Longer text description

string

>= 1 characters <= 2147483647 characters

language

required

Indicate which language this description is written in.

string

default: en >= 2 characters <= 2 characters /^[a-z]{2}(-[A-Z]{2})?$/

name

required

Use as title or short text description

string

entityId

required

Cloudinary public id; build your own delivery URLs from it

string

height

required

Media height in pixels.

integer format: int32

>= 1

identifier

required

Deprecated, use entityId. Same value; will be removed.

string

>= 1 characters

lifestyleType

Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.

string

sort

required

Sort allows you to control how you want to sort this record in a list of media records.

integer format: int32

default: 999

source

required

Currently ONLY using Cloudinary to store all image / video assets.

string

default: CLOUDINARY

Allowed values: YOUTUBE CLOUDINARY

type

required

Whether Cloudinary media is a VIDEO or IMAGE.

string

Allowed values: IMAGE VIDEO AUDIO RAW

urls

Ready-to-use delivery URLs. Absent when no URL applies to this asset.

object

external

Watch URL for media hosted outside our CDN (for example YouTube).

string

large

Image scaled to at most 1920px wide.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

medium

Image scaled to at most 1024px wide.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

original

Full-size image, not resized.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

poster

Still frame to show before the video plays.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

preview

Short low-bandwidth video preview.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

stream

Video stream at full size.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

thumbnail

Small still, at most 320px wide. For videos this is a frame of the video.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

width

required

Media width in pixels.

integer format: int32

>= 1

name

required

Internal name of transactional blocking.

string

>= 1 characters

offerDetails

Localized offer details if rate plan discount applies.

Array<object>

Simplified localized description containing text content and its language code.

object

description

required

Longer text description

string

>= 1 characters <= 2147483647 characters

language

required

Indicate which language this description is written in.

string

default: en >= 2 characters <= 2 characters /^[a-z]{2}(-[A-Z]{2})?$/

price

required

Localized price

object

channelDiscountPercent

Channel discount percent

number

hasChannelDiscount

boolean

hasPremium

boolean

hasPromotion

boolean

internalBaseTotal

required

Base total in wink currency.

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

internalChannelModifier

Channel / Membership modifier in wink currency

number

internalPremiumModifier

Premium modifiers in wink currency

number

internalPromotionalModifier

Promotional modifiers in wink currency

number

internalTotal

Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

premiumPercent

Premium percent

number

promotionalDiscountPercent

Promotional discount percent

number

quantity

How many of this item is included in this price

integer format: int64

default: 1

sourceBaseTotal

required

Base total in hotel currency.

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

sourceChannelModifier

Channel / Membership modifier in hotel currency

number

sourcePremiumModifier

Premium modifiers in hotel currency

number

sourcePromotionalModifier

Promotional modifiers in hotel currency

number

sourceToInternalCurrencyQuote

required

Hotel to wink currency exchange rate.

object

exchangeRate

required

Exchange rate from source to target currency

number

source

required

ISO 4217 source currency code

string

>= 1 characters

target

required

ISO 4217 target currency code

string

>= 1 characters

timestamp

required

Unix epoch milliseconds when the quote was recorded

integer format: int64

sourceToUserCurrencyQuote

required

Hotel to user currency exchange rate.

object

exchangeRate

required

Exchange rate from source to target currency

number

source

required

ISO 4217 source currency code

string

>= 1 characters

target

required

ISO 4217 target currency code

string

>= 1 characters

timestamp

required

Unix epoch milliseconds when the quote was recorded

integer format: int64

sourceTotal

Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

totalDiscountPercent

number

userSpecifiedCurrencyBaseTotal

required

Base total in user specified currency.

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

userSpecifiedCurrencyChannelModifier

Channel / Membership modifier in user specified currency

number

userSpecifiedCurrencyPremiumModifier

Premium modifiers in user specified currency

number

userSpecifiedCurrencyPromotionalModifier

Promotional modifiers in user specified currency

number

userSpecifiedCurrencyTotal

Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

pricingType

required

How this inventory item should be priced.

string

promotion

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.

string

ratePlanIds

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.

Array<string>

roomTypeIds

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.

Array<string>

perkTypes

Array<object>

Perks that accompany the master rate

object

createdDate

Datetime this record was first created

string | null format: date-time

descriptions

required

Localized descriptions of this perk in multiple languages. Each element provides a name, description, and language code (e.g., ‘en’, ‘fr’, ‘de’).

Array<object>

>= 1 items

Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.

object

description

required

Longer text description

string

>= 1 characters <= 2147483647 characters

language

required

Indicate which language this description is written in.

string

default: en >= 2 characters <= 2 characters /^[a-z]{2}(-[A-Z]{2})?$/

name

required

Use as title or short text description

string

guaranteed

required

Whether this perk is guaranteed to be provided or available on a best-effort basis. Guaranteed perks take priority in allocation.

boolean

Unique identifier for this record.

string format: uuid

lastUpdate

Datetime this record was last updated

string | null format: date-time

level

required

Platform tier/value assigned to this perk (0=standard, higher=premium). Used for internal prioritization and matching with rate tiers.

integer format: int32

sort

required

Display order when showing this perk in a list (ascending sort). Lower numbers appear first; 999 is reserved for disabled/unlisted perks.

integer format: int32

version

integer | null format: int64

perkValue

The combined value of these perkTypes

integer format: int32

price

required

Calculated price

object

available

Available

boolean

channelDiscountPercent

Chanel discount percent

number

internalAveragePricePerNight

Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

internalBaseTotal

Base total in wink currency.

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

internalChannelModifier

Channel / Membership modifier in wink currency

number

internalExtraChildModifier

Extra child modifier in wink currency

number

internalExtraPaxModifier

Extra person modifier in wink currency

number

internalPremiumModifier

Rate premiums modifiers in wink currency

number

internalPromotionalModifier

Rate discount modifiers in wink currency

number

internalSingleOccupantModifier

Singe occupant modifier in wink currency

number

internalTotal

Internal currency final price.

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

maxOccupancy

Maximum occupancy

integer format: int32

minOccupancy

Minimum occupancy

integer format: int32

offerDetails

Localized text of the discount

Array<object>

Simplified localized description containing text content and its language code.

object

description

required

Longer text description

string

>= 1 characters <= 2147483647 characters

language

required

Indicate which language this description is written in.

string

default: en >= 2 characters <= 2 characters /^[a-z]{2}(-[A-Z]{2})?$/

premiumPercent

Premium percent

number

promotionalCodes

Promotional codes

Array<string>

promotionalDiscountPercent

Promotional discount percent

number

quantity

Quantity

integer format: int32

rateSource

Source

string

sourceAveragePricePerNight

Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

sourceBaseTotal

Base total in hotel’s currency.

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

sourceChannelModifier

Channel / Membership modifier in hotel currency

number

sourceExtraChildModifier

Extra child modifier in hotel currency

number

sourceExtraPaxModifier

Extra person modifier in hotel currency.

number

sourcePremiumModifier

Rate premiums modifiers in hotel currency

number

sourcePromotionalModifier

Rate discount modifiers in hotel currency

number

sourceSingleOccupantModifier

Single occupant modifier in hotel currency

number

sourceToInternalCurrencyQuote

Hotel to wink currency exchange rate.

object

exchangeRate

required

Exchange rate from source to target currency

number

source

required

ISO 4217 source currency code

string

>= 1 characters

target

required

ISO 4217 target currency code

string

>= 1 characters

timestamp

required

Unix epoch milliseconds when the quote was recorded

integer format: int64

sourceToUserCurrencyQuote

Hotel to user currency exchange rate.

object

exchangeRate

required

Exchange rate from source to target currency

number

source

required

ISO 4217 source currency code

string

>= 1 characters

target

required

ISO 4217 target currency code

string

>= 1 characters

timestamp

required

Unix epoch milliseconds when the quote was recorded

integer format: int64

sourceTotal

Source currency final price.

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

totalDiscountPercent

number

userSpecifiedCurrencyAveragePricePerNight

Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

userSpecifiedCurrencyBaseTotal

Base total in user specified currency.

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

userSpecifiedCurrencyChannelModifier

Channel / Membership modifier in user specified currency

number

userSpecifiedCurrencyExtraChildModifier

Extra child modifier in user specified currcency

number

userSpecifiedCurrencyExtraPaxModifier

Extra person modifier in user specified currency

number

userSpecifiedCurrencyPremiumModifier

Rate premiums modifiers in user specified currency

number

userSpecifiedCurrencyPromotionalModifier

Rate discount modifiers in user specified currency

number

userSpecifiedCurrencySingleOccupantModifier

Single occupant modifier in user specified currency

number

userSpecifiedCurrencyTotal

User-defined currency final price.

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

priceList

Array<object>

Localized transactional blocking

object

descriptions

required

Localized descriptions describing inventory.

Array<object>

>= 1 items <= 2147483647 items

Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.

object

description

required

Longer text description

string

>= 1 characters <= 2147483647 characters

language

required

Indicate which language this description is written in.

string

default: en >= 2 characters <= 2 characters /^[a-z]{2}(-[A-Z]{2})?$/

name

required

Use as title or short text description

string

identifier

required

Unique transactional identifier

string format: uuid

>= 1 characters

mandatory

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.

boolean

maxPax

Whether there is a limit to maximum group size.

integer format: int32

minPax

Whether there is a limit to minimum group size.

integer format: int32

multimedias

required

List of images / videos of item.

Array<object>

An image or video of a property or one of its facilities, with ready-to-use delivery URLs.

object

attribution

Whether image has attribution properties

Array<object>

object

name

required

Name of contributor

string

>= 1 characters

url

URL to contributor

string format: uri

category

Supported OTA specification PIC code. See OTA geoname data

string

descriptions

Localized media captions to give user some context about where this media was taken.

Array<object>

Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.

object

description

required

Longer text description

string

>= 1 characters <= 2147483647 characters

language

required

Indicate which language this description is written in.

string

default: en >= 2 characters <= 2 characters /^[a-z]{2}(-[A-Z]{2})?$/

name

required

Use as title or short text description

string

entityId

required

Cloudinary public id; build your own delivery URLs from it

string

height

required

Media height in pixels.

integer format: int32

>= 1

identifier

required

Deprecated, use entityId. Same value; will be removed.

string

>= 1 characters

lifestyleType

Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.

string

sort

required

Sort allows you to control how you want to sort this record in a list of media records.

integer format: int32

default: 999

source

required

Currently ONLY using Cloudinary to store all image / video assets.

string

default: CLOUDINARY

Allowed values: YOUTUBE CLOUDINARY

type

required

Whether Cloudinary media is a VIDEO or IMAGE.

string

Allowed values: IMAGE VIDEO AUDIO RAW

urls

Ready-to-use delivery URLs. Absent when no URL applies to this asset.

object

external

Watch URL for media hosted outside our CDN (for example YouTube).

string

large

Image scaled to at most 1920px wide.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

medium

Image scaled to at most 1024px wide.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

original

Full-size image, not resized.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

poster

Still frame to show before the video plays.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

preview

Short low-bandwidth video preview.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

stream

Video stream at full size.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

thumbnail

Small still, at most 320px wide. For videos this is a frame of the video.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

width

required

Media width in pixels.

integer format: int32

>= 1

name

required

Internal name of transactional blocking.

string

>= 1 characters

offerDetails

Localized offer details if rate plan discount applies.

Array<object>

Simplified localized description containing text content and its language code.

object

description

required

Longer text description

string

>= 1 characters <= 2147483647 characters

language

required

Indicate which language this description is written in.

string

default: en >= 2 characters <= 2 characters /^[a-z]{2}(-[A-Z]{2})?$/

price

required

Localized price

object

channelDiscountPercent

Channel discount percent

number

hasChannelDiscount

boolean

hasPremium

boolean

hasPromotion

boolean

internalBaseTotal

required

Base total in wink currency.

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

internalChannelModifier

Channel / Membership modifier in wink currency

number

internalPremiumModifier

Premium modifiers in wink currency

number

internalPromotionalModifier

Promotional modifiers in wink currency

number

internalTotal

Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

premiumPercent

Premium percent

number

promotionalDiscountPercent

Promotional discount percent

number

quantity

How many of this item is included in this price

integer format: int64

default: 1

sourceBaseTotal

required

Base total in hotel currency.

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

sourceChannelModifier

Channel / Membership modifier in hotel currency

number

sourcePremiumModifier

Premium modifiers in hotel currency

number

sourcePromotionalModifier

Promotional modifiers in hotel currency

number

sourceToInternalCurrencyQuote

required

Hotel to wink currency exchange rate.

object

exchangeRate

required

Exchange rate from source to target currency

number

source

required

ISO 4217 source currency code

string

>= 1 characters

target

required

ISO 4217 target currency code

string

>= 1 characters

timestamp

required

Unix epoch milliseconds when the quote was recorded

integer format: int64

sourceToUserCurrencyQuote

required

Hotel to user currency exchange rate.

object

exchangeRate

required

Exchange rate from source to target currency

number

source

required

ISO 4217 source currency code

string

>= 1 characters

target

required

ISO 4217 target currency code

string

>= 1 characters

timestamp

required

Unix epoch milliseconds when the quote was recorded

integer format: int64

sourceTotal

Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

totalDiscountPercent

number

userSpecifiedCurrencyBaseTotal

required

Base total in user specified currency.

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

userSpecifiedCurrencyChannelModifier

Channel / Membership modifier in user specified currency

number

userSpecifiedCurrencyPremiumModifier

Premium modifiers in user specified currency

number

userSpecifiedCurrencyPromotionalModifier

Promotional modifiers in user specified currency

number

userSpecifiedCurrencyTotal

Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

pricingType

required

How this inventory item should be priced.

string

promotion

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.

string

ratePlanIds

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.

Array<string>

roomTypeIds

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.

Array<string>

ratePlan

required

Specified rate plan

object

allInclusive

required

Everything included except alcohol

boolean

allInclusivePlusAlcohol

required

Everything included with alcohol

boolean

breakfast

required

When true, indicates breakfast is included.

boolean

brunch

required

When true, indicates brunch is included.

boolean

dinner

required

When true, indicates dinner is included.

boolean

earlyCheckInCharge

identifier

required

Rate plan identifier

string format: uuid

>= 1 characters

lateCheckOutCharge

lunch

required

When true, indicates lunch is included.

boolean

name

required

Provides the name of the rate plan.

string

>= 1 characters

rateSource

string

roomNights

required

Number of nights the guests will be staying

integer format: int32

roomRateIdentifier

required

Specified master rate identifier

string

roomRateInternalName

required

Specified master rate internal name

string

sourceTotal

Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

startDate

required

SimpleDateTimeItinerary startDate

string format: date

userSpecifiedCurrencyTotal

Monetary amount with an associated ISO 4217 currency code, used at API boundaries where JSON-friendly serialization is needed

object

amount

required

Monetary amount value

number

currency

required

ISO 4217 currency code

string

>= 1 characters /^[A-Z]{3}$/

roomTypeIdentifier

required

Room type identifier.

string format: uuid

sort

required

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.

integer format: int32

roomTypeList

required

Unique property room types

Array<object>

A lightweight projection of a room type, carrying all occupancy, bedroom configuration, pricing and classification details needed for availability and booking flows.

object

active

required

Modify blocking availability with this flag.

boolean

default: true

address

required

Defaults to property address.

object

address1

Address line 1

string

address2

Address line 2

string

city

City name

string

country

Country

string

countryCode

Country

string

/^[A-Z]{2}$/

county

County

string

fullAddress

Address 1, Address 2, City, State, Postal / Zip code, Country

string

postalCode

Postal / zip code

string

state

State

string

amenities

OpenTravel room amenity codes (e.g., 1=Balcony, 7=Air Conditioning). See OTA geoname data

Array<string>

bathroomCount

required

Number of bathrooms

integer format: int32

default: 1

bedroomConfigurationList

required

A room type can have more than one bed configuration.

Array<object>

>= 1 items

A named bedroom layout configuration for a room type, containing one or more bedrooms each with their own bed setup.

object

bedroomList

required

List of bedrooms within this configuration layout.

Array<object>

>= 1 items

A single bedroom within a room type, specifying the bedroom type and its bed configuration.

object

bedList

required

List of bed configurations for this bedroom. Each entry specifies a bed type and quantity.

Array<object>

>= 1 items

A single bed type and its quantity within a bedroom, described using the OpenTravel bed type code.

object

bedTypeCode

required

OpenTravel bed type code (e.g., 1=Double, 2=Twin, 7=Queen, 8=King). See OTA geoname data.

string

>= 1 characters

quantity

required

Number of beds of this type in the room.

integer format: int32

>= 1

type

required

Bedroom type classification (e.g., MASTER, QUEEN, JUNIOR, DORMITORY, BEDROOM_1…BEDROOM_10).

string

Allowed values: MASTER QUEEN JUNIOR DORMITORY BEDROOM_1 BEDROOM_2 BEDROOM_3 BEDROOM_4 BEDROOM_5 BEDROOM_6 BEDROOM_7 BEDROOM_8 BEDROOM_9 BEDROOM_10

identifier

required

Unique identifier for this bedroom configuration layout.

string format: uuid

>= 1 characters

name

required

Human-readable name of this room layout configuration.

string

>= 1 characters

bookable

required

Indicates if this inventory can be added to a booking or if it is read-only marketing material only.

boolean

default: true

commissionable

required

Indicate whether sales channels receive commission for selling this inventory.

boolean

default: true

composite

required

Indicates that the room (suite) is a composite of smaller units.

boolean

compositeCount

required

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.

integer format: int32

contact

required

Associate a contact person for this inventory (if applicable).

object

email

Contact E-mail

string format: email

firstName

Contact first name

string

fullName

First and last name

string

lastName

Contact last name

string

phoneNumber

Contact phone number

string

/^\+?[1-9]\d{1,14}$/

secondaryEmail

Contact secondary Email

string format: email

summary

Summary

string

createdDate

Datetime this record was first created

string | null format: date-time

descriptions

required

Localized descriptions describing inventory.

Array<object>

>= 1 items

Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.

object

description

required

Longer text description

string

>= 1 characters <= 2147483647 characters

language

required

Indicate which language this description is written in.

string

default: en >= 2 characters <= 2 characters /^[a-z]{2}(-[A-Z]{2})?$/

name

required

Use as title or short text description

string

disabilityFeatures

Supported OTA specification PHY code. See OTA geoname data

Array<string>

featuredInd

required

Indicates whether this inventory is featured. Use this flag as a way to signify that this inventory is special.

boolean

floor

Floor number on which this room type is located.

string

hotelIdentifier

required

Hotel identifier.

string format: uuid

>= 1 characters

required

Unique identifier for this record.

string format: uuid

>= 1 characters

includedAdultOccupancy

required

The number of pax the room price was meant for

integer format: int32

default: 2

includedChildOccupancy

required

The number of children the room price was meant for

integer format: int32

lastUpdate

Datetime this record was last updated

string | null format: date-time

lifestyleType

Indicate the type of lifestyle this inventory should be associated with.

string

livingRoomCount

required

Number of living rooms

integer format: int32

default: 1

location

required

Geo-location point where blocking takes place. Defaults to location of property.

object

coordinates

Array<number>

type

string

number format: double

maxAdultOccupancy

required

Maximum number of adults allowed in a room type.

integer format: int32

default: 2 >= 1

maxChildOccupancy

required

Maximum number of children allowed in a room type.

integer format: int32

maxCribs

required

Maximum number of cribs allowed in a room type.

integer format: int32

maxOccupancy

required

Maximum number of guest allowed in a room type.

integer format: int32

default: 2 >= 1

maxRollaways

required

Maximum number of rollaway beds allowed in this room type.

integer format: int32

minAgeAppropriateCode

Supported OTA specification AQC code. See OTA geoname data

string

minOccupancy

required

Minimum number of guests allowed in a room type.

integer format: int32

default: 1 >= 1

multimedias

required

List of images / videos of blocking.

Array<object>

>= 1 items

An image or video of a property or one of its facilities, with ready-to-use delivery URLs.

object

attribution

Whether image has attribution properties

Array<object>

object

name

required

Name of contributor

string

>= 1 characters

url

URL to contributor

string format: uri

category

Supported OTA specification PIC code. See OTA geoname data

string

descriptions

Localized media captions to give user some context about where this media was taken.

Array<object>

Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.

object

description

required

Longer text description

string

>= 1 characters <= 2147483647 characters

language

required

Indicate which language this description is written in.

string

default: en >= 2 characters <= 2 characters /^[a-z]{2}(-[A-Z]{2})?$/

name

required

Use as title or short text description

string

entityId

required

Cloudinary public id; build your own delivery URLs from it

string

height

required

Media height in pixels.

integer format: int32

>= 1

identifier

required

Deprecated, use entityId. Same value; will be removed.

string

>= 1 characters

lifestyleType

Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.

string

sort

required

Sort allows you to control how you want to sort this record in a list of media records.

integer format: int32

default: 999

source

required

Currently ONLY using Cloudinary to store all image / video assets.

string

default: CLOUDINARY

Allowed values: YOUTUBE CLOUDINARY

type

required

Whether Cloudinary media is a VIDEO or IMAGE.

string

Allowed values: IMAGE VIDEO AUDIO RAW

urls

Ready-to-use delivery URLs. Absent when no URL applies to this asset.

object

external

Watch URL for media hosted outside our CDN (for example YouTube).

string

large

Image scaled to at most 1920px wide.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

medium

Image scaled to at most 1024px wide.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

original

Full-size image, not resized.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

poster

Still frame to show before the video plays.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

preview

Short low-bandwidth video preview.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

stream

Video stream at full size.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

thumbnail

Small still, at most 320px wide. For videos this is a frame of the video.

object

format

Delivery format label of this variant.

string

maxWidth

Maximum width in pixels of this variant. Absent when the variant is not resized.

integer format: int32

url

Absolute HTTPS URL that can be used directly in an img/video tag.

string

width

required

Media width in pixels.

integer format: int32

>= 1

name

required

Internal name of inventory.

string

>= 1 characters

nonSmoking

required

Non-smoking indicator

boolean

pricePoint

required

Level of expensiveness.

string

default: THREE

Allowed values: HALF ONE ONE_HALF TWO TWO_HALF THREE THREE_HALF FOUR FOUR_HALF FIVE

proximityCode

required

Supported OTA specification PRX code. See OTA geoname data

string

publishStatus

Publish lifecycle state: DRAFT (incomplete, not announced) or PUBLISHED (complete/live).

string

Allowed values: DRAFT PUBLISHED

quantity

required

Defines the number of rooms of this type

integer format: int32

>= 1

recognitionList

Inventory-level recognition.

Array<object>

Recognition for the ancillary blocking.

object

category

required

Recognition category.

string

Allowed values: THIRD_PARTY_REVIEW PUBLICATION AWARD

date

The date the award was received

string format: date

identifier

required

Recognition identifier.

string format: uuid

>= 1 characters

maxRating

required

Use this to let hotels indicate what the total score for this award is.

number format: float

officialAppointmentInd

boolean

provider

required

The name of the entity that administers this recognition.

string

>= 1 characters

rating

required

The actual award or rating received by the hotel facility.

number format: float

ratingSymbol

Provides the symbol used in the rating. Used in conjunction with the Rating.

string

type

required

Type of rating system the recognition operated on. This allows us to display the score properly.

string

Allowed values: STAR_RATING NUMERIC_RATING PERCENT_RATING

roomArchitectureCode

required

OpenTravel architectural style code (e.g., 1=Modern, 2=Traditional, 3=Victorian). See OTA geoname data

string

>= 1 characters

roomCategory

required

OpenTravel segment category code (e.g., 1=Moderate, 4=Standard, 8=Deluxe). See OTA geoname data

string

>= 1 characters

roomClassificationCode

required

OpenTravel guest room info code (e.g., 1=Suite, 2=Standard, 12=Villa, 16=Bungalow). See OTA geoname data

string

>= 1 characters

roomGender

Used to request or specify a gender assignment for a room. Note: Typically used by Hosteliers.

string

default: Unknown

Allowed values: Male Female MaleAndFemale Unknown

roomLocationCode

required

OpenTravel room location type code (e.g., 1=Near Exit, 2=Close to Elevator, 3=Low Floor, 4=High Floor). See OTA geoname data

string

>= 1 characters

roomViewCode

required

OpenTravel room view type code (e.g., 1=Ocean View, 2=Pool View, 3=Garden View). See OTA geoname data

string

>= 1 characters

securityFeatures

Supported OTA specification SEC code. See OTA geoname data

Array<string>

sharedRoomInd

required

If TRUE, the room requires or has sharing available. Note: Typically used by Hosteliers.

boolean

size

required

Number of square meters that defines the size of this room type.

number format: float

>= 1

socials

Social network accounts for blocking (if applicable).

Array<object>

Social network

object

location

URL or social network identifier to social network profile

string

type

Type of social network.

string

Allowed values: FACEBOOK INSTAGRAM SKYPE TRIP_ADVISOR TWITTER GOOGLE_PLUS WHATSAPP LINE WECHAT VIBER SNAPCHAT WEIBO RENREN WEBSITE QQ TIKTOK

sort

Use this property to sort an blocking in a list of activities.

integer format: int32

version

integer | null format: int64

sourceToInternalCurrencyQuote

required

Exchange rate quote between the property’s source currency and the user’s currency that was used to populate price.

object

exchangeRate

required

Exchange rate from source to target currency

number

source

required

ISO 4217 source currency code

string

>= 1 characters

target

required

ISO 4217 target currency code

string

>= 1 characters

timestamp

required

Unix epoch milliseconds when the quote was recorded

integer format: int64

sourceToUserCurrencyQuote

required

Exchange rate quote between the property’s source currency and the user’s desired currency that was used to populate price.

object

exchangeRate

required

Exchange rate from source to target currency

number

source

required

ISO 4217 source currency code

string

>= 1 characters

target

required

ISO 4217 target currency code

string

>= 1 characters

timestamp

required

Unix epoch milliseconds when the quote was recorded

integer format: int64

first

Whether this is the first page.

boolean

last

Whether this is the last page.

boolean

number

Zero-based index of this page.

integer format: int32

numberOfElements

Number of elements on this page.

integer format: int32

size

The requested page size.

integer format: int32

totalElements

Total number of elements across all pages.

integer format: int64

totalPages

Total number of pages for the current page size.

integer format: int32

Example

{
  "content": [
    {
      "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": [
          {
            "entityId": "the-siam-residences/lobby-entrance",
            "identifier": "the-siam-residences/lobby-entrance",
            "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": {
          "email": "[email protected]",
          "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": [
                  {
                    "attribution": [],
                    "category": "2",
                    "descriptions": [
                      {
                        "description": "Elegant lobby of The Siam Residences",
                        "language": "en",
                        "title": "Lobby Entrance"
                      }
                    ],
                    "entityId": "the-siam-residences/lobby-entrance",
                    "height": 1600,
                    "identifier": "the-siam-residences/lobby-entrance",
                    "lifestyleType": null,
                    "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": [
                    {
                      "attribution": [],
                      "category": "2",
                      "descriptions": [
                        {
                          "description": "Elegant lobby of The Siam Residences",
                          "language": "en",
                          "title": "Lobby Entrance"
                        }
                      ],
                      "entityId": "the-siam-residences/lobby-entrance",
                      "height": 1600,
                      "identifier": "the-siam-residences/lobby-entrance",
                      "lifestyleType": null,
                      "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": [
                {
                  "attribution": [],
                  "category": "2",
                  "descriptions": [
                    {
                      "description": "Elegant lobby of The Siam Residences",
                      "language": "en",
                      "title": "Lobby Entrance"
                    }
                  ],
                  "entityId": "the-siam-residences/lobby-entrance",
                  "height": 1600,
                  "identifier": "the-siam-residences/lobby-entrance",
                  "lifestyleType": null,
                  "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": {
            "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": [
                {
                  "attribution": [],
                  "category": "2",
                  "descriptions": [
                    {
                      "description": "Elegant lobby of The Siam Residences",
                      "language": "en",
                      "title": "Lobby Entrance"
                    }
                  ],
                  "entityId": "the-siam-residences/lobby-entrance",
                  "height": 1600,
                  "identifier": "the-siam-residences/lobby-entrance",
                  "lifestyleType": null,
                  "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": [
                    {
                      "attribution": [],
                      "category": "2",
                      "descriptions": [
                        {
                          "description": "Elegant lobby of The Siam Residences",
                          "language": "en",
                          "title": "Lobby Entrance"
                        }
                      ],
                      "entityId": "the-siam-residences/lobby-entrance",
                      "height": 1600,
                      "identifier": "the-siam-residences/lobby-entrance",
                      "lifestyleType": null,
                      "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": [
                      {
                        "attribution": [],
                        "category": "2",
                        "descriptions": [
                          {
                            "description": "Elegant lobby of The Siam Residences",
                            "language": "en",
                            "title": "Lobby Entrance"
                          }
                        ],
                        "entityId": "the-siam-residences/lobby-entrance",
                        "height": 1600,
                        "identifier": "the-siam-residences/lobby-entrance",
                        "lifestyleType": null,
                        "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": [
                  {
                    "attribution": [],
                    "category": "2",
                    "descriptions": [
                      {
                        "description": "Elegant lobby of The Siam Residences",
                        "language": "en",
                        "title": "Lobby Entrance"
                      }
                    ],
                    "entityId": "the-siam-residences/lobby-entrance",
                    "height": 1600,
                    "identifier": "the-siam-residences/lobby-entrance",
                    "lifestyleType": null,
                    "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": {
              "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": [
                  {
                    "attribution": [],
                    "category": "2",
                    "descriptions": [
                      {
                        "description": "Elegant lobby of The Siam Residences",
                        "language": "en",
                        "title": "Lobby Entrance"
                      }
                    ],
                    "entityId": "the-siam-residences/lobby-entrance",
                    "height": 1600,
                    "identifier": "the-siam-residences/lobby-entrance",
                    "lifestyleType": null,
                    "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": {
            "email": "[email protected]",
            "firstName": "Alexandra",
            "fullName": "Alexandra Beaumont",
            "lastName": "Beaumont",
            "phoneNumber": "+12125551212",
            "secondaryEmail": "[email protected]",
            "summary": "John Smith ([email protected] / +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": [
            {
              "attribution": [],
              "category": "2",
              "descriptions": [
                {
                  "description": "Elegant lobby of The Siam Residences",
                  "language": "en",
                  "title": "Lobby Entrance"
                }
              ],
              "entityId": "the-siam-residences/lobby-entrance",
              "height": 1600,
              "identifier": "the-siam-residences/lobby-entrance",
              "lifestyleType": null,
              "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
      }
    }
  ],
  "first": true,
  "last": false,
  "number": 0,
  "numberOfElements": 20,
  "size": 20,
  "totalElements": 1234,
  "totalPages": 62
}

400

Bad Request — missing or invalid request parameter or body

application/problem+json

object

detail

string

instance

string format: uri

properties

object

key

additional properties

status

integer format: int32

title

string

type

string format: uri

Example ^generated

{
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  },
  "status": 1,
  "title": "example",
  "type": "https://example.com"
}

401

Unauthorized — authentication is required or the session has expired

application/problem+json

object

detail

string

instance

string format: uri

properties

object

key

additional properties

status

integer format: int32

title

string

type

string format: uri

Example ^generated

{
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  },
  "status": 1,
  "title": "example",
  "type": "https://example.com"
}

403

Forbidden — authenticated but lacking the required permission or scope

application/problem+json

object

detail

string

instance

string format: uri

properties

object

key

additional properties

status

integer format: int32

title

string

type

string format: uri

Example ^generated

{
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  },
  "status": 1,
  "title": "example",
  "type": "https://example.com"
}

404

Not Found — the requested resource does not exist

application/problem+json

object

detail

string

instance

string format: uri

properties

object

key

additional properties

status

integer format: int32

title

string

type

string format: uri

Example ^generated

{
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  },
  "status": 1,
  "title": "example",
  "type": "https://example.com"
}

405

Method Not Allowed — the HTTP verb is not supported on this endpoint

application/problem+json

object

detail

string

instance

string format: uri

properties

object

key

additional properties

status

integer format: int32

title

string

type

string format: uri

Example ^generated

{
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  },
  "status": 1,
  "title": "example",
  "type": "https://example.com"
}

409

Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version

application/problem+json

object

detail

string

instance

string format: uri

properties

object

key

additional properties

status

integer format: int32

title

string

type

string format: uri

Example ^generated

{
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  },
  "status": 1,
  "title": "example",
  "type": "https://example.com"
}

415

Unsupported Media Type — use application/json

application/problem+json

object

detail

string

instance

string format: uri

properties

object

key

additional properties

status

integer format: int32

title

string

type

string format: uri

Example ^generated

{
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  },
  "status": 1,
  "title": "example",
  "type": "https://example.com"
}

500

Internal Server Error — an unexpected failure occurred on the server

application/problem+json

object

detail

string

instance

string format: uri

properties

object

key

additional properties

status

integer format: int32

title

string

type

string format: uri

Example ^generated

{
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  },
  "status": 1,
  "title": "example",
  "type": "https://example.com"
}

503

Service Unavailable — a downstream dependency is unreachable

application/problem+json

object

detail

string

instance

string format: uri

properties

object

key

additional properties

status

integer format: int32

title

string

type

string format: uri

Example ^generated

{
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  },
  "status": 1,
  "title": "example",
  "type": "https://example.com"
}

By filters

Authorizations

Parameters

Path Parameters

Example

Query Parameters

Example

Header Parameters

Request Bodyrequired

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Responses

200

Example

400

Example generated

401

Example generated

403

Example generated

404

Example generated

405

Example generated

409

Example generated

415

Example generated

500

Example generated

503

Example generated

Request Body^required

Example ^generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated