Supplier Search

POST

/api/managing-entity/{managingEntityIdentifier}/studio/supplier/grid

const url = 'https://api.wink.travel/api/managing-entity//studio/supplier/grid';
const options = {
  method: 'POST',
  headers: {'Wink-Version': '2.0', 'Content-Type': 'application/json'},
  body: '{"skip":0,"take":30,"sort":"","filter":"","group":""}'
};

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//studio/supplier/grid \
  --header 'Content-Type: application/json' \
  --header 'Wink-Version: 2.0' \
  --data '{ "skip": 0, "take": 30, "sort": "", "filter": "", "group": "" }'

Retrieve page of available suppliers based on search criteria.

Parameters

Path Parameters

managingEntityIdentifier

required

string

The company ID to show suppliers for

Header Parameters

Wink-Version

string

default: 2.0.0

Allowed values: 2.0

Request Body^required

application/json

object

skip

Number of records to be skipped by the pager.

integer format: int32

Example

take

Number of records to take.

integer format: int32

default: 30 >= 1 <= 180

Example

sort

Descriptors used for sorting result set.

Array<object>

object

dir

Descriptors used for sorting result set

string

Allowed values: asc desc

Example

asc

field

Data set field to sort on

string

Example

hotel.name

filter

Descriptors used for filtering result set

object

logic

Whether to filter inclusively or exclusively

string

Allowed values: and or

Example

and

filters

Descriptors used for filtering the result set

Array<object>

object

field

required

Field name to filter on

string

"" >= 1 characters

Example

hotel.name

operator

required

Filter operator to use on field

string

Allowed values: neq eq contains doesnotcontain isnull isnotnull isempty isnotempty startswith endswith gte lte gt lt in nin

Example

startsWith

value

Value to filter dataset against

Example

Happy Res

ignoreCase

Make filter comparison case insensitive. Default: Case sensitive

boolean

Example

true

group

Descriptors to group result sets by.

Array<object>

object

field

Field to group data set on

string

Example

createdDate

dir

Group sort direction

string

Allowed values: asc desc

Example

asc

aggregates

Primitive aggregate data points

Array<object>

object

field

Field to run aggregate function on

string

Example

hotel.bookings

aggregate

Aggregate function

string

Allowed values: count sum average min max

Example

count

Responses

200

application/json

object

totalPages

integer format: int32

totalElements

integer format: int64

size

integer format: int32

content

Array<object>

object

hotelIdentifier

Unique hotel record identifier.

string format: uuid

name

Hotel trade name

string

localName

Hotel local name if different from the trade name or if it is the local language.

string

chain

Name of hotel chain if applicable.

string

brand

Name of hotel brand

string

urlName

Unique URL-friendly name slug of hotel

string

uniqueId

required

Event shorter name

string

"" >= 1 characters

starRating

Official or self-designated property star rating. Note that in some regions there are 6-star hotels. They are the same as 5-star hotels everywhere else.

integer format: int32

"" <= 6

bookings

Number of bookings for this property on the wink.travel platform.

integer format: int64

aggregateReviewRating

Aggregate score based on all current user reviews.

number format: float

default: 0.0

location

Geo-location

object

number format: double

type

string

coordinates

Array<number>

descriptions

Short and long welcome text

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

aggregateGreendexRating

Aggregate Green Index score if the property has answered our questionnaire available in the Extranet.

number format: float

default: 0.0

lifestyleTypes

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

totalReviews

Count of total reviews left by users at this property.

integer format: int32

reservations

Contact details for reservations desk

object

firstName

Contact first name

string

lastName

Contact last name

string

email

Contact E-mail

string format: email

secondaryEmail

Contact secondary Email

string

phoneNumber

Contact phone number

string

fullName

First and last name

string

summary

Summary

string

socials

Property’s social network accounts

Array<object>

Social network

object

type

Type of social network.

string

Allowed values: FACEBOOK INSTAGRAM SKYPE TRIP_ADVISOR TWITTER GOOGLE_PLUS WHATSAPP LINE WECHAT VIBER SNAPCHAT WEIBO RENREN WEBSITE QQ TIKTOK

location

URL or social network identifier to social network profile

string

images

Property images.

Array<object>

Multimedia that contains less information than Multimedia object

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

videos

Property videos.

Array<object>

Multimedia that contains less information than Multimedia object

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

policy

Basic property policy record.

object

childrenAllowed

required

Indicates whether property allows children

boolean

childrenMinimumAge

When a property allows children, it can also indicate what the minimum age is for children to be allowed.

integer format: int32

internetAvailability

required

Indicates the availability of internet on the property.

string

Allowed values: YES NO YES_PAID

internetConnectionType

Indicates how guests can access the Internet on the property.

string

Allowed values: WIFI CABLE

internetConnectionLocation

Indicates where internet is available in and around the property.

string

Allowed values: ENTIRE_PROPERTY PUBLIC_AREAS ALL_ROOMS SOME_ROOMS BUSINESS_CENTER

parkingAvailability

required

Indicates whether parking is available at the property.

string

Allowed values: YES NO YES_PAID

parkingAccess

Indicates what type of parking is available at the property.

string

Allowed values: PRIVATE PUBLIC

petsAllowed

required

Indicates whether pets are allowed on the property. Note: There are thousand different kinds of pets. Just because the property allows small dogs does not mean the guest can bring a python. Always best to check with property.

boolean

petMaxWeightInKilos

If pets are allowed, property can further limit on weight.

integer format: int32

petCharge

If pets are allowed, property can tell travelers if there is a charge applicable for the pet.

object

amount

required

number

currency

required

string

>= 1 characters

checkOutTime

required

When the guest has to check out.

string

"" >= 1 characters

checkInTime

required

When the guest can check in.

string

"" >= 1 characters

thirdPartyReviews

Array of awards and third party reviews given to property by certified / non-certified providers.

Array<object>

Recognition for the ancillary blocking.

object

identifier

required

Recognition identifier.

string format: uuid

"" >= 1 characters

category

required

Recognition category.

string

Allowed values: THIRD_PARTY_REVIEW PUBLICATION AWARD

type

required

Type of rating system the recognition operated on. This allows us to display the score properly.

string

Allowed values: STAR_RATING NUMERIC_RATING PERCENT_RATING

provider

required

The name of the entity that administers this recognition.

string

"" >= 1 characters

rating

required

The actual award or rating received by the hotel facility.

number format: float

maxRating

required

Use this to let hotels indicate what the total score for this award is.

number format: float

date

The date the award was received

string format: date

officialAppointmentInd

When true, this indicates the property has received official permission from the award provider to use the rating in publications and marketing materials; when false this permission has not been granted.

boolean

ratingSymbol

Provides the symbol used in the rating. Used in conjunction with the Rating.

string

attractions

Number of attractions property has listed on its profile.

integer format: int32

activities

Number of activites property has listed on its profile.

integer format: int32

places

Number of places property has listed on its profile.

integer format: int32

restaurants

Number of restaurants property has on its profile.

integer format: int32

meetingRooms

Number of meeting rooms property has on its profile.

integer format: int32

spas

Number of spas property has on its profile.

integer format: int32

addOns

Number of add-ons property has on its profile.

integer format: int32

generalManager

General manager related data.

object

name

required

Name of GM currently managing the property.

string

image

Cloudinary image identifier of GM currently managing the property.

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

descriptions

Localized welcome message from GM.

Array<object>

object

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

locationCategory

Supported OTA specification LOC code. See OTA geoname data

string

segmentCategory

Supported OTA specification SEG code. See OTA geoname data

string

hotelCategory

Supported OTA specification PCT code. See OTA geoname data

string

architecturalStyle

Supported OTA specification ARC code. See OTA geoname data

string

whenBuilt

Year the property was constructed.

string

currencyCode

Currency code for property.

string

membershipRateDiscount

A property’s price score is based on calculating historical pricing data. Each property receives a unique score. There is no max score; it’s there to compare it against other properties.

number format: float

priceScore

A property’s price score is based on calculating historical pricing data. Each property receives a unique score. There is no max score; it’s there to compare it against other properties.

integer format: int32

perkScore

A property’s perk score is based on the type of perks that is offered to the guests across all master rates. There is no max score; it’s there to compare it against other properties.

integer format: int32

addOnScore

A property’s package score is based on general availability and price for all packages and add-ons offered by the property. There is no max score; it’s there to compare it against other properties.

integer format: int32

loyaltyScore

A property’s loyalty score is based on calculating how many available rate plans honor loyalty points. There is no max score; it’s there to compare it against other properties.

integer format: int32

popularScore

A property’s popular score is based on calculating number of bookings across room types. There is no max score; it’s there to compare it against other properties.

integer format: int32

experienceScore

A property’s experience score is based on how calculating how many types of experiences are available and at what price ranges. There is no max score; it’s there to compare it against other properties.

integer format: int32

hotelAmenityCodes

Supported OTA specification HAC code. See OTA geoname data

Array<string>

propertyAccessibilityCodes

Supported OTA specification PHY code. See OTA geoname data

Array<string>

propertySecurityCodes

Supported OTA specification SEC code. See OTA geoname data

Array<string>

numberOfRooms

Number of rooms / keys for this property.

integer format: int32

address

Property address.

object

address1

Address line 1

string

address2

Address line 2

string

state

State

string

postalCode

Postal / zip code

string

county

County

string

city

City name

string

countryCode

Country

string

country

Country

string

fullAddress

Address 1, Address 2, City, State, Postal / Zip code, Country

string

active

Whether property is active

boolean

number

integer format: int32

numberOfElements

integer format: int32

sort

object

empty

boolean

unsorted

boolean

sorted

boolean

first

boolean

last

boolean

pageable

object

offset

integer format: int64

sort

object

empty

boolean

unsorted

boolean

sorted

boolean

pageSize

integer format: int32

paged

boolean

pageNumber

integer format: int32

unpaged

boolean

empty

boolean

Example

{
  "content": [
    {
      "hotelIdentifier": "",
      "name": "",
      "localName": "",
      "chain": "",
      "brand": "",
      "urlName": "",
      "uniqueId": "",
      "starRating": "",
      "bookings": 0,
      "aggregateReviewRating": "0.0",
      "location": "",
      "descriptions": "",
      "aggregateGreendexRating": "0.0",
      "lifestyleTypes": [
        "LIFESTYLE_HEALTH_FITNESS"
      ],
      "totalReviews": 0,
      "reservations": "",
      "socials": "",
      "images": "",
      "videos": "",
      "policy": "",
      "thirdPartyReviews": "",
      "attractions": 0,
      "activities": 0,
      "places": 0,
      "restaurants": 0,
      "meetingRooms": 0,
      "spas": 0,
      "addOns": 0,
      "generalManager": null,
      "locationCategory": "",
      "segmentCategory": "",
      "hotelCategory": "",
      "architecturalStyle": "",
      "whenBuilt": "",
      "currencyCode": "",
      "membershipRateDiscount": 0,
      "priceScore": 0,
      "perkScore": 0,
      "addOnScore": 0,
      "loyaltyScore": 0,
      "popularScore": 0,
      "experienceScore": 0,
      "hotelAmenityCodes": "",
      "propertyAccessibilityCodes": "",
      "propertySecurityCodes": "",
      "numberOfRooms": 0,
      "address": "",
      "active": false
    }
  ]
}

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

{}

Supplier Search

Parameters

Path Parameters

Header Parameters

Request Body required

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Responses

200

Example

400

Example generated

401

403

500

Example generated

Request Body^required

Example ^generated

Example ^generated