Show
const url = 'https://api.wink.travel/api/managing-entity/owner-1/studio/browse/supplier/supplier-1/sales-channel/sales-channel-1?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/supplier-1/sales-channel/sales-channel-1?displayCurrency=USD' \ --header 'Authorization: Bearer <token>' \ --header 'Wink-Version: 2.0'Loads a single supplier’s aggregate details for a given sales channel, 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-1Browse inventory supplier on behalf of this supplier identifier.
Example
supplier-1Browse inventory supplier on behalf of this sales channel identifier.
Example
sales-channel-1Query Parameters
Section titled “Query Parameters ”Indicate 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
Parent sales channel
object
Unique record identifier of this segment / account
Channel is owned by this supplier identifier.
Name of property / supplier that owns this channel
Flag when supplier not available. E.g. Hotel disables property
What type of segment of channel is this.
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.
Flag the supplier can use to enable / disable this channel
System override by supplier to disable channel. E.g. Platform disables supplier.
A way to blacklist a specific channel a property doesn’t want to send blocking to.
Percent discount on this channel and all its children [unless configured at the child level].
Amount of sales commission earned through this channel and all its children [unless configured at the child level].
Promotions for this channel
A lightweight projection of a special rate (promotion) containing all qualifying conditions and metadata.
object
Unique identifier of this promotion.
Unique identifier of the property this promotion belongs to.
Internal name of promotion.
Set whether you want the price to go up or down when the rules of this promotion have been satisfied.
The discount or premium amount and its type (fixed or percentage).
Whether this promotion is enabled or not.
This determines whether this discount should be applied per night, per stay or per person - per night
Simplified localized description containing text content and its language code.
object
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
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
GeoNameLightweight identifiers taken from https://geonames.org.
Locale code
Continent code
Continent name
Country ISO code
Country name
City name
Timezone
Sub-division 1 code
Sub-division 1 name
Sub-division 2 code
Sub-division 2 name
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
GeoNames identifier
Continent code (two-letter ISO)
Continent name
Country ISO 3166-1 alpha-2 code
Country name
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.
Qualifier that restricts a promotion to guests whose IP address falls within a specified IPv4 range.
object
Starting IP address of the range (inclusive).
Ending IP address of the range (inclusive).
Restrict promotion by restricting to how many rooms the user wants.
Restrict promotion to either prepaid / non-prepaid rates.
Restrict promotion to either refundable / non-refundable rates.
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).
Restrict promotion to users who want to book a room close to the date.
Restrict promotion to users who want to stay a certain number of days.
Restrict promotion to users who want to book in advance.
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 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).
Restrict promotion to specific days of the week the promotion is available.
Restrict promotion to specific days of the week the guest is arriving.
Restrict promotion to specific days of the week the guest is departing.
Restrict promotion to specific days of the week the guest has to stay.
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).
Promotion bundles for this channel
A lightweight projection of a promotion bundle containing the full set of qualifying conditions and metadata.
object
Unique record identifier
Hotel identifier.
Internal name of promotion ancillary.
Whether this promotion ancillary is enabled or not.
Promotions that go together to make up this ancillary.
object
Unique identifier of this promotion.
Unique identifier of the property this promotion belongs to.
Internal name of promotion.
Set whether you want the price to go up or down when the rules of this promotion have been satisfied.
The discount or premium amount and its type (fixed or percentage).
Whether this promotion is enabled or not.
This determines whether this discount should be applied per night, per stay or per person - per night
Simplified localized description containing text content and its language code.
object
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
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
GeoNameLightweight identifiers taken from https://geonames.org.
Locale code
Continent code
Continent name
Country ISO code
Country name
City name
Timezone
Sub-division 1 code
Sub-division 1 name
Sub-division 2 code
Sub-division 2 name
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
GeoNames identifier
Continent code (two-letter ISO)
Continent name
Country ISO 3166-1 alpha-2 code
Country name
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.
Qualifier that restricts a promotion to guests whose IP address falls within a specified IPv4 range.
object
Starting IP address of the range (inclusive).
Ending IP address of the range (inclusive).
Restrict promotion by restricting to how many rooms the user wants.
Restrict promotion to either prepaid / non-prepaid rates.
Restrict promotion to either refundable / non-refundable rates.
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).
Restrict promotion to users who want to book a room close to the date.
Restrict promotion to users who want to stay a certain number of days.
Restrict promotion to users who want to book in advance.
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 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).
Restrict promotion to specific days of the week the promotion is available.
Restrict promotion to specific days of the week the guest is arriving.
Restrict promotion to specific days of the week the guest is departing.
Restrict promotion to specific days of the week the guest has to stay.
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).
Optional: override the combined discount of all bundle items with a single fixed or percentage amount.
Required if manual override modifier is not null
Determines whether this discount should be applied per night, per stay or per person - per night; Required if amount override is not null
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
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
Simplified localized description containing text content and its language code.
object
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
Simplified localized description containing text content and its language code.
object
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
Whether the sales channel is a self-acquiring entity.
Combined property data.
object
Unique hotel record identifier.
Hotel trade name
Hotel local name if different from the trade name or if it is the local language.
Name of hotel chain if applicable.
Name of hotel brand
Unique URL-friendly name slug of hotel
Event shorter name
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.
Number of bookings for this property on the wink.travel platform.
Aggregate score based on all current user reviews.
Geo-location
object
Short and long welcome text
Foundation class for storing multi-language content (names and descriptions) with content change detection throughout the Wink Platform.
object
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
Aggregate Green Index score if the property has answered our questionnaire available in the Extranet.
Count of total reviews left by users at this property.
Contact details for reservations desk
object
Contact first name
Contact last name
Contact E-mail
Contact secondary Email
Contact phone number
First and last name
Summary
Property’s social network accounts
Social network
object
Type of social network.
URL or social network identifier to social network profile
Property images.
Multimedia that contains less information than Multimedia object
object
Document identifier
Use this identifier to communicate with Cloudinary.
Whether Cloudinary media is a VIDEO or IMAGE.
Currently ONLY using Cloudinary to store all image / video assets.
Sort allows you to control how you want to sort this record in a list of media records.
Media angle
Media width in pixels.
Media height in pixels.
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
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
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Whether image has attribution properties
object
URL to contributor
Name of contributor
True if media width is greater or equal to height
Property videos.
Multimedia that contains less information than Multimedia object
object
Document identifier
Use this identifier to communicate with Cloudinary.
Whether Cloudinary media is a VIDEO or IMAGE.
Currently ONLY using Cloudinary to store all image / video assets.
Sort allows you to control how you want to sort this record in a list of media records.
Media angle
Media width in pixels.
Media height in pixels.
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
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
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Whether image has attribution properties
object
URL to contributor
Name of contributor
True if media width is greater or equal to height
Basic property policy record.
object
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 how guests can access the Internet on the property.
Indicates where internet is available in and around the property.
Indicates whether parking is available at the property.
Indicates what type of parking is available at the property.
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.
If pets are allowed, property can further limit on weight.
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
When the guest has to check out.
When the guest can check in.
Array of awards and third party reviews given to property by certified / non-certified providers.
Recognition for the ancillary blocking.
object
Recognition identifier.
Recognition category.
Type of rating system the recognition operated on. This allows us to display the score properly.
The name of the entity that administers this recognition.
The actual award or rating received by the hotel facility.
Use this to let hotels indicate what the total score for this award is.
The date the award was received
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.
Provides the symbol used in the rating. Used in conjunction with the Rating.
Number of attractions property has listed on its profile.
Number of activites property has listed on its profile.
Number of places property has listed on its profile.
Number of restaurants property has on its profile.
Number of meeting rooms property has on its profile.
Number of spas property has on its profile.
Number of add-ons property has on its profile.
General manager of the property.
object
Name of GM currently managing the property.
Profile image of the general manager.
object
Document identifier
Use this identifier to communicate with Cloudinary.
Whether Cloudinary media is a VIDEO or IMAGE.
Currently ONLY using Cloudinary to store all image / video assets.
Sort allows you to control how you want to sort this record in a list of media records.
Media angle
Media width in pixels.
Media height in pixels.
Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
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
Use as title or short text description
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Whether image has attribution properties
object
URL to contributor
Name of contributor
True if media width is greater or equal to height
Localized welcome message from GM.
Simplified localized description containing text content and its language code.
object
Longer text description
Indicate which language this description is written in.
Whether it was user or system generated.
The md5 hash of the name, description and language.
Supported OTA specification LOC code. See OTA geoname data
Supported OTA specification SEG code. See OTA geoname data
Supported OTA specification PCT code. See OTA geoname data
Supported OTA specification ARC code. See OTA geoname data
Year the property was constructed.
Currency code for property.
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.
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.
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.
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.
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.
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.
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.
Supported OTA specification HAC code. See OTA geoname data
Supported OTA specification PHY code. See OTA geoname data
Supported OTA specification SEC code. See OTA geoname data
Number of rooms / keys for this property.
Property address.
object
Address line 1
Address line 2
State
Postal / zip code
County
City name
Country
Country
Address 1, Address 2, City, State, Postal / Zip code, Country
Whether property is active
Best price of the room type or facility ancillary
object
Monetary amount value
ISO 4217 currency code
Best price of the room type or facility ancillary in platform currency
object
Monetary amount value
ISO 4217 currency code
Example
{ "salesChannel": { "identifier": "7a0c5d9e-2f6b-4c1a-8e4d-3b9f1a0c6d52", "supplierIdentifier": "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "supplierName": "The Siam Residences, Bangkok", "supplierAvailable": true, "subType": "DIRECT", "ownerIdentifier": "d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69", "ownerName": "The Siam Residences", "enabled": true, "channelDisabled": false }, "hotel": { "hotelIdentifier": "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "name": "The Siam Residences, Bangkok", "urlName": "the-siam-residences-bangkok", "uniqueId": "siam01" }, "lowestPrice": { "amount": 4500, "currency": "THB" }, "lowestDisplayPrice": { "amount": 125, "currency": "USD" }}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
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