Skip to content

Create

POST
/api/managing-entity/{managingEntityIdentifier}/studio/dynamic-list
curl --request POST \
--url https://api.wink.travel/api/managing-entity/d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69/studio/dynamic-list \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Wink-Version: 2.0' \
--data null

Creates a new saved search whose filters resolve to a live list of suppliers/inventory when queried.

managingEntityIdentifier
required
string
""

Create search owned by this managing entity.

Example
d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69
Wink-Version
string
default: 2.0.0
Allowed values: 2.0

Dynamic list definition including filter criteria, sorting rules and display settings

Media type application/json

Request payload to create or update a dynamic inventory search list with filter criteria and sort preferences.

object
name
required

Name of dynamic list for when user want to persist it

string
"" >= 1 characters
Example
Bangkok Luxury Hotels
propertyName

Regex expression filter matching on property name.

string
""
Example
The Siam
locationCategories

Supported OTA specification LOC code. See OTA geoname data

Array<string>
""
Example
1701
segmentCategories

Supported OTA specification SEG code. See OTA geoname data

Array<string>
""
Example
7
hotelCategories

Supported OTA specification PCT code. See OTA geoname data

Array<string>
""
Example
1
architecturalStyles

Supported OTA specification ARC code. See OTA geoname data

Array<string>
""
Example
50
inventoryName

Regex expression filter matching on inventory name

string
""
Example
Deluxe Suite
continents

Continent filter

Array<string>
countries

Country filter

Array<string>
cities

City filter

Array<string>
showEcoFriendly

Filter on eco-friendly hotels

boolean
Example
false
showPetFriendly

Filter on pet-friendly hotels

boolean
Example
false
showChildFriendly

Filter on child-friendly hotels

boolean
Example
false
showPopular

Filter on hotel that has had a certain amount of bookings

boolean
Example
false
showDirectOnly

Filter on direct inventory

boolean
Example
false
lifestyles

Filter on lifestyles

Array<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_RELAX
hotelStars

Filter on number of stars the hotel has.

integer format: int32
""
Example
5
aggregateReviewRating

Filter on aggregate review score the hotel has

integer format: int32
""
Example
8
nearPoint

Find hotels close to certain location

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

Use this in conjunction with nearPoint. Control the distance from point we are searching for.

integer format: int64
0
Example
5000
inventoryTypes

Filter on inventory types

Array<string>
Allowed values: GUEST_ROOM ADD_ON MEETING_ROOM RESTAURANT SPA ATTRACTION PLACE ACTIVITY
primaryOrderBy

Control how you want the search results sorted. Options are:

  • 1: Inventory name
  • 2: Price: High to low
  • 3: Price: Low to high
  • 4: Commission: High to low
  • 5: Commission: Low to high
  • 6: Discount: High to low
  • 7: Discount: Low to high
string
""
Example
4
Example
{
"name": "Bangkok Luxury Hotels",
"propertyName": "The Siam",
"locationCategories": 1701,
"segmentCategories": 7,
"hotelCategories": 1,
"architecturalStyles": 50,
"inventoryName": "Deluxe Suite",
"continents": [
"AS"
],
"countries": [
"1605651"
],
"cities": [
"1609350"
],
"showEcoFriendly": false,
"showPetFriendly": false,
"showChildFriendly": false,
"showPopular": false,
"showDirectOnly": false,
"lifestyles": "LIFESTYLE_RELAX",
"hotelStars": 5,
"aggregateReviewRating": 8,
"radiusInMeters": 5000,
"inventoryTypes": [
"GUEST_ROOM"
],
"primaryOrderBy": "4"
}

Saved search created successfully.

Media type application/json

A saved dynamic inventory search with configurable filter criteria and sort order, owned by a managing entity.

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

Entity identifier of record creator

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

Name of dynamic list for when user want to persist it

string
"" >= 1 characters
propertyName

Regex expression filter matching on property name.

string
""
locationCategories

Supported OTA specification LOC code. See OTA geoname data

Array<string>
""
segmentCategories

Supported OTA specification SEG code. See OTA geoname data

Array<string>
""
hotelCategories

Supported OTA specification PCT code. See OTA geoname data

Array<string>
""
architecturalStyles

Supported OTA specification ARC code. See OTA geoname data

Array<string>
""
inventoryName

Regex expression filter matching on inventory name

string
""
continents

Continent filter

Array<string>
countries

Country filter

Array<string>
cities

City filter

Array<string>
showEcoFriendly

Filter on eco-friendly hotels

boolean
showPetFriendly

Filter on pet-friendly hotels

boolean
showChildFriendly

Filter on child-friendly hotels

boolean
showPopular

Filter on hotel that has had a certain amount of bookings

boolean
showDirectOnly

Filter on direct inventory

boolean
lifestyles

Filter on lifestyles

Array<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
hotelStars

Filter on number of stars the hotel has.

integer format: int32
""
aggregateReviewRating

Filter on aggregate review score the hotel has

integer format: int32
""
nearPoint

Find hotels close to certain location

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

Use this in conjunction with nearPoint. Control the distance from point we are searching for.

integer format: int64
0
inventoryTypes

Filter on inventory types

Array<string>
Allowed values: GUEST_ROOM ADD_ON MEETING_ROOM RESTAURANT SPA ATTRACTION PLACE ACTIVITY
primaryOrderBy

Control how you want the search results sorted. Options are:

  • 1: Inventory name
  • 2: Price: High to low
  • 3: Price: Low to high
  • 4: Commission: High to low
  • 5: Commission: Low to high
  • 6: Discount: High to low
  • 7: Discount: Low to high
string
""
key
additional properties
""
Example

Bad Request — missing or invalid request parameter or body

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

Unauthorized — authentication is required or the session has expired

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

Forbidden — authenticated but lacking the required permission or scope

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

Not Found — the requested resource does not exist

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

Method Not Allowed — the HTTP verb is not supported on this endpoint

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

Unsupported Media Type — use application/json

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

Internal Server Error — an unexpected failure occurred on the server

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example

Service Unavailable — a downstream dependency is unreachable

Media type application/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
key
additional properties
""
Example