Skip to content

By saved search

GET
/api/managing-entity/{managingEntityIdentifier}/studio/browse/inventory/grid/{dynamicListIdentifier}
curl --request GET \
--url 'https://api.wink.travel/api/managing-entity/owner-1/studio/browse/inventory/grid/dynamic-list-1?page=0&size=20&displayCurrency=USD' \
--header 'Authorization: Bearer <token>' \
--header 'Wink-Version: 2.0'

Returns a paginated grid by replaying a previously saved dynamic list definition.

managingEntityIdentifier
required
string
""

Browse inventory on behalf of this owner identifier.

Example
owner-1
dynamicListIdentifier
required
string
""

Browse inventory on behalf of this dynamic list identifier.

Example
dynamic-list-1
page
string
""

Skip to page.

Example
0
size
string
"" <= 100

Limit the size of results.

Example
20
displayCurrency
string
""

Indicate which currency to display prices in.

Example
USD
Wink-Version
string
default: 2.0.0
Allowed values: 2.0

OK

Media type application/json
object
totalElements
integer format: int64
totalPages
integer format: int32
size
integer format: int32
content
Array<object>

Lightweight aggregated inventory record joining inventory data with a lightweight hotel summary (PropertyAggregateLightweight), used as the result of a MongoDB aggregation pipeline.

object
id

Document UUID

string format: uuid
""
createdDate

Datetime this record was first created

string format: date-time
""
lastUpdate

Datetime this record was last updated

string format: date-time
""
version

Version property that shows how many times this document has been persisted. Document will not persist if the version property is less than current version property in the system. Result in an optimistic locking exception.

integer format: int64
""
salesChannel
required

Parent sales channel

object
identifier
required

Unique record identifier of this segment / account

string format: uuid
"" >= 1 characters
supplierIdentifier
required

Channel is owned by this supplier identifier.

string format: uuid
"" >= 1 characters
supplierName
required

Name of property / supplier that owns this channel

string
"" >= 1 characters
supplierAvailable
required

Flag when supplier not available. E.g. Hotel disables property

boolean
default: true
subType
required

What type of segment of channel is this.

string
""
Allowed values: TRIP_PAY FACILITATOR DIRECT APPLICATION HOTEL TRAVELIKO CORPORATE TRAVEL_AGENT INFLUENCER BLOGGER DESTINATION CHANNEL_MANAGER PROPERTY_MANAGEMENT_SYSTEM CENTRAL_RESERVATION_SYSTEM GOOGLE_HOTEL_API MANAGEMENT_COMPANY CHAIN BRAND EVENT_ORGANIZER OTHER
ownerIdentifier

A specific identifier for the company / corporation / travel agency that is retrieving the rates

string format: uuid
""
ownerName

Name of the owner / affiliate. Hotel booking customization when it’s the booking customization.

string
""
enabled

Flag the supplier can use to enable / disable this channel

boolean
default: true
channelDisabled

System override by supplier to disable channel. E.g. Platform disables supplier.

boolean
blacklisted
required

A way to blacklist a specific channel a property doesn’t want to send blocking to.

boolean
percentDiscount

Percent discount on this channel and all its children [unless configured at the child level].

number format: float
"" <= 1
commission

Amount of sales commission earned through this channel and all its children [unless configured at the child level].

number format: float
"" <= 1
rateModifiers

Promotions for this channel

Array<object>

A lightweight projection of a special rate (promotion) containing all qualifying conditions and metadata.

object
identifier
required

Unique identifier of this promotion.

string format: uuid
"" >= 1 characters
hotelIdentifier
required

Unique identifier of the property this promotion belongs to.

string format: uuid
"" >= 1 characters
name
required

Internal name of promotion.

string
"" >= 1 characters
type
required

Set whether you want the price to go up or down when the rules of this promotion have been satisfied.

string
""
Allowed values: PREMIUM DISCOUNT
modifier
required

The discount or premium amount and its type (fixed or percentage).

""
enabled
required

Whether this promotion is enabled or not.

boolean
default: true
pricingType
required

This determines whether this discount should be applied per night, per stay or per person - per night

string
""
Allowed values: PER_STAY PER_DAY PER_NIGHT PER_USE PER_HOUR PER_PERSON PER_PERSON_PER_NIGHT PER_PERSON_PER_HOUR PER_ADULT PER_ADULT_PER_NIGHT PER_ADULT_PER_HOUR PER_CHILD PER_CHILD_PER_NIGHT PER_CHILD_PER_HOUR
descriptions
required
Array<object>
>= 1 items

Simplified localized description containing text content and its language code.

object
description
required

Longer text description

string
"" >= 1 characters <= 2147483647 characters
language
required

Indicate which language this description is written in.

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

Whether it was user or system generated.

string
default: USER
Allowed values: SYSTEM USER
md5ContentHash

The md5 hash of the name, description and language.

string
""
hashMismatch
boolean
cityRateQualifiers
Array<object>

Qualifier that restricts a promotion to guests whose IP geolocation resolves to a specific city.

object
city
required

City details (obtained via geonames) to restrict the promotion by guest location.

object
geoNameId
required

GeoNameLightweight identifiers taken from https://geonames.org.

string
"" >= 1 characters
localeCode
required

Locale code

string
"" >= 1 characters /^[a-z]{2}(-[A-Z]{2})?$/
continentCode
required

Continent code

string
"" >= 1 characters
continentName
required

Continent name

string
"" >= 1 characters
countryIsoCode
required

Country ISO code

string
"" >= 1 characters /^[A-Z]{2}$/
countryName
required

Country name

string
"" >= 1 characters
cityName
required

City name

string
"" >= 1 characters
timezone
required

Timezone

string
"" >= 1 characters
subDivision1Code

Sub-division 1 code

string
""
subDivision1Name

Sub-division 1 name

string
""
subDivision2Code

Sub-division 2 code

string
""
subDivision2Name

Sub-division 2 name

string
""
continentRateQualifiers
Array<object>

Qualifier that restricts a promotion to guests whose IP geolocation resolves to a specific continent.

object
continent
required

Two-letter continent code (e.g. NA, EU, AS)

string
"" >= 1 characters
countryRateQualifiers
Array<object>

Qualifier that restricts a promotion to guests whose IP geolocation resolves to a specific country.

object
country
required

Country (obtained via geonames) to restrict the promotion by guest location.

object
geoNameId

GeoNames identifier

string
""
continentCode

Continent code (two-letter ISO)

string
""
continentName

Continent name

string
""
countryIsoCode

Country ISO 3166-1 alpha-2 code

string
"" /^[A-Z]{2}$/
countryName

Country name

string
""
promotionRateQualifiers
Array<object>

Qualifier that restricts a promotion to guests who enter a specific promotional code at checkout.

object
promotion
required

Promo code that guests must enter to access this promotion.

string
"" >= 1 characters
ipRangeRateQualifiers
Array<object>

Qualifier that restricts a promotion to guests whose IP address falls within a specified IPv4 range.

object
startIPRange
required

Starting IP address of the range (inclusive).

string
"" >= 1 characters
endIPRange
required

Ending IP address of the range (inclusive).

string
"" >= 1 characters
roomRangeRateQualifier

Restrict promotion by restricting to how many rooms the user wants.

""
prepayRateQualifier

Restrict promotion to either prepaid / non-prepaid rates.

""
refundableRateQualifier

Restrict promotion to either refundable / non-refundable rates.

""
timezoneRateQualifiers
Array<object>

Qualifier that restricts a promotion to guests whose system timezone matches the specified IANA timezone name.

object
timezone
required

IANA timezone name of the booker’s location (e.g. Asia/Bangkok).

string
"" >= 1 characters
lastMinuteRateQualifier

Restrict promotion to users who want to book a room close to the date.

""
lengthOfStayRateQualifier

Restrict promotion to users who want to stay a certain number of days.

""
advanceBookingRateQualifier

Restrict promotion to users who want to book in advance.

""
stayDateRateQualifiers
Array<object>

Rate qualifier that restricts a promotion to guests whose stay falls within a specific date range.

object
effectiveDate
required

Promotion applies when guest’s stay starts on or after this date (inclusive).

string format: date
""
expireDate
required

Promotion applies when guest’s stay starts on or before this date (inclusive).

string format: date
""
sellDateRateQualifiers
Array<object>

Qualifier that restricts a promotion to bookings made within a specific date window.

object
effectiveDate
required

Promotion is available when the booking is made on or after this date (inclusive).

string format: date
""
expireDate
required

Promotion is available when the booking is made on or before this date (inclusive).

string format: date
""
availableDaysOfWeekRateQualifier

Restrict promotion to specific days of the week the promotion is available.

""
arrivalDaysOfWeekRateQualifier

Restrict promotion to specific days of the week the guest is arriving.

""
departureDaysOfWeekRateQualifier

Restrict promotion to specific days of the week the guest is departing.

""
requiredDaysOfWeekRateQualifier

Restrict promotion to specific days of the week the guest has to stay.

""
masterRateIdentifiers
Array<string>
addOnIdentifiers
Array<string>
ratePlanIdentifiers
Array<string>
blackoutDates
Array<object>

A date range during which a promotion is not available (blackout period).

object
effectiveDate
required

Start date when the promotion is not available (inclusive).

string format: date
""
expireDate
required

End date when the promotion is not available (inclusive).

string format: date
""
rateModifierBundles

Promotion bundles for this channel

Array<object>

A lightweight projection of a promotion bundle containing the full set of qualifying conditions and metadata.

object
identifier
required

Unique record identifier

string format: uuid
"" >= 1 characters
hotelIdentifier
required

Hotel identifier.

string format: uuid
"" >= 1 characters
name
required

Internal name of promotion ancillary.

string
"" >= 1 characters
enabled
required

Whether this promotion ancillary is enabled or not.

boolean
default: true
items
required
Array<object>
>= 1 items

Promotions that go together to make up this ancillary.

object
identifier
required

Unique identifier of this promotion.

string format: uuid
"" >= 1 characters
hotelIdentifier
required

Unique identifier of the property this promotion belongs to.

string format: uuid
"" >= 1 characters
name
required

Internal name of promotion.

string
"" >= 1 characters
type
required

Set whether you want the price to go up or down when the rules of this promotion have been satisfied.

string
""
Allowed values: PREMIUM DISCOUNT
modifier
required

The discount or premium amount and its type (fixed or percentage).

""
enabled
required

Whether this promotion is enabled or not.

boolean
default: true
pricingType
required

This determines whether this discount should be applied per night, per stay or per person - per night

string
""
Allowed values: PER_STAY PER_DAY PER_NIGHT PER_USE PER_HOUR PER_PERSON PER_PERSON_PER_NIGHT PER_PERSON_PER_HOUR PER_ADULT PER_ADULT_PER_NIGHT PER_ADULT_PER_HOUR PER_CHILD PER_CHILD_PER_NIGHT PER_CHILD_PER_HOUR
descriptions
required
Array<object>
>= 1 items

Simplified localized description containing text content and its language code.

object
description
required

Longer text description

string
"" >= 1 characters <= 2147483647 characters
language
required

Indicate which language this description is written in.

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

Whether it was user or system generated.

string
default: USER
Allowed values: SYSTEM USER
md5ContentHash

The md5 hash of the name, description and language.

string
""
hashMismatch
boolean
cityRateQualifiers
Array<object>

Qualifier that restricts a promotion to guests whose IP geolocation resolves to a specific city.

object
city
required

City details (obtained via geonames) to restrict the promotion by guest location.

object
geoNameId
required

GeoNameLightweight identifiers taken from https://geonames.org.

string
"" >= 1 characters
localeCode
required

Locale code

string
"" >= 1 characters /^[a-z]{2}(-[A-Z]{2})?$/
continentCode
required

Continent code

string
"" >= 1 characters
continentName
required

Continent name

string
"" >= 1 characters
countryIsoCode
required

Country ISO code

string
"" >= 1 characters /^[A-Z]{2}$/
countryName
required

Country name

string
"" >= 1 characters
cityName
required

City name

string
"" >= 1 characters
timezone
required

Timezone

string
"" >= 1 characters
subDivision1Code

Sub-division 1 code

string
""
subDivision1Name

Sub-division 1 name

string
""
subDivision2Code

Sub-division 2 code

string
""
subDivision2Name

Sub-division 2 name

string
""
continentRateQualifiers
Array<object>

Qualifier that restricts a promotion to guests whose IP geolocation resolves to a specific continent.

object
continent
required

Two-letter continent code (e.g. NA, EU, AS)

string
"" >= 1 characters
countryRateQualifiers
Array<object>

Qualifier that restricts a promotion to guests whose IP geolocation resolves to a specific country.

object
country
required

Country (obtained via geonames) to restrict the promotion by guest location.

object
geoNameId

GeoNames identifier

string
""
continentCode

Continent code (two-letter ISO)

string
""
continentName

Continent name

string
""
countryIsoCode

Country ISO 3166-1 alpha-2 code

string
"" /^[A-Z]{2}$/
countryName

Country name

string
""
promotionRateQualifiers
Array<object>

Qualifier that restricts a promotion to guests who enter a specific promotional code at checkout.

object
promotion
required

Promo code that guests must enter to access this promotion.

string
"" >= 1 characters
ipRangeRateQualifiers
Array<object>

Qualifier that restricts a promotion to guests whose IP address falls within a specified IPv4 range.

object
startIPRange
required

Starting IP address of the range (inclusive).

string
"" >= 1 characters
endIPRange
required

Ending IP address of the range (inclusive).

string
"" >= 1 characters
roomRangeRateQualifier

Restrict promotion by restricting to how many rooms the user wants.

""
prepayRateQualifier

Restrict promotion to either prepaid / non-prepaid rates.

""
refundableRateQualifier

Restrict promotion to either refundable / non-refundable rates.

""
timezoneRateQualifiers
Array<object>

Qualifier that restricts a promotion to guests whose system timezone matches the specified IANA timezone name.

object
timezone
required

IANA timezone name of the booker’s location (e.g. Asia/Bangkok).

string
"" >= 1 characters
lastMinuteRateQualifier

Restrict promotion to users who want to book a room close to the date.

""
lengthOfStayRateQualifier

Restrict promotion to users who want to stay a certain number of days.

""
advanceBookingRateQualifier

Restrict promotion to users who want to book in advance.

""
stayDateRateQualifiers
Array<object>

Rate qualifier that restricts a promotion to guests whose stay falls within a specific date range.

object
effectiveDate
required

Promotion applies when guest’s stay starts on or after this date (inclusive).

string format: date
""
expireDate
required

Promotion applies when guest’s stay starts on or before this date (inclusive).

string format: date
""
sellDateRateQualifiers
Array<object>

Qualifier that restricts a promotion to bookings made within a specific date window.

object
effectiveDate
required

Promotion is available when the booking is made on or after this date (inclusive).

string format: date
""
expireDate
required

Promotion is available when the booking is made on or before this date (inclusive).

string format: date
""
availableDaysOfWeekRateQualifier

Restrict promotion to specific days of the week the promotion is available.

""
arrivalDaysOfWeekRateQualifier

Restrict promotion to specific days of the week the guest is arriving.

""
departureDaysOfWeekRateQualifier

Restrict promotion to specific days of the week the guest is departing.

""
requiredDaysOfWeekRateQualifier

Restrict promotion to specific days of the week the guest has to stay.

""
masterRateIdentifiers
Array<string>
addOnIdentifiers
Array<string>
ratePlanIdentifiers
Array<string>
blackoutDates
Array<object>

A date range during which a promotion is not available (blackout period).

object
effectiveDate
required

Start date when the promotion is not available (inclusive).

string format: date
""
expireDate
required

End date when the promotion is not available (inclusive).

string format: date
""
modifierOverride

Optional: override the combined discount of all bundle items with a single fixed or percentage amount.

""
type

Required if manual override modifier is not null

string
""
Allowed values: PREMIUM DISCOUNT
pricingType

Determines whether this discount should be applied per night, per stay or per person - per night; Required if amount override is not null

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

Optional bundle-level descriptions. When populated, these replace the aggregated item descriptions in offerDetails.

Array<object>
""

Simplified localized description containing text content and its language code.

object
description
required

Longer text description

string
"" >= 1 characters <= 2147483647 characters
language
required

Indicate which language this description is written in.

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

Whether it was user or system generated.

string
default: USER
Allowed values: SYSTEM USER
md5ContentHash

The md5 hash of the name, description and language.

string
""
hashMismatch
boolean
isValid
boolean
hasFixedDiscountModifier
boolean
aggregatedItemDescriptions
Array<object>

Simplified localized description containing text content and its language code.

object
description
required

Longer text description

string
"" >= 1 characters <= 2147483647 characters
language
required

Indicate which language this description is written in.

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

Whether it was user or system generated.

string
default: USER
Allowed values: SYSTEM USER
md5ContentHash

The md5 hash of the name, description and language.

string
""
hashMismatch
boolean
hasPercentDiscountModifier
boolean
effectiveDescriptions
Array<object>

Simplified localized description containing text content and its language code.

object
description
required

Longer text description

string
"" >= 1 characters <= 2147483647 characters
language
required

Indicate which language this description is written in.

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

Whether it was user or system generated.

string
default: USER
Allowed values: SYSTEM USER
md5ContentHash

The md5 hash of the name, description and language.

string
""
hashMismatch
boolean
selfAcquires

Whether the sales channel is a self-acquiring entity.

boolean
inventoryType
required

Inventory type

string
""
Allowed values: GUEST_ROOM ADD_ON MEETING_ROOM RESTAURANT SPA ATTRACTION PLACE ACTIVITY
inventoryIdentifier
required

Inventory type identifier

string format: uuid
"" >= 1 characters
inventoryName
required

Name of inventory as hotel is seeing it

string
"" >= 1 characters
inventoryNameInEnglish
required

Name of inventory as traveler is seeing it

string
"" >= 1 characters
enabled
required

Whether this inventory is enabled or not

boolean
default: true
image
required

Main image of inventory

object
multimediaIdentifier
required

Document identifier

string format: uuid
"" >= 1 characters
identifier
required

Use this identifier to communicate with Cloudinary.

string
"" >= 1 characters
type
required

Whether Cloudinary media is a VIDEO or IMAGE.

string
""
Allowed values: IMAGE VIDEO AUDIO RAW
source
required

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

string
default: CLOUDINARY
Allowed values: YOUTUBE CLOUDINARY
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
angle

Media angle

string
""
width
required

Media width in pixels.

integer format: int32
"" >= 1
height
required

Media height in pixels.

integer format: int32
"" >= 1
published

Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.

boolean
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
name
required

Use as title or short text description

string
""
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})?$/
creator

Whether it was user or system generated.

string
default: USER
Allowed values: SYSTEM USER
md5ContentHash

The md5 hash of the name, description and language.

string
""
hashMismatch
boolean
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
attribution

Whether image has attribution properties

Array<object>
""
object
url

URL to contributor

string format: uri
""
name
required

Name of contributor

string
"" >= 1 characters
isLandscape

True if media width is greater or equal to height

boolean
pricePoint
required

Level of expensiveness.

string
default: THREE
Allowed values: HALF ONE ONE_HALF TWO TWO_HALF THREE THREE_HALF FOUR FOUR_HALF FIVE
location
required

Location

object
x
number format: double
y
number format: double
type
string
coordinates
Array<number>
address
required

Defaults to property address.

object
address1

Address line 1

string
""
address2

Address line 2

string
""
state

State

string
""
postalCode

Postal / zip code

string
""
county

County

string
""
city

City name

string
""
countryCode

Country

string
"" /^[A-Z]{2}$/
country

Country

string
""
fullAddress

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

string
""
quantity
required

Quantity

integer format: int32
0
commissionable
required

Whether this is commissionable or not

boolean
bookable
required

Whether inventory can be booked

boolean
default: true
lowestPrice

Best price of the room type or facility ancillary

object
amount
required

Monetary amount value

number
""
currency
required

ISO 4217 currency code

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

Best price of the room type or facility ancillary in platform currency

object
amount
required

Monetary amount value

number
""
currency
required

ISO 4217 currency code

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

Linked hotel

object
hotelIdentifier

Unique hotel record identifier.

string format: uuid
""
name

Hotel trade name

string
""
localName

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

string
""
chain

Name of hotel chain if applicable.

string
""
brand

Name of hotel brand

string
""
urlName

Unique URL-friendly name slug of hotel

string
"" /^[a-z0-9][a-z0-9-]*[a-z0-9]$/
uniqueId
required

Event shorter name

string
"" >= 1 characters
starRating

Official or self-designated property star rating. Note that in some regions there are 6-star hotels. They are the same as 5-star hotels everywhere else.

integer format: int32
"" <= 6
bookings

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

integer format: int64
0
aggregateReviewRating

Aggregate score based on all current user reviews.

number format: float
default: 0.0
location

Geo-location

object
x
number format: double
y
number format: double
type
string
coordinates
Array<number>
descriptions

Short and long welcome text

Array<object>
""

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

object
name
required

Use as title or short text description

string
""
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})?$/
creator

Whether it was user or system generated.

string
default: USER
Allowed values: SYSTEM USER
md5ContentHash

The md5 hash of the name, description and language.

string
""
hashMismatch
boolean
aggregateGreendexRating

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

number format: float
default: 0.0
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
totalReviews

Count of total reviews left by users at this property.

integer format: int32
0
reservations

Contact details for reservations desk

object
firstName

Contact first name

string
""
lastName

Contact last name

string
""
email

Contact E-mail

string format: email
""
secondaryEmail

Contact secondary Email

string format: email
""
phoneNumber

Contact phone number

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

First and last name

string
""
summary

Summary

string
""
socials

Property’s social network accounts

Array<object>
""

Social network

object
type

Type of social network.

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

URL or social network identifier to social network profile

string
""
images

Property images.

Array<object>
""

Multimedia that contains less information than Multimedia object

object
multimediaIdentifier
required

Document identifier

string format: uuid
"" >= 1 characters
identifier
required

Use this identifier to communicate with Cloudinary.

string
"" >= 1 characters
type
required

Whether Cloudinary media is a VIDEO or IMAGE.

string
""
Allowed values: IMAGE VIDEO AUDIO RAW
source
required

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

string
default: CLOUDINARY
Allowed values: YOUTUBE CLOUDINARY
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
angle

Media angle

string
""
width
required

Media width in pixels.

integer format: int32
"" >= 1
height
required

Media height in pixels.

integer format: int32
"" >= 1
published

Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.

boolean
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
name
required

Use as title or short text description

string
""
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})?$/
creator

Whether it was user or system generated.

string
default: USER
Allowed values: SYSTEM USER
md5ContentHash

The md5 hash of the name, description and language.

string
""
hashMismatch
boolean
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
attribution

Whether image has attribution properties

Array<object>
""
object
url

URL to contributor

string format: uri
""
name
required

Name of contributor

string
"" >= 1 characters
isLandscape

True if media width is greater or equal to height

boolean
videos

Property videos.

Array<object>
""

Multimedia that contains less information than Multimedia object

object
multimediaIdentifier
required

Document identifier

string format: uuid
"" >= 1 characters
identifier
required

Use this identifier to communicate with Cloudinary.

string
"" >= 1 characters
type
required

Whether Cloudinary media is a VIDEO or IMAGE.

string
""
Allowed values: IMAGE VIDEO AUDIO RAW
source
required

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

string
default: CLOUDINARY
Allowed values: YOUTUBE CLOUDINARY
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
angle

Media angle

string
""
width
required

Media width in pixels.

integer format: int32
"" >= 1
height
required

Media height in pixels.

integer format: int32
"" >= 1
published

Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.

boolean
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
name
required

Use as title or short text description

string
""
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})?$/
creator

Whether it was user or system generated.

string
default: USER
Allowed values: SYSTEM USER
md5ContentHash

The md5 hash of the name, description and language.

string
""
hashMismatch
boolean
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
attribution

Whether image has attribution properties

Array<object>
""
object
url

URL to contributor

string format: uri
""
name
required

Name of contributor

string
"" >= 1 characters
isLandscape

True if media width is greater or equal to height

boolean
policy

Basic property policy record.

object
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
internetConnectionType

Indicates how guests can access the Internet on the property.

string
""
Allowed values: WIFI CABLE
internetConnectionLocation

Indicates where internet is available in and around the property.

string
""
Allowed values: ENTIRE_PROPERTY PUBLIC_AREAS ALL_ROOMS SOME_ROOMS BUSINESS_CENTER
parkingAvailability
required

Indicates whether parking is available at the property.

string
""
Allowed values: YES NO YES_PAID
parkingAccess

Indicates what type of parking is available at the property.

string
""
Allowed values: PRIVATE PUBLIC
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
petMaxWeightInKilos

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

integer format: int32
""
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}$/
checkOutTime
required

When the guest has to check out.

string
"" >= 1 characters
checkInTime
required

When the guest can check in.

string
"" >= 1 characters
thirdPartyReviews

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

Array<object>
""

Recognition for the ancillary blocking.

object
identifier
required

Recognition identifier.

string format: uuid
"" >= 1 characters
category
required

Recognition category.

string
""
Allowed values: THIRD_PARTY_REVIEW PUBLICATION AWARD
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
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
""
maxRating
required

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

number format: float
""
date

The date the award was received

string format: date
""
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
ratingSymbol

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

string
""
attractions

Number of attractions property has listed on its profile.

integer format: int32
0
activities

Number of activites property has listed on its profile.

integer format: int32
0
places

Number of places property has listed on its profile.

integer format: int32
0
restaurants

Number of restaurants property has on its profile.

integer format: int32
0
meetingRooms

Number of meeting rooms property has on its profile.

integer format: int32
0
spas

Number of spas property has on its profile.

integer format: int32
0
addOns

Number of add-ons property has on its profile.

integer format: int32
0
generalManager

General manager of the property.

object
name
required

Name of GM currently managing the property.

string
""
image

Profile image of the general manager.

object
multimediaIdentifier
required

Document identifier

string format: uuid
"" >= 1 characters
identifier
required

Use this identifier to communicate with Cloudinary.

string
"" >= 1 characters
type
required

Whether Cloudinary media is a VIDEO or IMAGE.

string
""
Allowed values: IMAGE VIDEO AUDIO RAW
source
required

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

string
default: CLOUDINARY
Allowed values: YOUTUBE CLOUDINARY
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
angle

Media angle

string
""
width
required

Media width in pixels.

integer format: int32
"" >= 1
height
required

Media height in pixels.

integer format: int32
"" >= 1
published

Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.

boolean
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
name
required

Use as title or short text description

string
""
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})?$/
creator

Whether it was user or system generated.

string
default: USER
Allowed values: SYSTEM USER
md5ContentHash

The md5 hash of the name, description and language.

string
""
hashMismatch
boolean
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
attribution

Whether image has attribution properties

Array<object>
""
object
url

URL to contributor

string format: uri
""
name
required

Name of contributor

string
"" >= 1 characters
isLandscape

True if media width is greater or equal to height

boolean
descriptions

Localized welcome message from GM.

Array<object>

Simplified localized description containing text content and its language code.

object
description
required

Longer text description

string
"" >= 1 characters <= 2147483647 characters
language
required

Indicate which language this description is written in.

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

Whether it was user or system generated.

string
default: USER
Allowed values: SYSTEM USER
md5ContentHash

The md5 hash of the name, description and language.

string
""
hashMismatch
boolean
locationCategory

Supported OTA specification LOC code. See OTA geoname data

string
""
segmentCategory

Supported OTA specification SEG code. See OTA geoname data

string
""
hotelCategory

Supported OTA specification PCT code. See OTA geoname data

string
""
architecturalStyle

Supported OTA specification ARC code. See OTA geoname data

string
""
whenBuilt

Year the property was constructed.

string
""
currencyCode

Currency code for property.

string
"" /^[A-Z]{3}$/
membershipRateDiscount

A property’s price score is based on calculating historical pricing data. Each property receives a unique score. There is no max score; it’s there to compare it against other properties.

number format: float
0
priceScore

A property’s price score is based on calculating historical pricing data. Each property receives a unique score. There is no max score; it’s there to compare it against other properties.

integer format: int32
0
perkScore

A property’s perk score is based on the type of perks that is offered to the guests across all master rates. There is no max score; it’s there to compare it against other properties.

integer format: int32
0
addOnScore

A property’s package score is based on general availability and price for all packages and add-ons offered by the property. There is no max score; it’s there to compare it against other properties.

integer format: int32
0
loyaltyScore

A property’s loyalty score is based on calculating how many available rate plans honor loyalty points. There is no max score; it’s there to compare it against other properties.

integer format: int32
0
popularScore

A property’s popular score is based on calculating number of bookings across room types. There is no max score; it’s there to compare it against other properties.

integer format: int32
0
experienceScore

A property’s experience score is based on how calculating how many types of experiences are available and at what price ranges. There is no max score; it’s there to compare it against other properties.

integer format: int32
0
hotelAmenityCodes

Supported OTA specification HAC code. See OTA geoname data

Array<string>
""
propertyAccessibilityCodes

Supported OTA specification PHY code. See OTA geoname data

Array<string>
""
propertySecurityCodes

Supported OTA specification SEC code. See OTA geoname data

Array<string>
""
numberOfRooms

Number of rooms / keys for this property.

integer format: int32
0
address

Property address.

object
address1

Address line 1

string
""
address2

Address line 2

string
""
state

State

string
""
postalCode

Postal / zip code

string
""
county

County

string
""
city

City name

string
""
countryCode

Country

string
"" /^[A-Z]{2}$/
country

Country

string
""
fullAddress

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

string
""
active

Whether property is active

boolean
number
integer format: int32
first
boolean
last
boolean
numberOfElements
integer format: int32
pageable
object
offset
integer format: int64
unpaged
boolean
paged
boolean
pageNumber
integer format: int32
sort
object
empty
boolean
sorted
boolean
unsorted
boolean
pageSize
integer format: int32
sort
object
empty
boolean
sorted
boolean
unsorted
boolean
empty
boolean
Example
{
"content": [
{
"id": "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51",
"createdDate": "2026-01-14T09:30:00",
"lastUpdate": "2026-03-10T14:15:00",
"version": 1,
"salesChannel": {
"identifier": "7a0c5d9e-2f6b-4c1a-8e4d-3b9f1a0c6d52",
"supplierIdentifier": "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18",
"supplierName": "The Siam Residences, Bangkok",
"supplierAvailable": true,
"subType": "DIRECT",
"ownerIdentifier": "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69",
"ownerName": "The Siam Residences",
"enabled": true,
"channelDisabled": false
},
"inventoryType": "GUEST_ROOM",
"inventoryIdentifier": "6f9b4c8d-1e5a-4b3c-9d2e-8a7f0c1b5e43",
"inventoryName": "Deluxe Room with City View",
"inventoryNameInEnglish": "Deluxe City View Room",
"enabled": true,
"image": {
"multimediaIdentifier": "9d4e2b7a-3f1c-4d5b-8a6e-2c0f9b3d1e47",
"identifier": "the-siam-residences/deluxe-room-city-view",
"type": "IMAGE",
"sort": 1,
"published": true,
"descriptions": [
{
"title": "Deluxe Room",
"description": "Spacious city view room",
"language": "en"
}
],
"isLandscape": true
},
"pricePoint": "THREE",
"location": {
"type": "Point",
"coordinates": [
100.5581533,
13.7370197
]
},
"address": {
"address1": "20 Soi Ton Son",
"address2": null,
"state": null,
"postalCode": "10330",
"county": null,
"city": "Bangkok",
"countryCode": "TH"
},
"quantity": 24,
"commissionable": true,
"bookable": true,
"lowestPrice": {
"amount": 4500,
"currency": "THB"
},
"lowestDisplayPrice": {
"amount": 125,
"currency": "USD"
},
"hotel": {
"hotelIdentifier": "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18",
"name": "The Siam Residences, Bangkok",
"urlName": "the-siam-residences-bangkok-thailand",
"uniqueId": "siam01",
"starRating": "5",
"currencyCode": "THB"
}
}
]
}

Bad Request — missing or invalid request parameter or body

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

Unauthorized — authentication is required or the session has expired

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

Forbidden — authenticated but lacking the required permission or scope

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

Not Found — the requested resource does not exist

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

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

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

Unsupported Media Type — use application/json

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

Internal Server Error — an unexpected failure occurred on the server

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

Service Unavailable — a downstream dependency is unreachable

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example