Skip to content
Wink

Show Links

GET
/api/managing-entity/{managingEntityIdentifier}/studio/shareable-link/inventory/list
 
curl --request GET \
  --url https://api.wink.travel/api/managing-entity/owner-1/studio/shareable-link/inventory/list \
  --header 'Wink-Version: 2.0'

Retrieve list of shareable urls for this seller

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
managingEntityIdentifier
required
string
""

Show links list owned by this owner identifier.

Example 
owner-1

Header Parameters

Section titled “Header Parameters ”
Wink-Version
string
default: 2.0.0
Allowed values: 2.0

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json
Array<object>
object
id

Document UUID

string
""
createdDate

Datetime this record was first created

string format: date-time
""
lastUpdate

Datetime this record was last updated

string format: date-time
""
version

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.

integer format: int64
""
userIdentifier
required

Creator of entry

string format: uuid
"" >= 1 characters
ownerIdentifier
required

AffiliateAccount identifier

string format: uuid
"" >= 1 characters
name
required

Descriptive name of this url for seller use only

string
"" >= 1 characters
customizationIdentifier
required

Customization identifier

string format: uuid
"" >= 1 characters
descriptions
required
Array<object>
>= 1 items <= 2147483647 items

Localized link descriptions

object
name
required

Use as title or short text description

string
""
description
required

Longer text description

string
"" >= 1 characters <= 2147483647 characters
language
required

Indicate which language this description is written in.

string
default: en >= 2 characters <= 2 characters
creator

Whether it was user or system generated.

string
default: USER
Allowed values: SYSTEM USER
md5ContentHash

The md5 hash of the name, description and language.

string
""
hashMismatch
boolean
multimedias
Array<object>

The selected media for this url.

object
multimediaIdentifier
required

Document identifier

string format: uuid
"" >= 1 characters
identifier
required

Use this identifier to communicate with Cloudinary.

string
"" >= 1 characters
type
required

Whether Cloudinary media is a VIDEO or IMAGE.

string
""
Allowed values: IMAGE VIDEO AUDIO RAW
source
required

Currently ONLY using Cloudinary to store all image / video assets.

string
default: CLOUDINARY
Allowed values: YOUTUBE CLOUDINARY
sort
required

Sort allows you to control how you want to sort this record in a list of media records.

integer format: int32
default: 999
angle

Media angle

string
""
width
required

Media width in pixels.

integer format: int32
"" >= 1
height
required

Media height in pixels.

integer format: int32
"" >= 1
published

Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.

boolean
category

Supported OTA specification PIC code. See OTA geoname data

string
""
descriptions

Localized media captions to give user some context about where this media was taken.

Array<object>
""
object
name
required

Use as title or short text description

string
""
description
required

Longer text description

string
"" >= 1 characters <= 2147483647 characters
language
required

Indicate which language this description is written in.

string
default: en >= 2 characters <= 2 characters
creator

Whether it was user or system generated.

string
default: USER
Allowed values: SYSTEM USER
md5ContentHash

The md5 hash of the name, description and language.

string
""
hashMismatch
boolean
lifestyleType

Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.

string
""
Allowed values: LIFESTYLE_HEALTH_FITNESS LIFESTYLE_RELAX LIFESTYLE_ADULT_ONLY LIFESTYLE_ADVENTURE LIFESTYLE_BUSINESS LIFESTYLE_LGBT LIFESTYLE_SINGLE_PARENT LIFESTYLE_SOLO_FEMALE LIFESTYLE_BEAUTY LIFESTYLE_FOODIE LIFESTYLE_FAMILY LIFESTYLE_ROMANCE LIFESTYLE_COUPLE LIFESTYLE_SOLO LIFESTYLE_BACKPACKER LIFESTYLE_SHOPPING LIFESTYLE_SPORTS LIFESTYLE_MOUNTAIN LIFESTYLE_BEACH LIFESTYLE_CITY LIFESTYLE_COUNTRY LIFESTYLE_CULTURE LIFESTYLE_ECO
attribution

Whether image has attribution properties

Array<object>
""
object
url

URL to contributor

string
""
name
required

Name of contributor

string
"" >= 1 characters
isLandscape

True if media width is greater or equal to height

boolean
keywords
Array<string>
uniqueId
required

Unique link id

string
"" >= 1 characters
twitterAccount

Twitter account is used with OpenGraph data

string
""
facebookAppId

Facebook APP ID is used with OpenGraph data

string
""
theme
required

Url theme controls the look and feel of the ad banner.

string
""
Allowed values: THEME_1
status
required

Url sell status

string
""
Allowed values: ACTIVE INACTIVE REMOVED
inventoryStatus
required

Url sell status

string
""
Allowed values: ACTIVE INACTIVE REMOVED
inventoryType
required

Inventory type

string
""
Allowed values: HOTEL GUEST_ROOM MEETING_ROOM RESTAURANT SPA ADD_ON ATTRACTION ACTIVITY PLACE
channelInventoryType
required

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.

string
""
Allowed values: GUEST_ROOM ADD_ON MEETING_ROOM RESTAURANT SPA ATTRACTION PLACE ACTIVITY
supplierIdentifier
required

The entity supplying the inventory. Usually a hotel.

string
"" >= 1 characters
channelInventoryIdentifier
required

Selected inventory record

string
"" >= 1 characters
transactionalItemIdentifier

In use by ancillary items only. Not used room type or property. The transactional item on the ancillary to retrieve pricing for. If left empty, will find the cheapest priced item.

string
""
animate

Create an animated gif instead of a list of images

boolean
animateDelay

Animation delay in milliseconds

integer format: int32
default: -1
Example 
[
  {
    "id": "",
    "createdDate": "",
    "lastUpdate": "",
    "version": "",
    "userIdentifier": "",
    "ownerIdentifier": "",
    "name": "",
    "customizationIdentifier": "",
    "descriptions": [
      ""
    ],
    "multimedias": [
      ""
    ],
    "keywords": [
      ""
    ],
    "uniqueId": "",
    "twitterAccount": "",
    "facebookAppId": "",
    "theme": "THEME_1",
    "status": "ACTIVE",
    "inventoryStatus": "ACTIVE",
    "inventoryType": "HOTEL",
    "channelInventoryType": "GUEST_ROOM",
    "supplierIdentifier": "",
    "channelInventoryIdentifier": "",
    "transactionalItemIdentifier": "",
    "animate": false,
    "animateDelay": -1
  }
]

400

Section titled “400 ”

Bad Request

object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
Example generated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  }
}

401

Section titled “401 ”

Unauthorized

Media type */*
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties

403

Section titled “403 ”

Forbidden

Media type */*
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties

500

Section titled “500 ”

Internal Server Error

object
Example generated
{}