Skip to content

Get all property rates by date range

POST
/api/managing-entity/{managingEntityIdentifier}/extranet/master-rate/rates/dates
curl --request POST \
--url https://api.wink.travel/api/managing-entity/d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69/extranet/master-rate/rates/dates \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Wink-Version: 2.0' \
--data '{ "startDate": "", "endDate": "" }'

Retrieve all daily rates across every master rate at a property for a specified date range.

managingEntityIdentifier
required
string
""

Property identifier (managing entity UUID) to fetch rates for

Example
d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69
Wink-Version
string
default: 2.0.0
Allowed values: 2.0
Media type application/json
object
startDate
required

Retrieve data range starting with and including this start date

string format: date
""
Example
2020-12-24
endDate
required

Retrieve data range ending with and including this end date

string format: date
""
Example
2020-12-31

Successfully retrieved all property rates for the date range

Media type application/json
Array<object>

Holds all the information for one rate date

object
id

Unique document identifier (UUID)

string format: uuid
""
hotelIdentifier
required

Property identifier that owns this daily rate

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

Source of the rate update. TRAVELIKO indicates property-managed rates; other values indicate channel manager origins.

string
default: TRAVELIKO >= 1 characters
ratePlanIdentifier
required

Rate plan identifier for pricing controls and restrictions

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

Guest room (room type) identifier for this rate

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

Nightly rate amount in the specified currency

number
""
currencyCode
required

ISO 4217 currency code for this rate

string
"" >= 1 characters
master
required

Whether this rate is available for booking on this date

boolean
default: true
closedOnArrival
required

Whether guests cannot check in on this date (Closed on Arrival)

boolean
closedOnDeparture
required

Whether guests cannot check out on this date (Closed on Departure)

boolean
day

Day of the month (1-31)

integer format: int32
""
month

Month of the year (1-12)

integer format: int32
""
year

Year in ISO format

integer format: int32
""
quantity

Number of available rooms for this date

integer format: int32
0
minLengthOfStay

Minimum length of stay (in days) required for guests arriving on this date. -1 means no minimum.

integer format: int32
default: -1
maxLengthOfStay

Maximum length of stay (in days) allowed for guests arriving on this date. -1 means no maximum.

integer format: int32
default: -1
singleOccupancyRateModifier

Rate modifier (fixed amount or percentage) for single occupancy bookings

object
type
required

When the type is FIXED, fixedAmount is required. When the type is PERCENTAGE, percent is required.

string
""
Allowed values: FIXED PERCENTAGE
percent

A percentage of the total stay amount for an early check-in or late check-out

number format: float
""
fixedAmount

A localized amount

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

Rate modifier (fixed amount or percentage) for extra adult guests

object
type
required

When the type is FIXED, fixedAmount is required. When the type is PERCENTAGE, percent is required.

string
""
Allowed values: FIXED PERCENTAGE
percent

A percentage of the total stay amount for an early check-in or late check-out

number format: float
""
fixedAmount

A localized amount

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

Rate modifier (fixed amount or percentage) for extra child guests

object
type
required

When the type is FIXED, fixedAmount is required. When the type is PERCENTAGE, percent is required.

string
""
Allowed values: FIXED PERCENTAGE
percent

A percentage of the total stay amount for an early check-in or late check-out

number format: float
""
fixedAmount

A localized amount

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

Time-to-live (TTL) for this rate record in MongoDB. Records are automatically removed 24 hours after this instant.

string format: date-time
""
available
boolean
Example
[
null
]

Invalid date range (end before start, invalid format)

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

Authentication required

Media type */*
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties

Insufficient permissions to access this property

Media type */*
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties

Property not found

Media type application/json
Array<object>

Holds all the information for one rate date

object
id

Unique document identifier (UUID)

string format: uuid
""
hotelIdentifier
required

Property identifier that owns this daily rate

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

Source of the rate update. TRAVELIKO indicates property-managed rates; other values indicate channel manager origins.

string
default: TRAVELIKO >= 1 characters
ratePlanIdentifier
required

Rate plan identifier for pricing controls and restrictions

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

Guest room (room type) identifier for this rate

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

Nightly rate amount in the specified currency

number
""
currencyCode
required

ISO 4217 currency code for this rate

string
"" >= 1 characters
master
required

Whether this rate is available for booking on this date

boolean
default: true
closedOnArrival
required

Whether guests cannot check in on this date (Closed on Arrival)

boolean
closedOnDeparture
required

Whether guests cannot check out on this date (Closed on Departure)

boolean
day

Day of the month (1-31)

integer format: int32
""
month

Month of the year (1-12)

integer format: int32
""
year

Year in ISO format

integer format: int32
""
quantity

Number of available rooms for this date

integer format: int32
0
minLengthOfStay

Minimum length of stay (in days) required for guests arriving on this date. -1 means no minimum.

integer format: int32
default: -1
maxLengthOfStay

Maximum length of stay (in days) allowed for guests arriving on this date. -1 means no maximum.

integer format: int32
default: -1
singleOccupancyRateModifier

Rate modifier (fixed amount or percentage) for single occupancy bookings

object
type
required

When the type is FIXED, fixedAmount is required. When the type is PERCENTAGE, percent is required.

string
""
Allowed values: FIXED PERCENTAGE
percent

A percentage of the total stay amount for an early check-in or late check-out

number format: float
""
fixedAmount

A localized amount

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

Rate modifier (fixed amount or percentage) for extra adult guests

object
type
required

When the type is FIXED, fixedAmount is required. When the type is PERCENTAGE, percent is required.

string
""
Allowed values: FIXED PERCENTAGE
percent

A percentage of the total stay amount for an early check-in or late check-out

number format: float
""
fixedAmount

A localized amount

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

Rate modifier (fixed amount or percentage) for extra child guests

object
type
required

When the type is FIXED, fixedAmount is required. When the type is PERCENTAGE, percent is required.

string
""
Allowed values: FIXED PERCENTAGE
percent

A percentage of the total stay amount for an early check-in or late check-out

number format: float
""
fixedAmount

A localized amount

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

Time-to-live (TTL) for this rate record in MongoDB. Records are automatically removed 24 hours after this instant.

string format: date-time
""
available
boolean
Example
[
null
]

Internal Server Error

object
Example generated
{}