Show latest
const url = 'https://api.wink.travel/api/managing-entity/owner-1/studio/browse/supplier/list?page=0&size=20&displayCurrency=USD';const options = { method: 'GET', headers: {'Wink-Version': '2.0', Authorization: 'Bearer <token>'}};
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/supplier/list?page=0&size=20&displayCurrency=USD' \ --header 'Authorization: Bearer <token>' \ --header 'Wink-Version: 2.0'Returns the most recently available inventory suppliers, paged and priced in the requested display currency.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Browse inventory supplier on behalf of this owner identifier.
Example
owner-1Query Parameters
Section titled “Query Parameters”Skip to page.
Example
0Skip to page.
Example
20Indicate which currency to display prices in.
Example
USDHeader Parameters
Section titled “Header Parameters”Responses
Section titled “Responses”OK
Lightweight aggregated view of inventory suppliers, combining a sales channel with a lightweight hotel summary (PropertyAggregateLightweight) and the lowest available price.
object
Distance in metres from the searched point to the nearest inventory item, when the query was a near-point search.
Combined property data.
object
Number of activites property has listed on its profile.
Number of add-ons property has on its profile.
Property address.
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
Aggregate Green Index score if the property has answered our questionnaire available in the Extranet.
Aggregate score based on all current user reviews.
Supported OTA specification ARC code. See OTA geoname data
Number of attractions property has listed on its profile.
Whether property is available
Number of bookings for this property on the wink.travel platform.
Name of hotel brand
Name of hotel chain if applicable.
City 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
Currency code for property.
Short and long welcome text
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Use as title or short text description
General manager of the property.
object
Localized welcome message from GM.
Simplified localized description containing text content and its language code.
object
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Profile image of the general manager.
object
Media angle
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
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
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.
Media width in pixels.
Name of GM currently managing the property.
Supported OTA specification HAC code. See OTA geoname data
Supported OTA specification PCT code. See OTA geoname data
Unique hotel record identifier.
Property images.
Multimedia that contains less information than Multimedia object
object
Media angle
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
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
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.
Media width in pixels.
Timestamp of the last update to this property aggregate record.
Hotel local name if different from the trade name or if it is the local language.
Geo-location
object
Supported OTA specification LOC code. See OTA geoname data
Number of meeting rooms property has on its profile.
Hotel trade name
Number of rooms / keys for this property.
Number of places property has listed on its profile.
Basic property policy record.
object
When the guest can check in.
When the guest has to check out.
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.
Supported OTA specification PHY code. See OTA geoname data
Supported OTA specification SEC code. See OTA geoname data
Contact details for reservations desk
object
Contact E-mail
Contact first name
First and last name
Contact last name
Contact phone number
Contact secondary Email
Summary
Number of restaurants property has on its profile.
Demand score (0-100) derived from booking volume and review rating. Recomputed monthly; used to rank properties in search results.
Supported OTA specification SEG code. See OTA geoname data
Property’s social network accounts
Social network
object
URL or social network identifier to social network profile
Type of social network.
Number of spas property has on its profile.
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.
Array of awards and third party reviews given to property by certified / non-certified providers.
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.
Count of total reviews left by users at this property.
Event shorter name
Unique URL-friendly name slug of hotel
Property videos.
Multimedia that contains less information than Multimedia object
object
Media angle
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
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Use as title or short text description
Media height in pixels.
Use this identifier to communicate with Cloudinary.
True if media width is greater or equal to height
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Document identifier
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
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.
Media width in pixels.
Year the property was constructed.
Best price of the room type or facility ancillary in platform currency
object
Monetary amount value
ISO 4217 currency code
Best price of the room type or facility ancillary
object
Monetary amount value
ISO 4217 currency code
Parent sales channel
object
A way to blacklist a specific channel a property doesn’t want to send blocking to.
System override by supplier to disable channel. E.g. Platform disables supplier.
Amount of sales commission earned through this channel and all its children [unless configured at the child level].
Datetime this record was first created
Flag the supplier can use to enable / disable this channel
Unique identifier for this record.
Datetime this record was last updated
A specific identifier for the company / corporation / travel agency that is retrieving the rates
Name of the owner / affiliate. Hotel booking customization when it’s the booking customization.
Percent discount on this channel and all its children [unless configured at the child level].
Promotion bundles for this channel
A lightweight projection of a promotion bundle containing the full set of qualifying conditions and metadata.
object
Simplified localized description containing text content and its language code.
object
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Datetime this record was first created
Optional bundle-level descriptions. When populated, these replace the aggregated item descriptions in offerDetails.
Simplified localized description containing text content and its language code.
object
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Simplified localized description containing text content and its language code.
object
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Whether this promotion ancillary is enabled or not.
Hotel identifier.
Unique identifier for this record.
Promotions that go together to make up this ancillary.
object
Restrict promotion to users who want to book in advance.
Restrict promotion to specific days of the week the guest is arriving.
Restrict promotion to specific days of the week the promotion is available.
A date range during which a promotion is not available (blackout period).
object
Start date when the promotion is not available (inclusive).
End date when the promotion is not available (inclusive).
Qualifier that restricts a promotion to guests whose IP geolocation resolves to a specific city.
object
City details (obtained via geonames) to restrict the promotion by guest location.
object
City name
Continent code
Continent name
Country ISO code
Country name
GeoNameLightweight identifiers taken from https://geonames.org.
Locale code
Sub-division 1 code
Sub-division 1 name
Sub-division 2 code
Sub-division 2 name
Timezone
Qualifier that restricts a promotion to guests whose IP geolocation resolves to a specific continent.
object
Two-letter continent code (e.g. NA, EU, AS)
Qualifier that restricts a promotion to guests whose IP geolocation resolves to a specific country.
object
Country (obtained via geonames) to restrict the promotion by guest location.
object
Continent code (two-letter ISO)
Continent name
Country ISO 3166-1 alpha-2 code
Country name
GeoNames identifier
Datetime this record was first created
Restrict promotion to specific days of the week the guest is departing.
Simplified localized description containing text content and its language code.
object
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Whether this promotion is enabled or not.
Qualifier that restricts a promotion to guests within a circular geographic area defined by a center point and radius.
object
Latitude of the center point for the geo-location radius check.
Longitude of the center point for the geo-location radius check.
Radius in kilometers around the center point within which the guest must be located.
Unique identifier of the property this promotion belongs to.
Unique identifier for this record.
Qualifier that restricts a promotion to guests whose IP address falls within a specified IPv4 range.
object
Ending IP address of the range (inclusive).
Starting IP address of the range (inclusive).
Restrict promotion to users who want to book a room close to the date.
Datetime this record was last updated
Restrict promotion to users who want to stay a certain number of days.
The discount or premium amount and its type (fixed or percentage).
Internal name of promotion.
Restrict promotion to either prepaid / non-prepaid rates.
This determines whether this discount should be applied per night, per stay or per person - per night
Qualifier that restricts a promotion to guests who enter a specific promotional code at checkout.
object
Promo code that guests must enter to access this promotion.
Restrict promotion to either refundable / non-refundable rates.
Restrict promotion to specific days of the week the guest has to stay.
Restrict promotion by restricting to how many rooms the user wants.
Qualifier that restricts a promotion to bookings made within a specific date window.
object
Promotion is available when the booking is made on or after this date (inclusive).
Promotion is available when the booking is made on or before this date (inclusive).
Rate qualifier that restricts a promotion to guests whose stay falls within a specific date range.
object
Promotion applies when guest’s stay starts on or after this date (inclusive).
Promotion applies when guest’s stay starts on or before this date (inclusive).
Qualifier that restricts a promotion to guests whose system timezone matches the specified IANA timezone name.
object
IANA timezone name of the booker’s location (e.g. Asia/Bangkok).
Set whether you want the price to go up or down when the rules of this promotion have been satisfied.
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
Datetime this record was last updated
Optional: override the combined discount of all bundle items with a single fixed or percentage amount.
Internal name of promotion ancillary.
Determines whether this discount should be applied per night, per stay or per person - per night; Required if amount override is not null
Required if manual override modifier is not null
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
Promotions for this channel
A lightweight projection of a special rate (promotion) containing all qualifying conditions and metadata.
object
Restrict promotion to users who want to book in advance.
Restrict promotion to specific days of the week the guest is arriving.
Restrict promotion to specific days of the week the promotion is available.
A date range during which a promotion is not available (blackout period).
object
Start date when the promotion is not available (inclusive).
End date when the promotion is not available (inclusive).
Qualifier that restricts a promotion to guests whose IP geolocation resolves to a specific city.
object
City details (obtained via geonames) to restrict the promotion by guest location.
object
City name
Continent code
Continent name
Country ISO code
Country name
GeoNameLightweight identifiers taken from https://geonames.org.
Locale code
Sub-division 1 code
Sub-division 1 name
Sub-division 2 code
Sub-division 2 name
Timezone
Qualifier that restricts a promotion to guests whose IP geolocation resolves to a specific continent.
object
Two-letter continent code (e.g. NA, EU, AS)
Qualifier that restricts a promotion to guests whose IP geolocation resolves to a specific country.
object
Country (obtained via geonames) to restrict the promotion by guest location.
object
Continent code (two-letter ISO)
Continent name
Country ISO 3166-1 alpha-2 code
Country name
GeoNames identifier
Datetime this record was first created
Restrict promotion to specific days of the week the guest is departing.
Simplified localized description containing text content and its language code.
object
Whether it was user or system generated.
Longer text description
Indicate which language this description is written in.
The md5 hash of the name, description and language.
Whether this promotion is enabled or not.
Qualifier that restricts a promotion to guests within a circular geographic area defined by a center point and radius.
object
Latitude of the center point for the geo-location radius check.
Longitude of the center point for the geo-location radius check.
Radius in kilometers around the center point within which the guest must be located.
Unique identifier of the property this promotion belongs to.
Unique identifier for this record.
Qualifier that restricts a promotion to guests whose IP address falls within a specified IPv4 range.
object
Ending IP address of the range (inclusive).
Starting IP address of the range (inclusive).
Restrict promotion to users who want to book a room close to the date.
Datetime this record was last updated
Restrict promotion to users who want to stay a certain number of days.
The discount or premium amount and its type (fixed or percentage).
Internal name of promotion.
Restrict promotion to either prepaid / non-prepaid rates.
This determines whether this discount should be applied per night, per stay or per person - per night
Qualifier that restricts a promotion to guests who enter a specific promotional code at checkout.
object
Promo code that guests must enter to access this promotion.
Restrict promotion to either refundable / non-refundable rates.
Restrict promotion to specific days of the week the guest has to stay.
Restrict promotion by restricting to how many rooms the user wants.
Qualifier that restricts a promotion to bookings made within a specific date window.
object
Promotion is available when the booking is made on or after this date (inclusive).
Promotion is available when the booking is made on or before this date (inclusive).
Rate qualifier that restricts a promotion to guests whose stay falls within a specific date range.
object
Promotion applies when guest’s stay starts on or after this date (inclusive).
Promotion applies when guest’s stay starts on or before this date (inclusive).
Qualifier that restricts a promotion to guests whose system timezone matches the specified IANA timezone name.
object
IANA timezone name of the booker’s location (e.g. Asia/Bangkok).
Set whether you want the price to go up or down when the rules of this promotion have been satisfied.
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
Whether the sales channel is a self-acquiring entity.
What type of segment of channel is this.
Channel is owned by this supplier identifier.
Name of property / supplier that owns this channel
Optimistic-locking version. Echo this value back as an If-Match request header on a conditional update; the server responds 409 if the record changed in the meantime. Null when this projection has no backing versioned document, in which case no conditional update is possible.
Example
[ { "hotel": { "hotelIdentifier": "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "name": "The Siam Residences, Bangkok", "uniqueId": "siam01", "urlName": "the-siam-residences-bangkok" }, "lowestDisplayPrice": { "amount": 125, "currency": "USD" }, "lowestPrice": { "amount": 4500, "currency": "THB" }, "salesChannel": { "channelDisabled": false, "enabled": true, "identifier": "7a0c5d9e-2f6b-4c1a-8e4d-3b9f1a0c6d52", "ownerIdentifier": "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "ownerName": "The Siam Residences", "subType": "DIRECT", "supplierIdentifier": "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "supplierName": "The Siam Residences, Bangkok" } }]Bad Request — missing or invalid request parameter or body
object
object
Example
Unauthorized — authentication is required or the session has expired
object
object
Example
Forbidden — authenticated but lacking the required permission or scope
object
object
Example
Not Found — the requested resource does not exist
object
object
Example
Method Not Allowed — the HTTP verb is not supported on this endpoint
object
object
Example
Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version
object
object
Example
Unsupported Media Type — use application/json
object
object
Example
Internal Server Error — an unexpected failure occurred on the server
object
object
Example
Service Unavailable — a downstream dependency is unreachable