Skip to content
Wink

Create a new ranked grid

POST
/api/managing-entity/{managingEntityIdentifier}/studio/ranked-grids
 
curl --request POST \
  --url https://api.wink.travel/api/managing-entity/d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69/studio/ranked-grids \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Wink-Version: 2.0' \
  --data '{ "name": "", "customizationIdentifier": "", "descriptions": "", "keywords": [ "" ], "lookup": "", "animate": false, "animateDelay": -1, "sort": "MEMBER", "displayType": "NATIVE" }'

Persists a new ranked grid for the managing entity and returns the created record. Requires MARKETING:WRITE permission.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
managingEntityIdentifier
required
string
""

Managing entity identifier

Example 
d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69

Header Parameters

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

Request Body required

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

Descriptive name of this list for seller use only

string
"" >= 1 characters
Example 
Featured Luxury Resorts Bangkok
customizationIdentifier
required

Customization identifier

string format: uuid
"" >= 1 characters
Example 
7d2e4f1a-6c8b-4a9e-b3d5-1e7f2a0c5b8d
descriptions
required

Contains custom title and description of grid

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
keywords
required
Array<string>
>= 1 items <= 2147483647 items
lookup
required

The destination to display ranked inventory from.

object
identifier

Unique lookup identifier

string format: uuid
""
Example 
b7e4c1a2-3f5d-4e8a-9c21-6f0b5d8e3a47
type

Type of lookup (CITY, HOTEL, ACTIVITY, SPA, RESTAURANT, ATTRACTION, ISLAND, COUNTRY, PLACE, MEETING_ROOM)

string
""
Allowed values: CITY ISLAND HOTEL SPA MEETING_ROOM RESTAURANT ATTRACTION ACTIVITY PLACE COUNTRY
Example 
CITY
typeIdentifier

Unique identifier for the lookup type resource (e.g., hotel ID, city geoname ID)

string format: uuid
""
Example 
1609350
name

Human-readable name of the lookup entry

string
""
Example 
Bangkok
urlName

URL-friendly slug that uniquely identifies this lookup within its type and location

string
""
Example 
bangkok-thailand
ownerIdentifier

Identifier of the owner (supplier) that created or manages this lookup entry

string format: uuid
""
Example 
e2c7b4d3-1a8f-4e9c-b5d6-3a9f0e7c2b18
ownerName

Name of the owner (supplier) that created this lookup entry

string
""
Example 
The Siam Residences, Bangkok
cityName

Name of the closest city where this lookup entry is located

string
""
Example 
Bangkok
countryName

Country name where this lookup entry is located

string
""
Example 
Thailand
subCountryName

State or province where this lookup entry is located

string
""
Example 
Bangkok
subSubCountryName

County or district where this lookup entry is located

string
""
Example 
Khlong San District
countryCode

ISO 3166-1 alpha-2 country code

string
""
Example 
TH
ownerType

Type of owner that created this lookup (TRAVELIKO for platform-managed entries, HOTEL for supplier-created entries)

string
""
Allowed values: TRAVELIKO HOTEL
Example 
TRAVELIKO
languageCode

Language code for the lookup name (ISO 639-1 format)

string
""
Example 
en
sort

Platform-specific sort order (lower values sort first: CITY=1, ISLAND=2, HOTEL=3, others vary)

integer format: int32
""
Example 
1
origin

Whether this is the primary/original lookup entry for this resource (true) or a variant like an alternate language or name (false)

boolean
Example 
true
lowercaseName

Lowercase version of the name, used for regex-based search operations

string
""
Example 
bangkok
location
required

Geo-location

object
x
number format: double
y
number format: double
type
string
coordinates
Array<number>
Example 
{
  "type": "POINT",
  "coordinates": [
    100.5581533,
    13.7370197
  ]
}
animate

Create an animated gif instead of a list of images

boolean
Example 
false
animateDelay

Controls animation delay in milliseconds; -1 to disable

integer format: int32
default: -1
Example 
500
sort

Determines which badge to show on the Web Component. Is also used to sort properties for search grids.

string
""
Allowed values: MEMBER PRICE_LOW_TO_HIGH PRICE_HIGH_TO_LOW PRICE POPULARITY ECO EXPERIENCE PERK LOYALTY ADD_ON
Example 
MEMBER
displayType

Indicate which initial values to display first on the front-facing card

string
default: NATIVE
Allowed values: NATIVE HOTEL ROOM
Example 
NATIVE

Responses

Section titled “ Responses ”

201

Section titled “201 ”

Created

Media type application/json
object
id

Document UUID

string format: uuid
""
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
""
ownerIdentifier
required

AffiliateAccount identifier

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

Descriptive name of this list for seller use only

string
"" >= 1 characters
customizationIdentifier
required

Customization identifier

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

Contains custom title and description of grid

Array<object>
"" >= 1 items <= 2147483647 items
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
keywords
required
Array<string>
>= 1 items <= 2147483647 items
status
required

Status

string
default: ACTIVE
Allowed values: ACTIVE INACTIVE REMOVED
lookup
required

The destination to display ranked inventory from.

object
identifier

Unique lookup identifier

string format: uuid
""
type

Type of lookup (CITY, HOTEL, ACTIVITY, SPA, RESTAURANT, ATTRACTION, ISLAND, COUNTRY, PLACE, MEETING_ROOM)

string
""
Allowed values: CITY ISLAND HOTEL SPA MEETING_ROOM RESTAURANT ATTRACTION ACTIVITY PLACE COUNTRY
typeIdentifier

Unique identifier for the lookup type resource (e.g., hotel ID, city geoname ID)

string format: uuid
""
name

Human-readable name of the lookup entry

string
""
urlName

URL-friendly slug that uniquely identifies this lookup within its type and location

string
""
ownerIdentifier

Identifier of the owner (supplier) that created or manages this lookup entry

string format: uuid
""
ownerName

Name of the owner (supplier) that created this lookup entry

string
""
cityName

Name of the closest city where this lookup entry is located

string
""
countryName

Country name where this lookup entry is located

string
""
subCountryName

State or province where this lookup entry is located

string
""
subSubCountryName

County or district where this lookup entry is located

string
""
countryCode

ISO 3166-1 alpha-2 country code

string
""
ownerType

Type of owner that created this lookup (TRAVELIKO for platform-managed entries, HOTEL for supplier-created entries)

string
""
Allowed values: TRAVELIKO HOTEL
languageCode

Language code for the lookup name (ISO 639-1 format)

string
""
sort

Platform-specific sort order (lower values sort first: CITY=1, ISLAND=2, HOTEL=3, others vary)

integer format: int32
""
origin

Whether this is the primary/original lookup entry for this resource (true) or a variant like an alternate language or name (false)

boolean
lowercaseName

Lowercase version of the name, used for regex-based search operations

string
""
location
required

Geo-location

object
x
number format: double
y
number format: double
type
string
coordinates
Array<number>
animate

Create an animated gif instead of a list of images

boolean
animateDelay

Controls animation delay in milliseconds. -1 is disabled

integer format: int32
default: -1
sort

Determines which badge to show on the Web Component. Is also used to sort properties for search grids.

string
""
Allowed values: MEMBER PRICE_LOW_TO_HIGH PRICE_HIGH_TO_LOW PRICE POPULARITY ECO EXPERIENCE PERK LOYALTY ADD_ON
displayType

Indicate which initial values to display first on the front-facing card

string
default: NATIVE
Allowed values: NATIVE HOTEL ROOM
Example 
{
  "id": "",
  "createdDate": "",
  "lastUpdate": "",
  "version": "",
  "ownerIdentifier": "",
  "name": "",
  "customizationIdentifier": "",
  "descriptions": "",
  "keywords": [
    ""
  ],
  "status": "ACTIVE",
  "lookup": "",
  "animate": false,
  "animateDelay": -1,
  "sort": "MEMBER",
  "displayType": "NATIVE"
}

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