Create from supplier
const url = 'https://api.wink.travel/api/managing-entity/d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69/studio/static-list/supplier';const options = { method: 'POST', headers: { 'Wink-Version': '2.0', Authorization: 'Bearer <token>', 'Content-Type': 'application/json' }, body: 'null'};
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/managing-entity/d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69/studio/static-list/supplier \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --header 'Wink-Version: 2.0' \ --data nullCreate a new list seeded with a supplier item resolved to its best-priced room for the caller’s location.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Create curated list owned by this owner identifier.
Example
d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69Header Parameters
Section titled “Header Parameters”Request Bodyrequired
Section titled “Request Bodyrequired”New list metadata together with the supplier identifier whose best-priced room will seed the list
Request to create a new curated list seeded with a supplier resolved to its best-priced inventory.
object
Name of curated list
Example
Top 3 Hotels in Chiang MaiSupplier identifier to seed the list with.
Example
e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18Inventory type of the supplier item to resolve.
Example
GUEST_ROOMExample
{ "name": "Top 3 Hotels in Chiang Mai", "supplierIdentifier": "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "channelInventoryType": "GUEST_ROOM"}Responses
Section titled “Responses”Newly created curated list seeded with the resolved supplier inventory item
Contains both the curated list and all its items.
object
Curated list object
object
Unique identifier for this record.
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.
List creator
Name of curated list
Every affiliate starts out with a Favorite list. All other lists will be of type NORMAL
Datetime this record was first created
Datetime this record was last updated
Travel inventory items contained in list
A single travel inventory entry within a curated list, linking a sales channel inventory item to its parent list.
object
Unique identifier for this record.
Datetime this record was first created
Datetime this record was last updated
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.
Parent list
object
Unique identifier for this record.
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.
List creator
Name of curated list
Every affiliate starts out with a Favorite list. All other lists will be of type NORMAL
Datetime this record was first created
Datetime this record was last updated
Channel inventory
object
Channel Inventory identifier
Parent sales channel
object
Type of entity that manages, facilitates, or administers properties, bookings, or payments on the Wink Platform
object
Determines whether a special rate reduces (DISCOUNT) or increases (PREMIUM) the base price.
Pricing granularity that determines how a rate or fee is calculated and applied
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 bookings with a specified minimum and/or maximum number of rooms.
Qualifier that restricts a promotion to either prepaid or pay-at-property rates.
Qualifier that restricts a promotion to either refundable or non-refundable rates.
Qualifier that restricts a promotion to last-minute bookings made within a specified number of seconds before the stay start date.
Qualifier that restricts a promotion to stays within a specified minimum and maximum length of stay (in nights).
Qualifier that restricts a promotion to bookings made within a specific advance window before the stay start date.
Qualifier that restricts a promotion to specific days of the week when it is available for booking.
Qualifier that restricts a promotion to guests arriving on specific days of the week.
Qualifier that restricts a promotion to guests departing on specific days of the week.
Qualifier that restricts a promotion to stays that include specific required days of the week.
object
A lightweight projection of a special rate (promotion) containing all qualifying conditions and metadata.
object
Unique identifier for this record.
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.
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).
Datetime this record was first created
Datetime this record was last updated
Determines whether a special rate reduces (DISCOUNT) or increases (PREMIUM) the base price.
Pricing granularity that determines how a rate or fee is calculated and applied
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.
Inventory type
Inventory type identifier
Name of inventory as traveler is seeing it
Whether this inventory is enabled or not
Main image of inventory
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
Location
object
Whether this is commissionable or not
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
Level of expensiveness.
Sort key for controlling display order within the list (0-based)
Availability status of this list item; defaults to ACTIVE
Example
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