Skip to content
Wink

Rate calendar

Deprecated
POST
/api/public/{managingEntityIdentifier}/inventory/period
curl --request POST \
  --url 'https://api.wink.travel/api/public/d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69/inventory/period?customizationIdentifier=2c5b9e3a-7f1d-4a8c-b6e2-0d4f1a9b3c72' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Wink-Version: 2.0' \
  --data '{ "adults": 2, "currency": "USD", "language": "en", "periodInDays": 5 }'

Return the best available rate for every check-in/check-out date-range combination for a property.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
managingEntityIdentifier
required
string
""

Managing entity identifier

Example
d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69

Query Parameters

Section titled “Query Parameters”
customizationIdentifier
string
""

Booking engine customization identifier; when omitted the managing entity’s default configuration is used

Example
2c5b9e3a-7f1d-4a8c-b6e2-0d4f1a9b3c72

Header Parameters

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

Request Bodyrequired

Section titled “Request Bodyrequired”

Rate calendar request containing the hotel identifier and the date range to calculate best available rates for each night

Media typeapplication/json
object
adults

The period to query within.

integer format: int32
default: 2 >= 1 <= 10
currency

The currency to display prices in.

string
default: USD >= 3 characters <= 3 characters
hotelIdentifier
required

The property to query for.

string
"" >= 1 characters
language
required

The language to display room type name.

string
default: en >= 1 characters
periodInDays

The period to query within.

integer format: int32
default: 5 >= 2 <= 30
startDate
required

Start of period.

string format: date
""
Example
{
  "adults": 2,
  "currency": "USD",
  "language": "en",
  "periodInDays": 5
}

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json

Aggregate response containing best available rates for a property across a date range period.

object
adults
required

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

integer format: int32
""
hotelIdentifier
required

The property to query for.

string
"" >= 1 characters
internetIncluded

Utilify flag to verify whether this property has internet

boolean
list
required
Array<object>

List of rates for requested period.

object
available
required

Utilify flag to verify whether this rate is available

boolean
breakfastIncluded
required

Utilify flag to verify whether this rate is includes breakfast

boolean
endDate
required

SimpleDateTimeItinerary endDate

string format: date
""
price
object
sourceTotal

Source total amount with any extra charges included

object
amount
required

Monetary amount value

number
""
currency
required

ISO 4217 currency code

string
"" >= 1 characters /^[A-Z]{3}$/
userSpecifiedCurrencyTotal

Total amount with any extra charges included

object
amount
required

Monetary amount value

number
""
currency
required

ISO 4217 currency code

string
"" >= 1 characters /^[A-Z]{3}$/
refundable
required

Utilify flag to verify whether this rate is refundable

boolean
refundableUntilDays
required

Number of days from now until this rate stops being refundable; -1 when not refundable at all

integer format: int32
""
room
required

The room type.

object
identifier
required

Unique record identifier

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

Maximum number of guest allowed in a room type.

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

Internal name of inventory.

string
"" >= 1 characters
roomNights
required

Number of nights the guests will be staying

integer format: int32
""
startDate
required

SimpleDateTimeItinerary startDate

string format: date
""
name
required

The property name.

string
"" >= 1 characters
parkingIncluded

Utilify flag to verify whether this property has parking

boolean
Example
{
  "adults": 2,
  "children": 0,
  "hotelIdentifier": "the-siam-residences",
  "internetIncluded": true,
  "list": [
    {
      "adults": 2,
      "available": true,
      "breakfastIncluded": false,
      "children": 0,
      "endDate": "2026-01-17",
      "price": {
        "sourceTotal": {
          "amount": 15750,
          "currency": "THB"
        },
        "userSpecifiedCurrencyTotal": {
          "amount": 450,
          "currency": "USD"
        }
      },
      "refundable": true,
      "room": {
        "identifier": "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51",
        "maxOccupancy": 2,
        "name": "Deluxe Garden View Room"
      },
      "roomNights": 3,
      "startDate": "2026-01-14"
    }
  ],
  "name": "The Siam Residences",
  "parkingIncluded": false
}

400

Section titled “400”

Bad Request — missing or invalid request parameter or body

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri
key
additional properties
""
Example

401

Section titled “401”

Unauthorized — authentication is required or the session has expired

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri
key
additional properties
""
Example

403

Section titled “403”

Forbidden — authenticated but lacking the required permission or scope

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri
key
additional properties
""
Example

404

Section titled “404”

Not Found — the requested resource does not exist

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri
key
additional properties
""
Example

405

Section titled “405”

Method Not Allowed — the HTTP verb is not supported on this endpoint

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri
key
additional properties
""
Example

409

Section titled “409”

Conflict — the resource was modified by someone else since you read it; re-read it and retry with the new version

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri
key
additional properties
""
Example

415

Section titled “415”

Unsupported Media Type — use application/json

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri
key
additional properties
""
Example

500

Section titled “500”

Internal Server Error — an unexpected failure occurred on the server

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri
key
additional properties
""
Example

503

Section titled “503”

Service Unavailable — a downstream dependency is unreachable

Media typeapplication/problem+json
object
detail
string
instance
string format: uri
properties
object
key
additional properties
status
integer format: int32
title
string
type
string format: uri
key
additional properties
""
Example