Inventory Search by Saved Search

GET

/api/managing-entity/{managingEntityIdentifier}/studio/browse/inventory/grid/{dynamicListIdentifier}

const url = 'https://api.wink.travel/api/managing-entity/owner-1/studio/browse/inventory/grid/dynamic-list-1?page=0&size=20&displayCurrency=USD';
const options = {method: 'GET', headers: {'Wink-Version': '2.0'}};

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

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

Retrieves a paginated result set based on the given saved search ID.

Parameters

Path Parameters

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

Query Parameters

page

string

Skip to page.

Example

size

string

"" <= 100

Limit the size of results.

Example

displayCurrency

string

Indicate which currency to display prices in.

Example

USD

Header Parameters

Wink-Version

string

default: 2.0.0

Allowed values: 2.0

Responses

200

application/json

object

totalPages

integer format: int32

totalElements

integer format: int64

size

integer format: int32

content

Array<object>

object

Document UUID

string

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>

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.

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

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

Localized descriptions describing promotion. At least one English entry is required.

Array<object>

"" >= 1 items

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

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

Restrict promotion to specific cities. See Geo-IP city geoname data

Array

continentRateQualifiers

Restrict promotion to specific continents. See Geo-IP continent geoname data

Array

countryRateQualifiers

Restrict promotion to specific countries. See Geo-IP country geoname data

Array

promotionRateQualifiers

Restrict promotion by requiring users to enter a promo code.

Array

ipRangeRateQualifiers

Restrict promotion to specific IP ranges.

Array

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

Restrict promotion to specific time zones. See Geo-IP timezone geoname data

Array

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

Restrict promotion to specific stay dates the user wants to arrive.

Array

sellDateRateQualifiers

Restrict promotion to specific dates the booking is made.

Array

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

Restrict on specific master rates.

Array<string>

addOnIdentifiers

Restrict on specific add-ons.

Array<string>

ratePlanIdentifiers

Restrict on specific rate plans.

Array<string>

blackoutDates

Exclude this promotion from specific date ranges.

Array

rateModifierBundles

Promotion bundles for this channel

Array<object>

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 record identifier

string format: uuid

"" >= 1 characters

hotelIdentifier

required

Hotel identifier.

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

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

descriptions

required

Localized descriptions describing promotion. At least one English entry is required.

Array<object>

"" >= 1 items

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

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

Restrict promotion to specific cities. See Geo-IP city geoname data

Array

continentRateQualifiers

Restrict promotion to specific continents. See Geo-IP continent geoname data

Array

countryRateQualifiers

Restrict promotion to specific countries. See Geo-IP country geoname data

Array

promotionRateQualifiers

Restrict promotion by requiring users to enter a promo code.

Array

ipRangeRateQualifiers

Restrict promotion to specific IP ranges.

Array

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

Restrict promotion to specific time zones. See Geo-IP timezone geoname data

Array

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

Restrict promotion to specific stay dates the user wants to arrive.

Array

sellDateRateQualifiers

Restrict promotion to specific dates the booking is made.

Array

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

Restrict on specific master rates.

Array<string>

addOnIdentifiers

Restrict on specific add-ons.

Array<string>

ratePlanIdentifiers

Restrict on specific rate plans.

Array<string>

blackoutDates

Exclude this promotion from specific date ranges.

Array

modifierOverride

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

descriptions

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

Array<object>

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

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

aggregatedItemDescriptions

Array<object>

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

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

hasFixedDiscountModifier

boolean

hasPercentDiscountModifier

boolean

effectiveDescriptions

Array<object>

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

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>

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

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

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

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

country

Country

string

fullAddress

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

string

quantity

required

Quantity

integer format: int32

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

number

currency

required

string

>= 1 characters

lowestDisplayPrice

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

object

amount

required

number

currency

required

string

>= 1 characters

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

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

aggregateReviewRating

Aggregate score based on all current user reviews.

number format: float

default: 0.0

location

Geo-location

object

number format: double

type

string

coordinates

Array<number>

descriptions

Short and long welcome text

Array<object>

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

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>

totalReviews

Count of total reviews left by users at this property.

integer format: int32

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

phoneNumber

Contact phone number

string

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>

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

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

attribution

Whether image has attribution properties

Array<object>

object

url

URL to contributor

string

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>

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

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

attribution

Whether image has attribution properties

Array<object>

object

url

URL to contributor

string

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

number

currency

required

string

>= 1 characters

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

activities

Number of activites property has listed on its profile.

integer format: int32

places

Number of places property has listed on its profile.

integer format: int32

restaurants

Number of restaurants property has on its profile.

integer format: int32

meetingRooms

Number of meeting rooms property has on its profile.

integer format: int32

spas

Number of spas property has on its profile.

integer format: int32

addOns

Number of add-ons property has on its profile.

integer format: int32

generalManager

General manager related data.

object

name

required

Name of GM currently managing the property.

string

image

Cloudinary image identifier of GM currently managing the property.

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>

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

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

attribution

Whether image has attribution properties

Array<object>

object

url

URL to contributor

string

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>

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

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

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

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

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

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

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

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

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

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

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

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

numberOfElements

integer format: int32

sort

object

empty

boolean

unsorted

boolean

sorted

boolean

first

boolean

last

boolean

pageable

object

offset

integer format: int64

sort

object

empty

boolean

unsorted

boolean

sorted

boolean

pageSize

integer format: int32

paged

boolean

pageNumber

integer format: int32

unpaged

boolean

empty

boolean

Example

{
  "content": [
    {
      "id": "",
      "createdDate": "",
      "lastUpdate": "",
      "version": "",
      "salesChannel": "",
      "inventoryType": "GUEST_ROOM",
      "inventoryIdentifier": "",
      "inventoryName": "",
      "inventoryNameInEnglish": "",
      "enabled": true,
      "image": null,
      "pricePoint": "HALF",
      "location": "",
      "address": "",
      "quantity": 0,
      "commissionable": false,
      "bookable": true,
      "lowestPrice": "",
      "lowestDisplayPrice": "",
      "hotel": ""
    }
  ]
}

400

Bad Request

object

type

string format: uri

title

string

status

integer format: int32

detail

string

instance

string format: uri

properties

object

key

additional properties

Example ^generated

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

401

Unauthorized

*/*

object

type

string format: uri

title

string

status

integer format: int32

detail

string

instance

string format: uri

properties

object

key

additional properties

403

Forbidden

*/*

object

type

string format: uri

title

string

status

integer format: int32

detail

string

instance

string format: uri

properties

object

key

additional properties

500

Internal Server Error

object

Example ^generated

{}

Inventory Search by Saved Search

Parameters

Path Parameters

Example

Example

Query Parameters

Example

Example

Example

Header Parameters

Responses

200

Example

400

Example generated

401

403

500

Example generated

Example ^generated

Example ^generated