Skip to content
Wink

Search

POST
/wink.partner.v1.Lookup/Search
curl --request POST \
  --url https://example.com/wink.partner.v1.Lookup/Search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "term": "bangkok" }'

Search by term

Typeahead search across destinations. Send the partial text your user has typed and render the results as suggestions.

Terms shorter than 3 characters return an empty list rather than an error, so it is safe to call on every keystroke. At most 50 results are returned, most relevant first.

Suggestions are not filtered by your sales channel — a property you cannot sell may still appear here. Get is where that is enforced.

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json

Your Wink account identifier. Every call is scoped to one account, and your token must hold INVENTORY:READ on it.

object
term

What the user has typed so far. Fewer than 3 characters (after trimming) returns an empty list rather than an error.

string
Example
{
  "term": "bangkok"
}

Responses

Section titled “Responses”

200

Section titled “200”

The RPC completed with gRPC status OK.

Media typeapplication/json
object
destinations

Matching destinations, most relevant first. At most 50.

Array<object>

A place you can search for and sell through Wink.

object
id

Wink’s identifier for this destination entry.

string
type

What kind of place this is. Determines what type_identifier refers to.

string
Allowed values: DESTINATION_TYPE_UNSPECIFIED DESTINATION_TYPE_CITY DESTINATION_TYPE_ISLAND DESTINATION_TYPE_PROPERTY DESTINATION_TYPE_SPA DESTINATION_TYPE_MEETING_ROOM DESTINATION_TYPE_RESTAURANT DESTINATION_TYPE_ATTRACTION DESTINATION_TYPE_ACTIVITY DESTINATION_TYPE_PLACE DESTINATION_TYPE_COUNTRY
typeIdentifier

Identifier of the underlying resource — a property ID for DESTINATION_TYPE_PROPERTY, a geoname ID for DESTINATION_TYPE_CITY and DESTINATION_TYPE_COUNTRY. This is the id you pass to the other Wink endpoints that take a property or place.

string
name

Display name, in the language given by language_code.

string
urlName

URL slug. Pass this back to the lookup-by-slug call to resolve this destination later.

string
ownerName

Display name of the supplier that created this entry, where one applies.

string
cityName

Nearest city.

string
countryName
string
subCountryName

State or province.

string
subSubCountryName

County or district.

string
countryCode

ISO 3166-1 alpha-2 country code.

string
languageCode

ISO 639-1 code for the language name is written in.

string
longitude

Longitude and latitude in decimal degrees. Both are omitted together when the location is unknown — which is why they are optional rather than defaulting to 0/0, a real place in the Gulf of Guinea.

number format: double
latitude
number format: double
Example
{
  "destinations": [
    {
      "id": "efb6edfd-7969-434e-8453-be3495a9ffb1",
      "type": "CITY",
      "typeIdentifier": "1609350",
      "name": "Bangkok",
      "urlName": "bangkok-thailand",
      "cityName": "Bangkok",
      "countryName": "Thailand",
      "subCountryName": "Bangkok",
      "countryCode": "TH",
      "languageCode": "en",
      "longitude": 100.5493,
      "latitude": 13.7412
    },
    {
      "id": "025a9f08-a528-4a24-a2ef-c0c3cf74e0d4",
      "type": "HOTEL",
      "typeIdentifier": "71f0ec54-c24b-463a-a72e-b060c6c7a6fe",
      "name": "Amayen Sanctuary",
      "urlName": "amayen-sanctuary-doi-saket-thailand",
      "cityName": "Doi Saket",
      "countryName": "Thailand",
      "subCountryName": "Chiang Mai",
      "countryCode": "TH",
      "languageCode": "en",
      "longitude": 99.24162894487381,
      "latitude": 18.907146707330355
    }
  ]
}