Skip to content

Report unavailable

POST
/api/inventory/unavailable
curl --request POST \
--url https://api.wink.travel/api/inventory/unavailable \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Wink-Version: 2.0' \
--data '{ "propertyIdentifier": "", "propertyName": "", "inventoryName": "", "inventoryType": "", "inventoryIdentifier": "", "userSession": null }'

Notifies the property that a guest searched but found no available supply for the requested inventory, capturing the itinerary and guest counts from the request so the host can review their availability.

Wink-Version
string
default: 2.0.0
Allowed values: 2.0
Media type application/json
object
propertyIdentifier
required

Property identifier

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

Property name

string
""
Example
The Siam Residences, Bangkok
inventoryName
required

Inventory name

string
""
Example
Deluxe Suite
inventoryType
required

Type of inventory (e.g., room, ancillary)

string
""
Example
room
inventoryIdentifier
required

Inventory identifier

string format: uuid
""
Example
8b1d6e0f-3a7c-4d2b-9e5a-1c8f0b4d6e29
userSession
required

User session information containing itinerary and other user related data.

object
itinerary
required

Dates and travel info.

object
startDate
required

Check-in date (must be today or in the future)

string format: date
""
Example
2026-07-15
endDate

Check-out date (alternative to nights; nights takes precedence if both provided)

string format: date
""
Example
2026-07-18
nights

Number of nights for the stay (alternative to endDate; takes precedence if both provided)

integer format: int32
0
Example
3
items
required

Room configurations for each room in the reservation

Array<object>
>= 1 items <= 2147483647 items

Room occupancy and guest composition for a single or multiple identical rooms

object
adults
required

Number of adult guests in this room type

integer format: int32
default: 1 >= 1
Example
2
children

Child guests in this room, with age groups

Array<object>

Child guest with age and quantity in a room configuration

object
quantity
required

Count of children of this age group in the room

integer format: int32
"" >= 1
Example
2
age
required

Age of each child in this group (years)

integer format: int32
""
Example
7
quantity

Number of identical rooms with this configuration

integer format: int32
default: 1 >= 1
Example
1
hours

Duration in hours (rounded up) between check-in and check-out. Used for hourly bookings; e.g., meeting rooms or day-use venues.

integer format: int64
""
Example
72
children

Total number of children across all rooms

integer format: int32
""
Example
1
rooms

Total number of rooms in this itinerary

integer format: int32
""
Example
2
guests

Total number of adult guests across all rooms

integer format: int32
""
Example
4
language

User’s language preference (ISO 639-1 code)

string
""
Example
en
currency

User’s currency preference (ISO 4217 code)

string
""
Example
USD
promotionalCodes
Array<string>
selectedRoomConfigurationIndex

Index of the currently selected room configuration for rate retrieval

integer format: int32
0
Example
0
lifestyle

Preferred lifestyle category to filter accommodations

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

Unavailability notification sent successfully

Media type application/json
object
propertyIdentifier
required

Property identifier

string format: uuid
""
propertyName
required

Property name

string
""
inventoryName
required

Inventory name

string
""
inventoryType
required

Type of inventory (e.g., room, ancillary)

string
""
inventoryIdentifier
required

Inventory identifier

string format: uuid
""
userSession
required

User session information containing itinerary and other user related data.

object
itinerary
required

Dates and travel info.

object
startDate
required

Check-in date (must be today or in the future)

string format: date
""
endDate

Check-out date (alternative to nights; nights takes precedence if both provided)

string format: date
""
nights

Number of nights for the stay (alternative to endDate; takes precedence if both provided)

integer format: int32
0
items
required

Room configurations for each room in the reservation

Array<object>
>= 1 items <= 2147483647 items

Room occupancy and guest composition for a single or multiple identical rooms

object
adults
required

Number of adult guests in this room type

integer format: int32
default: 1 >= 1
children

Child guests in this room, with age groups

Array<object>

Child guest with age and quantity in a room configuration

object
quantity
required

Count of children of this age group in the room

integer format: int32
"" >= 1
age
required

Age of each child in this group (years)

integer format: int32
""
quantity

Number of identical rooms with this configuration

integer format: int32
default: 1 >= 1
hours

Duration in hours (rounded up) between check-in and check-out. Used for hourly bookings; e.g., meeting rooms or day-use venues.

integer format: int64
""
children

Total number of children across all rooms

integer format: int32
""
rooms

Total number of rooms in this itinerary

integer format: int32
""
guests

Total number of adult guests across all rooms

integer format: int32
""
language

User’s language preference (ISO 639-1 code)

string
""
currency

User’s currency preference (ISO 4217 code)

string
""
promotionalCodes
Array<string>
selectedRoomConfigurationIndex

Index of the currently selected room configuration for rate retrieval

integer format: int32
0
lifestyle

Preferred lifestyle category to filter accommodations

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
{
"propertyIdentifier": "",
"propertyName": "",
"inventoryName": "",
"inventoryType": "",
"inventoryIdentifier": "",
"userSession": null
}

Invalid request body

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

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

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

Internal Server Error

object
Example generated
{}