Show transactional URL card
const url = 'https://api.wink.travel/api/public/transactional-url/example?include=PROPERTY_DETAILS%2CROOM_TYPE&maxMedia=20&language=en';const options = { method: 'POST', headers: { 'Wink-Version': '2.0', Authorization: 'Bearer <token>', 'Content-Type': 'application/json' }, body: '{"applyCallerLocation":false,"userSession":{"languageCode":"en"}}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url 'https://api.wink.travel/api/public/transactional-url/example?include=PROPERTY_DETAILS%2CROOM_TYPE&maxMedia=20&language=en' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --header 'Wink-Version: 2.0' \ --data '{ "applyCallerLocation": false, "userSession": { "languageCode": "en" } }'Resolves a transactional URL by id or short code. The response is the link’s configuration, the property’s static content exactly as /inventory/content returns it (shaped by the include, maxMedia and language query parameters, which select content scopes) and the property’s priced inventory exactly as /inventory/property returns it (shaped by the request body, including its own include of inventory sections), for the link’s hotel as its owner sells it. Every room is priced. roomType and ratePlan override the stored focus and name the room and rate plan in effect (effectiveRoomTypeIdentifier and effectiveRatePlanIdentifier); unknown or inactive values are ignored. effectiveRatePlanIdentifier is null when the named rate plan is not on sale for the dates while the room sells under another plan. The answer is a 404 for an unknown link or a hotel the owner cannot sell. If the hotel cannot be priced (typically because its currency has no usable platform exchange rate) the card is still returned with its content and an inventory with no rooms and no exchange quotes: available is false, commission is 0 and lastUpdate and heroImageUrl are null, because none of them is meaningful without prices. The request body’s include (the inventory sections to price: ADD_ON, RESTAURANT, MEETING_ROOM, SPA, ATTRACTION, ACTIVITY, PLACE, ANNOUNCEMENT) and the include query parameter (the content scopes: PROPERTY_DETAILS, ROOM_TYPE and the others listed there) are two different lists that share a name. The response carries Cache-Control: no-store.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”TransactionalUrl id or its short code
Query Parameters
Section titled “Query Parameters”Room type overriding the stored focus
Rate plan overriding the stored focus
Content 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_TYPEMaximum number of images, and of videos, returned per content entity; 0 returns everything
Example
20Language to return content descriptions in; English is always included. Defaults to en
Example
enHeader Parameters
Section titled “Header Parameters”Request Bodyrequired
Section titled “Request Bodyrequired”Stay session and pricing options
Prices the property behind a transactional link for a stay. The property comes from the link, so it is not part of the body.
object
When true, the caller’s IP address is resolved to a location, which decides whether special rates targeted by city, country, continent, timezone or geo-location apply to this stay (IP-range rates are not applied: the address itself is never used). Two callers can then be quoted different prices for the same request. When false or omitted, the price depends only on the request body. If the address cannot be placed, the stay is priced as if this were false. Intended for booking engines that price per visitor.
Image media type: image/jpeg (default), image/png, image/webp or image/*
Sections to price alongside the room offers. Accepted values: ADD_ON, RESTAURANT, MEETING_ROOM, SPA, ATTRACTION, ACTIVITY, PLACE, ANNOUNCEMENT. Case-insensitive; any other value is ignored.
Dates, occupancy, language and the exchange rates wanted. Required.
object
object
object
object
ISO 639-1 language for names and prose. When omitted, en.
ISO 4217 currencies you want an exchange rate into, for example [“EUR”, “JPY”]. At most 10 distinct codes. USD, the platform currency, is always quoted in addition. Amounts are never converted for you: they come back in the property’s own currency, and you multiply by the rate. A code that is not a real currency is a 400.
Example
{ "languageCode": "en"}Example
{ "applyCallerLocation": false, "userSession": { "languageCode": "en" }}Responses
Section titled “Responses”OK
object
A TransactionalUrl as the public card reads it
object
When true, renders selected images as an animated GIF (requires at least 2 images)
Animation frame delay in milliseconds (-1 = no animation)
Customization configuration identifier (controls the visual theme and styling)
Rate plan this link focuses on; requires defaultRoomTypeIdentifier
Room type this link focuses on; null for a hotel-level link
Localized link title and description (one entry per language/locale)
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Facebook App ID for OpenGraph metadata when the link is shared
TransactionalUrl identifier
Display name for this transactional URL (internal reference, not shown to end users)
Managing entity (owner) of this transactional URL
Current status of this transactional URL (ACTIVE, INACTIVE or REMOVED)
Property or supplier identifier (the entity whose inventory is promoted)
Visual theme controlling the appearance of the transactional URL’s banner
Twitter account handle for OpenGraph metadata when the link is shared
Unique identifier that generates the transactional URL slug (e.g., share.wink.travel/HBDG87f2)
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
object
Address information
object
Address line 1
Address line 2
City name
Country
Country
County
Address 1, Address 2, City, State, Postal / Zip code, Country
Postal / zip code
State
object
Convenience property to quickly determine if this existing object has any active days enabled.
Set to true to enable Friday.
Set to true to enable Monday.
Set to true to enable Saturday.
Set to true to enable Sunday.
Set to true to enable Thursday.
Set to true to enable Tuesday.
Set to true to enable Wednesday.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Specific lifestyle preference type used to match travelers with suitable inventory
object
An image or video of a property or one of its facilities, with ready-to-use delivery URLs.
object
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Cloudinary public id; build your own delivery URLs from it
Media height in pixels.
Deprecated, use entityId. Same value; will be removed.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Ready-to-use delivery URLs. Absent when no URL applies to this asset.
object
Watch URL for media hosted outside our CDN (for example YouTube).
Image scaled to at most 1920px wide.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Image scaled to at most 1024px wide.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Full-size image, not resized.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Still frame to show before the video plays.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Short low-bandwidth video preview.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Video stream at full size.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Small still, at most 320px wide. For videos this is a frame of the video.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Media width in pixels.
object
object
object
object
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.
object
Type of sellable travel inventory on the Wink platform
object
Retrieve data range ending with and including this end date
Retrieve data range starting with and including this start date
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
An image or video of a property or one of its facilities, with ready-to-use delivery URLs.
object
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Cloudinary public id; build your own delivery URLs from it
Media height in pixels.
Deprecated, use entityId. Same value; will be removed.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Ready-to-use delivery URLs. Absent when no URL applies to this asset.
object
Watch URL for media hosted outside our CDN (for example YouTube).
Image scaled to at most 1920px wide.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Image scaled to at most 1024px wide.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Full-size image, not resized.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Still frame to show before the video plays.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Short low-bandwidth video preview.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Video stream at full size.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Small still, at most 320px wide. For videos this is a frame of the video.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Media width in pixels.
object
Address information
object
Address line 1
Address line 2
City name
Country
Country
County
Address 1, Address 2, City, State, Postal / Zip code, Country
Postal / zip code
State
object
Convenience property to quickly determine if this existing object has any active days enabled.
Set to true to enable Friday.
Set to true to enable Monday.
Set to true to enable Saturday.
Set to true to enable Sunday.
Set to true to enable Thursday.
Set to true to enable Tuesday.
Set to true to enable Wednesday.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Specific lifestyle preference type used to match travelers with suitable inventory
object
An image or video of a property or one of its facilities, with ready-to-use delivery URLs.
object
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Cloudinary public id; build your own delivery URLs from it
Media height in pixels.
Deprecated, use entityId. Same value; will be removed.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Ready-to-use delivery URLs. Absent when no URL applies to this asset.
object
Watch URL for media hosted outside our CDN (for example YouTube).
Image scaled to at most 1920px wide.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Image scaled to at most 1024px wide.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Full-size image, not resized.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Still frame to show before the video plays.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Short low-bandwidth video preview.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Video stream at full size.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Small still, at most 320px wide. For videos this is a frame of the video.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Media width in pixels.
object
object
object
object
Opaque token identifying this representation; equals the ETag value, unquoted.
object
Stable hash of the content; equal for equal content.
The property’s stored totals, regardless of the requested scopes.
object
Property details; only with the PROPERTY_DETAILS scope.
object
Address information
object
Address line 1
Address line 2
City name
Country
Country
County
Address 1, Address 2, City, State, Postal / Zip code, Country
Postal / zip code
State
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
object
Outlines basic policies for the property.
object
When the guest can check in, hotel-local time as 24-hour HH:mm, 00:00 to 23:59.
When the guest has to check out, hotel-local time as 24-hour HH:mm, 00:00 to 23:59.
Indicates whether property allows children
When a property allows children, it can also indicate what the minimum age is for children to be allowed.
Indicates the availability of internet on the property.
Indicates where internet is available in and around the property.
Indicates how guests can access the Internet on the property.
Indicates what type of parking is available at the property.
Indicates whether parking is available at the property.
If pets are allowed, property can tell travelers if there is a charge applicable for the pet.
object
Monetary amount value
ISO 4217 currency code
If pets are allowed, property can further limit on weight.
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.
object
object
Social media platform type with associated Font Awesome icon class
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
object
The scopes actually populated. A collection that is empty and whose scope is not listed here was not requested.
object
Address information
object
Address line 1
Address line 2
City name
Country
Country
County
Address 1, Address 2, City, State, Postal / Zip code, Country
Postal / zip code
State
object
Convenience property to quickly determine if this existing object has any active days enabled.
Set to true to enable Friday.
Set to true to enable Monday.
Set to true to enable Saturday.
Set to true to enable Sunday.
Set to true to enable Thursday.
Set to true to enable Tuesday.
Set to true to enable Wednesday.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Specific lifestyle preference type used to match travelers with suitable inventory
object
An image or video of a property or one of its facilities, with ready-to-use delivery URLs.
object
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Cloudinary public id; build your own delivery URLs from it
Media height in pixels.
Deprecated, use entityId. Same value; will be removed.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Ready-to-use delivery URLs. Absent when no URL applies to this asset.
object
Watch URL for media hosted outside our CDN (for example YouTube).
Image scaled to at most 1920px wide.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Image scaled to at most 1024px wide.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Full-size image, not resized.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Still frame to show before the video plays.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Short low-bandwidth video preview.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Video stream at full size.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Small still, at most 320px wide. For videos this is a frame of the video.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Media width in pixels.
object
object
object
object
object
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
object
Address information
object
Address line 1
Address line 2
City name
Country
Country
County
Address 1, Address 2, City, State, Postal / Zip code, Country
Postal / zip code
State
object
Convenience property to quickly determine if this existing object has any active days enabled.
Set to true to enable Friday.
Set to true to enable Monday.
Set to true to enable Saturday.
Set to true to enable Sunday.
Set to true to enable Thursday.
Set to true to enable Tuesday.
Set to true to enable Wednesday.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Specific lifestyle preference type used to match travelers with suitable inventory
object
An image or video of a property or one of its facilities, with ready-to-use delivery URLs.
object
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Cloudinary public id; build your own delivery URLs from it
Media height in pixels.
Deprecated, use entityId. Same value; will be removed.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Ready-to-use delivery URLs. Absent when no URL applies to this asset.
object
Watch URL for media hosted outside our CDN (for example YouTube).
Image scaled to at most 1920px wide.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Image scaled to at most 1024px wide.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Full-size image, not resized.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Still frame to show before the video plays.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Short low-bandwidth video preview.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Video stream at full size.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Small still, at most 320px wide. For videos this is a frame of the video.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Media width in pixels.
object
object
object
object
Property identity, location and media.
object
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
Ascii name of city
Country
object
Country capital
Continent code
Currency code
Currency name
Country GeoNames identifier
ISO code
Country name
ISO 3166-1 alpha-2 country code for the country this location belongs to
GeoNames specific feature code identifying the place type (e.g. PPL=populated place, PPLC=national capital, ISL=island)
GeoName identifier
Coordinate points of the city
object
Name of city
Country sub division
object
Sub-country ascii name
Sub-country GeoNames identifier
Sub-country name
Country sub sub division
object
ASCII-transliterated name of the county or district, safe for URLs and sorting
GeoNames.org unique identifier for this subdivision
Official name of the county or district in its local script
IANA timezone identifier for the location
GeoNameLightweight type
Url name
An image or video of a property or one of its facilities, with ready-to-use delivery URLs.
object
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Cloudinary public id; build your own delivery URLs from it
Media height in pixels.
Deprecated, use entityId. Same value; will be removed.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Ready-to-use delivery URLs. Absent when no URL applies to this asset.
object
Watch URL for media hosted outside our CDN (for example YouTube).
Image scaled to at most 1920px wide.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Image scaled to at most 1024px wide.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Full-size image, not resized.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Still frame to show before the video plays.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Short low-bandwidth video preview.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Video stream at full size.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Small still, at most 320px wide. For videos this is a frame of the video.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Media width in pixels.
object
An image or video of a property or one of its facilities, with ready-to-use delivery URLs.
object
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Cloudinary public id; build your own delivery URLs from it
Media height in pixels.
Deprecated, use entityId. Same value; will be removed.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Ready-to-use delivery URLs. Absent when no URL applies to this asset.
object
Watch URL for media hosted outside our CDN (for example YouTube).
Image scaled to at most 1920px wide.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Image scaled to at most 1024px wide.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Full-size image, not resized.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Still frame to show before the video plays.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Short low-bandwidth video preview.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Video stream at full size.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Small still, at most 320px wide. For videos this is a frame of the video.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Media width in pixels.
The property identifier as requested.
object
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.
Recognition for the ancillary blocking.
object
Recognition category.
The date the award was received
Recognition identifier.
Use this to let hotels indicate what the total score for this award is.
When true, this indicates the property has received official permission from the award provider to use the rating in publications and marketing materials; when false this permission has not been granted.
The name of the entity that administers this recognition.
The actual award or rating received by the hotel facility.
Provides the symbol used in the rating. Used in conjunction with the Rating.
Type of rating system the recognition operated on. This allows us to display the score properly.
object
Address information
object
Address line 1
Address line 2
City name
Country
Country
County
Address 1, Address 2, City, State, Postal / Zip code, Country
Postal / zip code
State
object
Convenience property to quickly determine if this existing object has any active days enabled.
Set to true to enable Friday.
Set to true to enable Monday.
Set to true to enable Saturday.
Set to true to enable Sunday.
Set to true to enable Thursday.
Set to true to enable Tuesday.
Set to true to enable Wednesday.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Specific lifestyle preference type used to match travelers with suitable inventory
object
An image or video of a property or one of its facilities, with ready-to-use delivery URLs.
object
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Cloudinary public id; build your own delivery URLs from it
Media height in pixels.
Deprecated, use entityId. Same value; will be removed.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Ready-to-use delivery URLs. Absent when no URL applies to this asset.
object
Watch URL for media hosted outside our CDN (for example YouTube).
Image scaled to at most 1920px wide.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Image scaled to at most 1024px wide.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Full-size image, not resized.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Still frame to show before the video plays.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Short low-bandwidth video preview.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Video stream at full size.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Small still, at most 320px wide. For videos this is a frame of the video.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Media width in pixels.
object
object
object
object
object
A named bedroom layout configuration for a room type, containing one or more bedrooms each with their own bed setup.
object
List of bedrooms within this configuration layout.
A single bedroom within a room type, specifying the bedroom type and its bed configuration.
object
List of bed configurations for this bedroom. Each entry specifies a bed type and quantity.
A single bed type and its quantity within a bedroom, described using the OpenTravel bed type code.
object
OpenTravel bed type code (e.g., 1=Double, 2=Twin, 7=Queen, 8=King). See OTA geoname data.
Number of beds of this type in the room.
Bedroom type classification (e.g., MASTER, QUEEN, JUNIOR, DORMITORY, BEDROOM_1…BEDROOM_10).
Unique identifier for this bedroom configuration layout.
Human-readable name of this room layout configuration.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
An image or video of a property or one of its facilities, with ready-to-use delivery URLs.
object
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Cloudinary public id; build your own delivery URLs from it
Media height in pixels.
Deprecated, use entityId. Same value; will be removed.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Ready-to-use delivery URLs. Absent when no URL applies to this asset.
object
Watch URL for media hosted outside our CDN (for example YouTube).
Image scaled to at most 1920px wide.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Image scaled to at most 1024px wide.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Full-size image, not resized.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Still frame to show before the video plays.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Short low-bandwidth video preview.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Video stream at full size.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Small still, at most 320px wide. For videos this is a frame of the video.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Media width in pixels.
Gender assignment for a room. Typically used by hosteliers offering dorm-style or gender-segregated accommodation.
object
Address information
object
Address line 1
Address line 2
City name
Country
Country
County
Address 1, Address 2, City, State, Postal / Zip code, Country
Postal / zip code
State
object
Convenience property to quickly determine if this existing object has any active days enabled.
Set to true to enable Friday.
Set to true to enable Monday.
Set to true to enable Saturday.
Set to true to enable Sunday.
Set to true to enable Thursday.
Set to true to enable Tuesday.
Set to true to enable Wednesday.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Specific lifestyle preference type used to match travelers with suitable inventory
object
An image or video of a property or one of its facilities, with ready-to-use delivery URLs.
object
Whether image has attribution properties
object
Name of contributor
URL to contributor
Supported OTA specification PIC code. See OTA geoname data
Localized media captions to give user some context about where this media was taken.
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Longer text description
Indicate which language this description is written in.
Use as title or short text description
Cloudinary public id; build your own delivery URLs from it
Media height in pixels.
Deprecated, use entityId. Same value; will be removed.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Sort allows you to control how you want to sort this record in a list of media records.
Currently ONLY using Cloudinary to store all image / video assets.
Whether Cloudinary media is a VIDEO or IMAGE.
Ready-to-use delivery URLs. Absent when no URL applies to this asset.
object
Watch URL for media hosted outside our CDN (for example YouTube).
Image scaled to at most 1920px wide.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Image scaled to at most 1024px wide.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Full-size image, not resized.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Still frame to show before the video plays.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Short low-bandwidth video preview.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Video stream at full size.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Small still, at most 320px wide. For videos this is a frame of the video.
object
Delivery format label of this variant.
Maximum width in pixels of this variant. Absent when the variant is not resized.
Absolute HTTPS URL that can be used directly in an img/video tag.
Media width in pixels.
object
object
object
object
OK when the entry carries content.
The rate plan identifier actually in effect; null when hotel-level, when only the room type is focused, or when the requested rate plan was dropped because it is not on sale for the session’s dates and the room is priced under its other rates
The room type identifier actually in effect (a runtime override, else the link’s stored default); null for a hotel-level card
One property’s priced offers for a stay, with the same fields as the Partner API’s GetPropertyInventoryResponse, using REST-style (camelCase) names and enum values. Amounts are int64 minor units of the property’s own currency (property.currency).
object
object
object
object
The add-on this offer prices: the id of its static content (inventory/content with include=ADD_ON) and of the matching entry in OfferedRate.addOnIds. Name, descriptions and media are there; this offer carries only the price. Present on add-on offers and on venue (restaurant, spa and so on) offers alike, since a venue is priced from its add-ons.
Localized promotion copy attached by the price calculator when a discount or surcharge applies to this offer; empty otherwise. Not the promo code, which is ‘promotion’.
object
Pricing granularity that determines how a rate or fee is calculated and applied
object
object
The add-on this offer prices: the id of its static content (inventory/content with include=ADD_ON) and of the matching entry in OfferedRate.addOnIds. Name, descriptions and media are there; this offer carries only the price. Present on add-on offers and on venue (restaurant, spa and so on) offers alike, since a venue is priced from its add-ons.
Localized promotion copy attached by the price calculator when a discount or surcharge applies to this offer; empty otherwise. Not the promo code, which is ‘promotion’.
object
Pricing granularity that determines how a rate or fee is calculated and applied
object
object
Last day the announcement is shown. Absent when showAlways.
When true the announcement has no window and applies to every stay; startDate and endDate are then absent.
First day the announcement is shown. Absent when showAlways.
object
object
object
object
object
object
object
Ids of the perks bundled with this rate. Perks are static content: resolve each id via inventory/content?include=PERK, which lists the property’s perks with their descriptions.
object
The add-on this offer prices: the id of its static content (inventory/content with include=ADD_ON) and of the matching entry in OfferedRate.addOnIds. Name, descriptions and media are there; this offer carries only the price. Present on add-on offers and on venue (restaurant, spa and so on) offers alike, since a venue is priced from its add-ons.
Localized promotion copy attached by the price calculator when a discount or surcharge applies to this offer; empty otherwise. Not the promo code, which is ‘promotion’.
object
Pricing granularity that determines how a rate or fee is calculated and applied
Example
{ "configuration": { "animate": false, "animateDelay": 500, "customizationIdentifier": "8f2d4a9c-1e7b-4f3d-a5c8-9d1b6e2c0a47", "defaultRatePlanIdentifier": "9a3c6e1d-2b8f-4d7a-b5e0-4c1f8a2d6e93", "defaultRoomTypeIdentifier": "5b7e2c1a-9d4f-4e8b-a3c6-1f0d2e9b8a74", "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" } ], "facebookAppId": "198273987219", "keywords": [ "luxury" ], "name": "The Siam Residences, Bangkok", "ownerIdentifier": "d2c8f3a9-4b1e-4c7a-9d3f-5b8a2e6c1d04", "supplierIdentifier": "7c9a2e5f-3d8b-4a1c-b6e2-8f0d1c4a9b3e", "twitterAccount": "@thesiamresidences", "uniqueId": "HBDG87f2" }, "content": { "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 } ] } ] }, "effectiveRatePlanIdentifier": "9a3c6e1d-2b8f-4d7a-b5e0-4c1f8a2d6e93", "effectiveRoomTypeIdentifier": "5b7e2c1a-9d4f-4e8b-a3c6-1f0d2e9b8a74", "inventory": { "languageCode": "en", "property": { "available": true, "commission": 0.1, "currency": { "currencyCode": "THB", "currencyExponent": 2, "fxQuotes": [ { "asOf": "2026-10-29T00:00:00Z", "currencyCode": "USD", "rate": "0.0275" } ] }, "propertyId": "7c9a2e5f-3d8b-4a1c-b6e2-8f0d1c4a9b3e", "roomTypes": [ { "name": "Deluxe River View Suite", "rates": [ { "adults": 2, "available": true, "children": 0, "endDate": "2026-12-27", "quantity": 1, "ratePlanId": "9a3c6e1d-2b8f-4d7a-b5e0-4c1f8a2d6e93", "refundable": true, "roomNights": 3, "startDate": "2026-12-24", "total": 1350000, "unitPrice": 450000 } ], "roomTypeId": "5b7e2c1a-9d4f-4e8b-a3c6-1f0d2e9b8a74", "sort": 1 } ], "uniqueId": "HBDG87f2", "urlName": "the-siam-residences" } }}Bad Request — missing or invalid request parameter or body
object
object
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
object
object
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
object
object
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
object
object
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
object
object
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
object
object
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
object
object
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
object
object
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
object
object
Example generated
{ "detail": "example", "instance": "https://example.com", "properties": { "additionalProperty": "example" }, "status": 1, "title": "example", "type": "https://example.com"}