Get shareable supplier link
const url = 'https://api.wink.travel/api/managing-entity/d2c8f3a9-4b1e-4c7a-9d3f-5b8a2e6c1d04/studio/shareable-link/supplier/7c9a2e5f-3d8b-4a1c-b6e2-8f0d1c4a9b3e';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/d2c8f3a9-4b1e-4c7a-9d3f-5b8a2e6c1d04/studio/shareable-link/supplier/7c9a2e5f-3d8b-4a1c-b6e2-8f0d1c4a9b3e \ --header 'Authorization: Bearer <token>' \ --header 'Wink-Version: 2.0'Retrieves a single shareable supplier link by its identifier, ensuring it belongs to the specified managing entity.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”Managing entity identifier (the owner of the shareable link)
Example
d2c8f3a9-4b1e-4c7a-9d3f-5b8a2e6c1d04Shareable link identifier
Example
7c9a2e5f-3d8b-4a1c-b6e2-8f0d1c4a9b3eHeader Parameters
Section titled “Header Parameters ”Responses
Section titled “ Responses ”Shareable link found and returned
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.
Creator of this shareable link (authenticated user)
Managing entity (owner) of this shareable link
Display name for this shareable link (internal reference, not shown to end users)
Customization configuration identifier (controls the visual theme and styling)
Localized link title and description (one entry per language/locale)
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.
Image entries
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.
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
Unique identifier that generates the shareable URL slug (e.g., share.wink.travel/HBDG87f2)
Twitter account handle for OpenGraph metadata when the link is shared
Facebook App ID for OpenGraph metadata when the link is shared
Visual theme controlling the appearance of the shareable link banner
Current status of the shareable link (ACTIVE, INACTIVE, ARCHIVED, etc.)
Property or supplier identifier (the entity whose inventory is promoted)
When true, renders selected images as an animated GIF (requires at least 2 images)
Animation frame delay in milliseconds (-1 = no animation)
Example
Bad Request
object
object
Example generated
{ "type": "https://example.com", "title": "example", "status": 1, "detail": "example", "instance": "https://example.com", "properties": { "additionalProperty": "example" }}object
object
object
object
object
object
object
object
Authentication required
object
object
User lacks MARKETING:READ permission for the managing entity
object
object
Shareable link not found or does not belong to the specified managing entity
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.
Creator of this shareable link (authenticated user)
Managing entity (owner) of this shareable link
Display name for this shareable link (internal reference, not shown to end users)
Customization configuration identifier (controls the visual theme and styling)
Localized link title and description (one entry per language/locale)
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.
Image entries
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.
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
Unique identifier that generates the shareable URL slug (e.g., share.wink.travel/HBDG87f2)
Twitter account handle for OpenGraph metadata when the link is shared
Facebook App ID for OpenGraph metadata when the link is shared
Visual theme controlling the appearance of the shareable link banner
Current status of the shareable link (ACTIVE, INACTIVE, ARCHIVED, etc.)
Property or supplier identifier (the entity whose inventory is promoted)
When true, renders selected images as an animated GIF (requires at least 2 images)
Animation frame delay in milliseconds (-1 = no animation)
Example
{ "id": "", "createdDate": "", "lastUpdate": "", "version": "", "userIdentifier": "", "ownerIdentifier": "", "name": "", "customizationIdentifier": "", "descriptions": [ "" ], "multimedias": [ "" ], "keywords": [ "" ], "uniqueId": "", "twitterAccount": "", "facebookAppId": "", "theme": "THEME_1", "status": "ACTIVE", "supplierIdentifier": "", "animate": false, "animateDelay": -1}Internal Server Error
object
Example generated
{}