Skip to content

Property content

GET
/api/public/{managingEntityIdentifier}/inventory/content
curl --request GET \
--url 'https://api.wink.travel/api/public/d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69/inventory/content?hotelIdentifier=e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18&customizationIdentifier=2c5b9e3a-7f1d-4a8c-b6e2-0d4f1a9b3c72&language=en&include=PROPERTY_DETAILS%2CROOM_TYPE&maxMedia=20' \
--header 'Authorization: Bearer <token>' \
--header 'Wink-Version: 2.0'

Return one property’s static content without availability or rates, in the same shape as the Partner API’s Content.GetProperty (camelCase). Identify the property with urlName or hotelIdentifier (exactly one of the two; giving neither or both is a 400). A property is served only when it is available and the managing entity in the path has an active sales channel for it; otherwise the answer is a 404, identical to an unknown property. By default only the basics (identity, location and media) are returned: ask for more with include, a comma-separated list or repeated parameter of PROPERTY_DETAILS, RESTAURANT, SPA, MEETING_ROOM, ACTIVITY, ATTRACTION, PLACE, CANCELLATION_POLICY, PERK, ROOM_TYPE and RATE_PLAN (case-insensitive; an unknown name is a 400). includedScopes in the response states which collections were populated. maxMedia caps the images and, separately, the videos of every entity (0 = no cap). The response carries contentVersion and cacheToken, and an ETag equal to the quoted cacheToken with Cache-Control: no-cache; send the ETag back in If-None-Match to receive 304 Not Modified while the content is unchanged.

managingEntityIdentifier
required
string

Managing entity identifier

Example

d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69
hotelIdentifier
string
0 <= 64 characters /(?s).*\S.*/

Property identifier; give this or urlName, not both

Example

e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18
urlName
string
0 <= 200 characters /(?s).*\S.*/

Property url-friendly name; give this or hotelIdentifier, not both

customizationIdentifier
string

Booking engine customization identifier; accepted for parity with the other inventory endpoints and currently unused

Example

2c5b9e3a-7f1d-4a8c-b6e2-0d4f1a9b3c72
language
string
default: en 0 <= 35 characters /(?s).*\S.*/

Language to return descriptions in; English is always included. Defaults to en

Example

en
include
Array<string>

Scopes to populate beyond the basics: PROPERTY_DETAILS, RESTAURANT, SPA, MEETING_ROOM, ACTIVITY, ATTRACTION, PLACE, CANCELLATION_POLICY, PERK, ROOM_TYPE, RATE_PLAN, RECOGNITION, GREEN_INDEX, ADD_ON. Comma-separated or repeated; case-insensitive. Omit for the basics only

Example

PROPERTY_DETAILS,ROOM_TYPE
maxMedia
integer format: int32
default: 20

Maximum number of images, and of videos, returned per entity; 0 returns everything

Example

20
If-None-Match
string

ETag from a previous response; when it still matches, 304 Not Modified is returned without a body

Wink-Version
string
default: 2.0.0
Allowed values: 2.0

The property content. Carries an ETag (quoted cacheToken) and Cache-Control: no-cache, so clients may store it but must revalidate.

Media typeapplication/json

A property’s static content: identity, media, optional details and venue collections, bookable room types, rate plans, policies and perks. Carries no prices and no availability.

object
activities
Array<object>
object
accessibilityFeatures
Array<string>
address

Address information

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
Array<string>
closes
string
daysOfWeek
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
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
id
string
lifestyleType

Specific lifestyle preference type used to match travelers with suitable inventory

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
location
object
coordinates
Array<number>
type
string
x
number format: double
y
number format: double
minAgeAppropriateCode
string
multimedias
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
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
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
string
onPremises
boolean
opens
string
otaAmenityTable
string
proximityCode
string
reservationRequiredInd
boolean
securityFeatures
Array<string>
sort
integer format: int32
venueDetails
One of:
object
type
required
string
attractionCategoryCode
string
addOns

The property’s add-ons as static content: name, localized descriptions, media, category, sort, whether mandatory, and the room types, rate plans and dates they are restricted to (empty means all). No prices and no availability: those are on the priced offers, which carry addOnId equal to this id. Present only with the ADD_ON scope and omitted when the property has none sellable; unpublished and inactive add-ons, and those under an inactive venue, are never returned; includedScopes says whether it was asked for.

Array<object>
object
category

Type of sellable travel inventory on the Wink platform

string
Allowed values: GUEST_ROOM ADD_ON MEETING_ROOM RESTAURANT SPA ATTRACTION PLACE ACTIVITY
dateRanges
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
descriptions
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
id
string
mandatory
boolean
multimedias
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
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
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
string
ratePlanIds
Array<string>
roomTypeIds
Array<string>
sort
integer format: int32
attractions
Array<object>
object
accessibilityFeatures
Array<string>
address

Address information

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
Array<string>
closes
string
daysOfWeek
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
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
id
string
lifestyleType

Specific lifestyle preference type used to match travelers with suitable inventory

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
location
object
coordinates
Array<number>
type
string
x
number format: double
y
number format: double
minAgeAppropriateCode
string
multimedias
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
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
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
string
onPremises
boolean
opens
string
otaAmenityTable
string
proximityCode
string
reservationRequiredInd
boolean
securityFeatures
Array<string>
sort
integer format: int32
venueDetails
One of:
object
type
required
string
attractionCategoryCode
string
cacheToken

Opaque token identifying this representation; equals the ETag value, unquoted.

string
cancellationPolicies
Array<object>
object
advanceCancellationFreeOfCharge
string
freeCancellationDaysBefore
integer format: int32
id
string
noShowCharge
string
nonRefundableAfterDeadlineCancellationCharge
string
nonRefundableCancellationCharge
string
nonRefundableDeadline
string
policyCode
string
refundable
boolean
refundableCancellationCharge
string
contentVersion

Stable hash of the content; equal for equal content.

string
counts

The property’s stored totals, regardless of the requested scopes.

object
activities
integer format: int32
addOns
integer format: int32
attractions
integer format: int32
meetingRooms
integer format: int32
places
integer format: int32
restaurants
integer format: int32
spas
integer format: int32
details

Property details; only with the PROPERTY_DETAILS scope.

object
address

Address information

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
number format: float
aggregateReviewRating
number format: float
architecturalStyle
string
brand
string
chain
string
descriptions
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
lifestyleTypes
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
locationCategory
string
metadata
Array<object>
object
key
string
type
string
value
string
otaHacAmenityCodes
Array<string>
otaPhyAccessibilityCodes
Array<string>
otaSecSecurityCodes
Array<string>
policy

Outlines basic policies for the property.

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
propertyCategory
string
reservations
object
email
string
phoneNumber
string
segmentCategory
string
socials
Array<object>
object
location
string
type

Social media platform type with associated Font Awesome icon class

string
Allowed values: FACEBOOK INSTAGRAM SKYPE TRIP_ADVISOR TWITTER GOOGLE_PLUS WHATSAPP LINE WECHAT VIBER SNAPCHAT WEIBO RENREN WEBSITE QQ TIKTOK
totalReviews
integer format: int32
whenBuilt
string
greenIndexScores

Aggregate Green Index scores, overall and per category. Present only with the GREEN_INDEX scope and omitted when the property has not answered the index; includedScopes says whether it was asked for.

object
aggregateScore
number format: float
highScore
integer format: int32
hotelIdentifier
string
scoresByCategory
Array<object>
object
aggregateScore
number format: float
category
string
highScore
integer format: int32
totalScore
integer format: int32
totalScore
integer format: int32
includedScopes

The scopes actually populated. A collection that is empty and whose scope is not listed here was not requested.

Array<string>
Allowed values: PROPERTY_DETAILS RESTAURANT SPA MEETING_ROOM ACTIVITY ATTRACTION PLACE CANCELLATION_POLICY PERK ROOM_TYPE RATE_PLAN RECOGNITION GREEN_INDEX ADD_ON
meetingRooms
Array<object>
object
accessibilityFeatures
Array<string>
address

Address information

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
Array<string>
closes
string
daysOfWeek
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
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
id
string
lifestyleType

Specific lifestyle preference type used to match travelers with suitable inventory

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
location
object
coordinates
Array<number>
type
string
x
number format: double
y
number format: double
minAgeAppropriateCode
string
multimedias
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
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
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
string
onPremises
boolean
opens
string
otaAmenityTable
string
proximityCode
string
reservationRequiredInd
boolean
securityFeatures
Array<string>
sort
integer format: int32
venueDetails
One of:
object
type
required
string
attractionCategoryCode
string
perks
Array<object>
object
descriptions
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
guaranteed
boolean
id
string
level
integer format: int32
sort
integer format: int32
places
Array<object>
object
accessibilityFeatures
Array<string>
address

Address information

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
Array<string>
closes
string
daysOfWeek
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
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
id
string
lifestyleType

Specific lifestyle preference type used to match travelers with suitable inventory

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
location
object
coordinates
Array<number>
type
string
x
number format: double
y
number format: double
minAgeAppropriateCode
string
multimedias
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
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
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
string
onPremises
boolean
opens
string
otaAmenityTable
string
proximityCode
string
reservationRequiredInd
boolean
securityFeatures
Array<string>
sort
integer format: int32
venueDetails
One of:
object
type
required
string
attractionCategoryCode
string
property

Property identity, location and media.

object
city

GeoNames have been created at https://geonames.org and contain geographical destinations we use as geoname data to associate travel inventory with a 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
x
number format: double
y
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
string
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
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
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
localName
string
location
object
coordinates
Array<number>
type
string
x
number format: double
y
number format: double
name
string
numberOfRooms
integer format: int32
propertyId
string
starRating
integer format: int32
uniqueId
string
urlName
string
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
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
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
propertyId

The property identifier as requested.

string
ratePlans
Array<object>
object
allInclusive
boolean
allInclusivePlusAlcohol
boolean
breakfast
boolean
brunch
boolean
cancellationPolicyId
string
dinner
boolean
id
string
lunch
boolean
name
string
prepaid
boolean
recognitions

Awards, certifications and third-party ratings. Present only with the RECOGNITION scope and omitted when the property holds none; recognitions the provider has not authorised the property to publish are never returned; includedScopes says whether it was asked for.

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
restaurants
Array<object>
object
accessibilityFeatures
Array<string>
address

Address information

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
Array<string>
closes
string
daysOfWeek
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
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
id
string
lifestyleType

Specific lifestyle preference type used to match travelers with suitable inventory

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
location
object
coordinates
Array<number>
type
string
x
number format: double
y
number format: double
minAgeAppropriateCode
string
multimedias
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
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
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
string
onPremises
boolean
opens
string
otaAmenityTable
string
proximityCode
string
reservationRequiredInd
boolean
securityFeatures
Array<string>
sort
integer format: int32
venueDetails
One of:
object
type
required
string
attractionCategoryCode
string
roomTypes
Array<object>
object
accessibilityFeatures
Array<string>
amenities
Array<string>
bathroomCount
integer format: int32
bedConfigurations
Array<object>

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
descriptions
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
floor
string
id
string
includedAdultOccupancy
integer format: int32
includedChildOccupancy
integer format: int32
livingRoomCount
integer format: int32
maxAdultOccupancy
integer format: int32
maxChildOccupancy
integer format: int32
maxCribs
integer format: int32
maxOccupancy
integer format: int32
maxRollaways
integer format: int32
minOccupancy
integer format: int32
multimedias
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
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
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
string
nonSmoking
boolean
quantity
integer format: int32
roomArchitectureCode
string
roomCategory
string
roomClassificationCode
string
roomGender

Gender assignment for a room. Typically used by hosteliers offering dorm-style or gender-segregated accommodation.

string
Allowed values: Male Female MaleAndFemale Unknown
roomLocationCode
string
roomViewCode
string
securityFeatures
Array<string>
sharedRoomInd
boolean
size
number format: double
sort
integer format: int32
spas
Array<object>
object
accessibilityFeatures
Array<string>
address

Address information

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
Array<string>
closes
string
daysOfWeek
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
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
id
string
lifestyleType

Specific lifestyle preference type used to match travelers with suitable inventory

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
location
object
coordinates
Array<number>
type
string
x
number format: double
y
number format: double
minAgeAppropriateCode
string
multimedias
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
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
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
string
onPremises
boolean
opens
string
otaAmenityTable
string
proximityCode
string
reservationRequiredInd
boolean
securityFeatures
Array<string>
sort
integer format: int32
venueDetails
One of:
object
type
required
string
attractionCategoryCode
string
status

OK when the entry carries content.

string
Allowed values: OK NOT_FOUND NOT_MODIFIED

Example

{
"activities": [
{
"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"
},
"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"
}
],
"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
}
]
}
],
"addOns": [
{
"category": "GUEST_ROOM",
"dateRanges": [
{
"endDate": "2020-12-31",
"startDate": "2020-12-24"
}
],
"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"
}
],
"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
}
]
}
],
"attractions": [
{
"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"
},
"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"
}
],
"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
}
]
}
],
"details": {
"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"
},
"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"
}
],
"policy": {
"checkInTime": "14:00",
"checkOutTime": "10:00",
"childrenAllowed": true,
"childrenMinimumAge": 6,
"internetAvailability": "YES",
"internetConnectionLocation": "ENTIRE_PROPERTY",
"internetConnectionType": "WIFI",
"parkingAccess": "PRIVATE",
"parkingAvailability": "YES",
"petCharge": {
"amount": 500,
"currency": "THB"
},
"petMaxWeightInKilos": 10,
"petsAllowed": true
}
},
"meetingRooms": [
{
"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"
},
"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"
}
],
"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
}
]
}
],
"perks": [
{
"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"
}
]
}
],
"places": [
{
"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"
},
"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"
}
],
"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
}
]
}
],
"property": {
"city": {
"admin1Code": "40",
"admin2Code": "2401",
"admin3Code": "",
"admin4Code": "",
"alternateCountryCodes": [],
"alternateNames": [
"Krung Thep",
"BKK"
],
"asciiName": "Bangkok",
"country": {
"area": 514000,
"capital": "Bangkok",
"continent": "AS",
"currencyCode": "THB",
"currencyName": "Baht",
"fips": "TH",
"geoNameId": "1605651",
"iso": "TH",
"iso3": "THA",
"isoNumeric": 764,
"languages": [
"th"
],
"name": "Thailand",
"neighbors": [
"LA",
"MM",
"KH",
"MY"
],
"phone": "66",
"population": 69428524,
"postalCodeFormat": "#####",
"postalCodeRegEx": "^(\\d{5})$",
"topLevelDomain": ".th"
},
"countryCode": "TH",
"digitalElevationModel": "3",
"elevation": 5,
"featureClass": "P",
"featureCode": "PPLC",
"geoNameId": "1609350",
"location": {
"coordinates": [
100.5581533,
13.7370197
],
"type": "POINT"
},
"modificationDate": "2023-06-15",
"name": "Bangkok",
"population": 10539415,
"radiusInMeters": 50000,
"subCountry": {
"asciiName": "Bangkok",
"code": "TH.40",
"countryCode": "TH",
"geoNameId": "1609350",
"name": "Bangkok",
"subCountryCode": "40"
},
"subSubCountry": {
"asciiName": "Bangkok District",
"code": "TH.40.2401",
"countryCode": "TH",
"geoNameId": "1609352",
"name": "Bangkok District",
"subCountryCode": "40",
"subSubCountryCode": "2401"
},
"timezone": "Asia/Bangkok",
"type": "CITY",
"urlName": "bangkok-thailand"
},
"images": [
{
"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
}
],
"videos": [
{
"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
}
]
},
"recognitions": [
{
"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"
}
],
"restaurants": [
{
"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"
},
"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"
}
],
"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
}
]
}
],
"roomTypes": [
{
"bedConfigurations": [
{
"bedroomList": [
{
"bedList": [
{
"bedTypeCode": "1",
"quantity": 2
}
],
"type": "MASTER"
}
],
"identifier": "b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47",
"name": "Master Suite Layout"
}
],
"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"
}
],
"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
}
]
}
],
"spas": [
{
"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"
},
"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"
}
],
"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
}
]
}
]
}
Cache-Control
string

Always no-cache: store, but revalidate before reuse

ETag
string

Quoted cacheToken of this representation; send it back in If-None-Match

Not Modified: the If-None-Match value matches the current ETag (a comma-separated list, weak W/ validators and * are honoured). No body; the ETag and Cache-Control headers are repeated.

Cache-Control
string

Always no-cache

ETag
string

Quoted cacheToken of the current representation

Bad Request — missing or invalid request parameter or body

Media typeapplication/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"
}

Unauthorized — authentication is required or the session has expired

Media typeapplication/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"
}

Forbidden — authenticated but lacking the required permission or scope

Media typeapplication/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"
}

Not Found — the requested resource does not exist

Media typeapplication/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"
}

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

Media typeapplication/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"
}

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

Media typeapplication/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"
}

Unsupported Media Type — use application/json

Media typeapplication/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"
}

Internal Server Error — an unexpected failure occurred on the server

Media typeapplication/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"
}

Service Unavailable — a downstream dependency is unreachable

Media typeapplication/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"
}