Skip to content
Wink

Show Shareable Link

POST
/api/public/shareable-link/{code}
 
curl --request POST \
  --url 'https://api.wink.travel/api/public/shareable-link/?cid=&_gl=' \
  --header 'Content-Type: application/json' \
  --header 'Host: ' \
  --header 'Referer: ' \
  --header 'User-Agent: ' \
  --header 'Wink-Version: 2.0' \
  --data null

Retrieve link with a user session

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
code
required
string
""

Unique link code

Header Parameters

Section titled “Header Parameters ”
User-Agent
string
""

User-Agent header.

Host
string
""

Host header.

Referer
string
""

Referrer header.

Wink-Version
string
default: 2.0.0
Allowed values: 2.0

Query Parameters

Section titled “Query Parameters ”
cid
string
""

Optional campaignId

_gl
string
""

Optional GA4 cross link ID

Request Body required

Section titled “Request Body required ”
Media type application/json

User session information containing itinerary and other user related data.

object
itinerary
required

Dates and travel info.

object
startDate
required

Start date of itinerary

string format: date
""
Example 
2024-01-01
endDate

Optional end date. If endDate is empty, nights needs to be present. If both are present, nights will take precedence.

string format: date
""
Example 
2024-01-02
nights

Optional number of nights. If nights is empty, endDate needs to be present. If both are present, nights will take precedence.

integer format: int32
""
items
required

Room configurations

Array<object>
>= 1 items <= 2147483647 items

Room Configuration

object
adults
required

Number of adults

integer format: int32
default: 1 >= 1
Example 
2
children

Children configurations

Array<object>

BookingItineraryRoomConfigurationChild configuration

object
quantity
required

Number of children

integer format: int32
"" >= 1
age
required

Age of children

integer format: int32
""
quantity

Number of identical rooms of this configuration being booked

integer format: int32
default: 1 >= 1
Example 
1
hours

Number of hours between start and end dates. Used for itineraries that require bookings that occur within hours and not days. E.g. Meeting room reservation.

integer format: int64
""
children

How many total children for this stay

integer format: int32
""
rooms

How many total rooms for this stay

integer format: int32
""
guests

How many total guests for this stay

integer format: int32
""
language

User’s language preference

string
""
Example 
en
currency

User’s currency preference

string
""
Example 
USD
promotionalCodes
Array<string>
selectedRoomConfigurationIndex

User can pass the current room configuration index to retrieve rates specifically for that room configuration.

integer format: int32
""
lifestyle

The preferred user lifestyle.

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

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json
object
type
required

The type of document the uniqueId links to

string
""
Allowed values: SELLABLE_INVENTORY_SLUG SELLABLE_SUPPLIER_SLUG AFFILIATE_ACCOUNT_SLUG SYNDICATED_ITEM_SLUG URL
language
required

Which language the seller wanted to use

string
default: en >= 1 characters
currency

Which currency the seller is using

string
default: USD
title
required

Link title

string
"" >= 1 characters
description
required

Link description

string
"" >= 1 characters
keywords

Comma-separated keyword values that can be used to populate HTML metadata

string
""
uniqueId
required

The URL ID that uniquely represents this link

string
"" >= 1 characters
twitterAccount

Optional X account ID

string
""
facebookAppId

Optional Facebook app ID

string
""
thirdPartyGoogleMeasurementId

Optional 3rd party GA4 Measurement ID

string
""
thirdPartyGoogleTagManagerContainerId

Optional 3rd party GTM Container ID

string
""
image

The image you want to accompany this link

object
channel
string
Allowed values: FACEBOOK INSTAGRAM LINKED_IN TWITTER REDDIT
url
string
width
integer format: int32
height
integer format: int32
type
string
Allowed values: IMAGE VIDEO
mimeType
string
altText
string
video

The video you want to accompany this link

object
channel
string
Allowed values: FACEBOOK INSTAGRAM LINKED_IN TWITTER REDDIT
url
string
width
integer format: int32
height
integer format: int32
type
string
Allowed values: IMAGE VIDEO
mimeType
string
altText
string
transactUrl
required

The transation url, or where to redirect to when clicking the CTA button.

string
"" >= 1 characters
Example 
{
  "type": "SELLABLE_INVENTORY_SLUG",
  "language": "en",
  "currency": "USD",
  "title": "",
  "description": "",
  "keywords": "",
  "uniqueId": "",
  "twitterAccount": "",
  "facebookAppId": "",
  "thirdPartyGoogleMeasurementId": "",
  "thirdPartyGoogleTagManagerContainerId": "",
  "image": "",
  "video": "",
  "transactUrl": ""
}

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
{}