No Inventory
const url = 'https://api.wink.travel/api/inventory/unavailable';const options = { method: 'POST', headers: {'Wink-Version': '2.0', 'Content-Type': 'application/json'}, body: '{"propertyIdentifier":"example","propertyName":"example","inventoryName":"example","inventoryType":"example","inventoryIdentifier":"example","userSession":null}'};
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/inventory/unavailable \ --header 'Content-Type: application/json' \ --header 'Wink-Version: 2.0' \ --data '{ "propertyIdentifier": "example", "propertyName": "example", "inventoryName": "example", "inventoryType": "example", "inventoryIdentifier": "example", "userSession": null }'Notify property that there is a demand but no supply for the specified inventory.
Parameters
Section titled “ Parameters ”Header Parameters
Section titled “Header Parameters ”Request Body required
Section titled “Request Body required ”object
User session information containing itinerary and other user related data.
object
Dates and travel info.
object
Start date of itinerary
Example
2024-01-01Optional end date. If endDate is empty, nights needs to be present. If both are present, nights will take precedence.
Example
2024-01-02Optional number of nights. If nights is empty, endDate needs to be present. If both are present, nights will take precedence.
Room configurations
Room Configuration
object
Number of adults
Example
2Children configurations
BookingItineraryRoomConfigurationChild configuration
object
Number of children
Age of children
Number of identical rooms of this configuration being booked
Example
1Number of hours between start and end dates. Used for itineraries that require bookings that occur within hours and not days. E.g. Meeting room reservation.
How many total children for this stay
How many total rooms for this stay
How many total guests for this stay
User’s language preference
Example
enUser’s currency preference
Example
USDUser can pass the current room configuration index to retrieve rates specifically for that room configuration.
The preferred user lifestyle.
Responses
Section titled “ Responses ”Created
object
User session information containing itinerary and other user related data.
object
Dates and travel info.
object
Start date of itinerary
Optional end date. If endDate is empty, nights needs to be present. If both are present, nights will take precedence.
Optional number of nights. If nights is empty, endDate needs to be present. If both are present, nights will take precedence.
Room configurations
Room Configuration
object
Number of adults
Children configurations
BookingItineraryRoomConfigurationChild configuration
object
Number of children
Age of children
Number of identical rooms of this configuration being booked
Number of hours between start and end dates. Used for itineraries that require bookings that occur within hours and not days. E.g. Meeting room reservation.
How many total children for this stay
How many total rooms for this stay
How many total guests for this stay
User’s language preference
User’s currency preference
User can pass the current room configuration index to retrieve rates specifically for that room configuration.
The preferred user lifestyle.
Example
{ "userSession": null}Bad Request
object
object
Example generated
{ "type": "https://example.com", "title": "example", "status": 1, "detail": "example", "instance": "https://example.com", "properties": { "additionalProperty": "example" }}object
object
object
object
object
object
object
object
Unauthorized
object
object
Forbidden
object
object
Internal Server Error
object
Example generated
{}