Add supplier item
const url = 'https://api.wink.travel/api/managing-entity/d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69/studio/static-list/b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47/item/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/b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47/item/supplier \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --header 'Wink-Version: 2.0' \ --data nullAppend a supplier to an existing list, 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 ”Add inventory to curated list owned by this owner identifier.
Example
d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69List identifier.
Example
b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47Header Parameters
Section titled “Header Parameters ”Request Body required
Section titled “Request Body required ”Supplier identifier whose best-priced room will be resolved and appended to the list
Request to append a supplier to an existing curated list, resolved to its best-priced inventory.
object
Supplier identifier
Example
e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18Example
{ "supplierIdentifier": "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18"}Responses
Section titled “ Responses ”Newly created list item record resolved from the supplier
A single travel inventory entry within a curated list, linking a sales channel inventory item to its parent list.
object
Document UUID
Datetime this record was first created
Datetime this record was last updated
Version property that shows how many times this document has been persisted. Document will not persist if the version property is less than current version property in the system. Result in an optimistic locking exception.
Parent list
object
Unique record identifier
List creator
Name of curated list
Every affiliate starts out with a Favorite list. All other lists will be of type NORMAL
Channel inventory
object
Channel Inventory identifier
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.
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
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