Create Link

POST

/api/managing-entity/{managingEntityIdentifier}/studio/shareable-link/inventory

const url = 'https://api.wink.travel/api/managing-entity/owner-1/studio/shareable-link/inventory';
const options = {
  method: 'POST',
  headers: {'Wink-Version': '2.0', '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/owner-1/studio/shareable-link/inventory \
  --header 'Content-Type: application/json' \
  --header 'Wink-Version: 2.0' \
  --data null

Create a new shareable link

Parameters

Path Parameters

managingEntityIdentifier

required

string

Create link owned by this owner identifier.

Example

owner-1

Header Parameters

Wink-Version

string

default: 2.0.0

Allowed values: 2.0

Request Body^required

application/json

Upserts a SellableInventoryUrl entity

object

name

required

Descriptive name of this url for seller use only

string

"" >= 1 characters

Example

My Bali Villa

customizationIdentifier

required

Customization identifier

string format: uuid

"" >= 1 characters

Example

customization-1

descriptions

required

Localized link descriptions

Array<object>

"" >= 1 items <= 2147483647 items

object

name

required

Use as title or short text description

string

Example

An example title

description

required

Longer text description

string

"" >= 1 characters <= 2147483647 characters

Example

This is a longer description in the specified language.

language

required

Indicate which language this description is written in.

string

default: en >= 2 characters <= 2 characters

Example

en

creator

Whether it was user or system generated.

string

default: USER

Allowed values: SYSTEM USER

Example

SYSTEM

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

Example

image-1

identifier

required

Use this identifier to communicate with Cloudinary.

string

"" >= 1 characters

Example

cloudinary-image-1

type

required

Whether Cloudinary media is a VIDEO or IMAGE.

string

Allowed values: IMAGE VIDEO AUDIO RAW

Example

IMAGE

source

required

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

string

default: CLOUDINARY

Allowed values: YOUTUBE CLOUDINARY

Example

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

Example

angle

Media angle

string

Example

-90

width

required

Media width in pixels.

integer format: int32

"" >= 1

Example

height

required

Media height in pixels.

integer format: int32

"" >= 1

Example

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

Example

true

category

Supported OTA specification PIC code. See OTA geoname data

string

Example

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

Example

An example title

description

required

Longer text description

string

"" >= 1 characters <= 2147483647 characters

Example

This is a longer description in the specified language.

language

required

Indicate which language this description is written in.

string

default: en >= 2 characters <= 2 characters

Example

en

creator

Whether it was user or system generated.

string

default: USER

Allowed values: SYSTEM USER

Example

SYSTEM

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

Example

LIFESTYLE_HEALTH_FITNESS

attribution

Whether image has attribution properties

Array<object>

object

url

URL to contributor

string

Example

https://maps.google.com/maps/contrib/111628493169070103594

name

required

Name of contributor

string

"" >= 1 characters

Example

Samuel Adams

isLandscape

True if media width is greater or equal to height

boolean

Example

true

keywords

Array<string>

twitterAccount

Twitter account is used with OpenGraph data

string

Example

@travelikoworld

facebookAppId

Facebook APP ID is used with OpenGraph data

string

Example

19827398721938798237

theme

required

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

string

Allowed values: THEME_1

Example

THEME_1

inventoryType

required

Inventory type

string

Allowed values: HOTEL GUEST_ROOM MEETING_ROOM RESTAURANT SPA ADD_ON ATTRACTION ACTIVITY PLACE

Example

GUEST_ROOM

supplierIdentifier

required

The entity supplying the inventory. Usually a hotel.

string

"" >= 1 characters

Example

hotel-1

channelInventoryIdentifier

required

Selected inventory record

string

"" >= 1 characters

Example

channel-inventory-1

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

Example

transactional-item-1

animate

Create an animated gif instead of a list of images

boolean

Example

true

animateDelay

Animation delay in milliseconds

integer format: int32

default: -1

Example

Responses

201

Created

application/json

object

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

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

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

Unauthorized

*/*

object

type

string format: uri

title

string

status

integer format: int32

detail

string

instance

string format: uri

properties

object

key

additional properties

403

Forbidden

*/*

object

type

string format: uri

title

string

status

integer format: int32

detail

string

instance

string format: uri

properties

object

key

additional properties

500

Internal Server Error

object

Example ^generated

{}

Create Link

Parameters

Path Parameters

Example

Header Parameters

Request Body required

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Responses

201

Example

400

Example generated

401

403

500

Example generated

Request Body^required

Example ^generated

Example ^generated