Skip to content

Show all

GET
/api/managing-entity/{managingEntityIdentifier}/studio/browse/category/list
curl --request GET \
--url https://api.wink.travel/api/managing-entity/d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69/studio/browse/category/list \
--header 'Authorization: Bearer <token>' \
--header 'Wink-Version: 2.0'

Lists the search categories present across the affiliate’s active inventory, for use as browse facets.

managingEntityIdentifier
required
string
""

The property ID to list search categories for

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

Search category facets derived from the affiliate’s active inventory

Media type application/json
Array<object>

A single OTA search facet / category entry that groups inventory or hotels under a typed key-value code, along with the number of matching results.

object
type
required

Type of search category.

string
""
Allowed values: HOTEL INVENTORY
key
required

Usually the OTA inventory code.

string
"" >= 1 characters
value
required

Usually the OTA inventory code value.

string
"" >= 1 characters
count

Quantity of items in this category.

integer format: int64
""
identifier

Unique search category identifier.

string format: uuid
""
Example
[
{
"identifier": "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51",
"type": "HOTEL",
"key": "GRE",
"value": "GRE-001",
"count": 15
}
]

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