Create
const url = 'https://api.wink.travel/api/managing-entity/d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69/studio/shareable-link/inventory';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/shareable-link/inventory \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --header 'Wink-Version: 2.0' \ --data nullCreates a new shareable inventory link for the managing entity with OpenGraph metadata, media selection, and theming. The link is attributed to the authenticated user.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Managing entity identifier for which to create the shareable link
Example
d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69Header Parameters
Section titled “Header Parameters”Request Bodyrequired
Section titled “Request Bodyrequired”Inventory link configuration including OpenGraph metadata, media selection, and theming for the new shareable link
Upserts a SellableInventoryUrl entity
object
Create an animated gif instead of a list of images
Example
trueAnimation delay in milliseconds
Example
1000Selected inventory record identifier
Example
8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29Customization identifier for link styling and branding
Example
3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51Localized link descriptions
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.
Example
SYSTEMLonger text description
Example
This is a longer description in the specified language.Indicate which language this description is written in.
Example
enThe md5 hash of the name, description and language.
Example
d41d8cd98f00b204e9800998ecf8427eUse as title or short text description
Example
An example titleExample
{ "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"}Facebook APP ID is used with OpenGraph data
Example
19827398721938798237Inventory type
Example
GUEST_ROOMThe selected media for this url.
object
Media angle
Example
-90Whether image has attribution properties
object
Name of contributor
Example
Samuel AdamsURL to contributor
Example
https://maps.google.com/maps/contrib/111628493169070103594Example
{ "name": "Samuel Adams", "url": "https://maps.google.com/maps/contrib/111628493169070103594"}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.
Example
SYSTEMLonger text description
Example
This is a longer description in the specified language.Indicate which language this description is written in.
Example
enThe md5 hash of the name, description and language.
Example
d41d8cd98f00b204e9800998ecf8427eUse as title or short text description
Example
An example titleExample
{ "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"}Media height in pixels.
Example
1600Use this identifier to communicate with Cloudinary.
Example
cloudinary-image-1True if media width is greater or equal to height
Example
trueAssociate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.
Example
LIFESTYLE_HEALTH_FITNESSDocument identifier
Example
3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.
Example
trueSort allows you to control how you want to sort this record in a list of media records.
Example
10Currently ONLY using Cloudinary to store all image / video assets.
Example
CLOUDINARYWhether Cloudinary media is a VIDEO or IMAGE.
Example
IMAGEMedia width in pixels.
Example
2560Example
{ "angle": null, "attribution": [], "category": "2", "descriptions": [ { "description": "Elegant lobby of The Siam Residences", "language": "en", "title": "Lobby Entrance" } ], "height": 1600, "identifier": "the-siam-residences/lobby-entrance", "isLandscape": true, "lifestyleType": null, "multimediaIdentifier": "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "published": true, "sort": 10, "source": "CLOUDINARY", "type": "IMAGE", "width": 2560}Descriptive name of this url for seller use only
Example
My Bali VillaThe entity supplying the inventory. Usually a hotel.
Example
e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18Url theme controls the look and feel of the ad banner.
Example
THEME_1In use by ancillary items only. Not used for room type or property. The transactional item on the ancillary to retrieve pricing for. If left empty, will find the cheapest priced item.
Example
8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29Twitter account is used with OpenGraph data
Example
@travelikoworldExample
{ "animate": true, "animateDelay": 1000, "channelInventoryIdentifier": "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "customizationIdentifier": "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "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": "19827398721938798237", "inventoryType": "GUEST_ROOM", "keywords": [ "bali" ], "multimedias": [ { "angle": null, "attribution": [], "category": "2", "descriptions": [ { "description": "Elegant lobby of The Siam Residences", "language": "en", "title": "Lobby Entrance" } ], "height": 1600, "identifier": "the-siam-residences/lobby-entrance", "isLandscape": true, "lifestyleType": null, "multimediaIdentifier": "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51", "published": true, "sort": 10, "source": "CLOUDINARY", "type": "IMAGE", "width": 2560 } ], "name": "My Bali Villa", "supplierIdentifier": "e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18", "theme": "THEME_1", "transactionalItemIdentifier": "8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29", "twitterAccount": "@travelikoworld"}Responses
Section titled “Responses”Shareable inventory link created successfully and attributed to the authenticated user
Seller URL
object
Create an animated gif instead of a list of images
Animation delay in milliseconds
Selected inventory record identifier
Channel inventory type is a subset of inventory type in that it does not include the HOTEL type. THe way it works is, as a seller you might want to sell a guest room but instead of showing the price of that guest room, you would like to display the best room type price for the property.
Datetime this record was first created
Customization identifier for link styling and branding
Localized link descriptions
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
Facebook APP ID is used with OpenGraph data
Unique identifier for this record.
Url sell status
Inventory type
Keywords
Datetime this record was last updated
Image entries
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.
Descriptive name of this url for seller use only
Managing entity (affiliate account) identifier
Url sell status
The entity supplying the inventory. Usually a hotel.
Url theme controls the look and feel of the ad banner.
In use by ancillary items only. Not used for room type or property. The transactional item on the ancillary to retrieve pricing for. If left empty, will find the cheapest priced item.
Twitter account is used with OpenGraph data
Unique link id
User (account) identifier
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
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