Skip to content
Wink

Show Property Rate Period

POST
/api/public/{managingEntityIdentifier}/inventory/period
 
curl --request POST \
  --url 'https://api.wink.travel/api/public//inventory/period?customizationIdentifier=' \
  --header 'Content-Type: application/json' \
  --header 'Wink-Version: 2.0' \
  --data '{ "hotelIdentifier": "", "startDate": "", "periodInDays": 5, "adults": 2, "language": "en", "currency": "USD", "ratePlanNameMatchesRegEx": "" }'

Returns all possible date range combinations of best rates for a property.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
managingEntityIdentifier
required
string
""

Managing entity identifier

Query Parameters

Section titled “Query Parameters ”
customizationIdentifier
string
""

Customization identifier

Header Parameters

Section titled “Header Parameters ”
Wink-Version
string
default: 2.0.0
Allowed values: 2.0

Request Body required

Section titled “Request Body required ”
Media type application/json
object
hotelIdentifier
required

The property to query for.

string
"" >= 1 characters
startDate
required

Start of period.

string format: date
""
periodInDays

The period to query within.

integer format: int32
default: 5 >= 2 <= 30
adults

The period to query within.

integer format: int32
default: 2 >= 1 <= 10
language
required

The language to display room type name.

string
default: en >= 1 characters
currency

The currency to display prices in.

string
default: USD >= 3 characters <= 3 characters
ratePlanNameMatchesRegEx

A regular expression to apply to the rate plan name

string
""

Responses

Section titled “ Responses ”

200

Section titled “200 ”

OK

Media type application/json
object
hotelIdentifier
required

The property to query for.

string
"" >= 1 characters
name
required

The property name.

string
"" >= 1 characters
adults
required

The actual amount of adults as determined by the hotel’s policy

integer format: int32
""
list
required
Array<object>

List of rates for requested period.

object
room
required

The room type.

object
identifier
required

Unique record identifier

string format: uuid
"" >= 1 characters
name
required

Internal name of inventory.

string
"" >= 1 characters
maxOccupancy
required

Maximum number of guest allowed in a room type.

integer format: int32
default: 2 >= 1
startDate
required

SimpleDateTimeItinerary startDate

string format: date
""
endDate
required

SimpleDateTimeItinerary endDate

string format: date
""
roomNights
required

Number of nights the guests will be staying

integer format: int32
""
available
required

Utilify flag to verify whether this rate is available or not

boolean
price
object
userSpecifiedCurrencyTotal

Total amount with any extra charges included

object
amount
required
number
currency
required
string
>= 1 characters
sourceTotal

Source total amount with any extra charges included

object
amount
required
number
currency
required
string
>= 1 characters
Example 
{
  "hotelIdentifier": "",
  "name": "",
  "adults": "",
  "list": [
    ""
  ]
}

400

Section titled “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

Section titled “401 ”

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

403

Section titled “403 ”

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

500

Section titled “500 ”

Internal Server Error

object
Example generated
{}