Skip to content
Wink

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 '{ "endDate": "2020-12-31", "startDate": "2020-12-24" }'

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

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
managingEntityIdentifier
required
string

Property identifier (managing entity UUID) to fetch rates for

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

Header Parameters

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

Request Bodyrequired

Section titled “Request Bodyrequired”

Start and end dates defining the inclusive date range for which all property rates should be retrieved

Media typeapplication/json
object
endDate
required

Retrieve data range ending with and including this end date

string format: date
Example
2020-12-31
startDate
required

Retrieve data range starting with and including this start date

string format: date
Example
2020-12-24
Example
{
  "endDate": "2020-12-31",
  "startDate": "2020-12-24"
}

Responses

Section titled “Responses”

200

Section titled “200”

All daily rates across every master rate at the property for the requested date range

Media typeapplication/json
Array<object>

Lightweight projection of a single rate date, used by consumers outside the rate module.

object
available
boolean
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
currencyCode
required

ISO 4217 currency code for this rate

string
/^[A-Z]{3}$/
day

Day of the month (1-31)

integer format: int32
extraChildRateModifier

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

object
fixedAmount

A localized amount, always non-negative. Direction (surcharge vs. discount) is determined by which field this charge is assigned to, not the sign of this value.

object
amount
required

Monetary amount value

number
currency
required

ISO 4217 currency code

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

A fraction between 0 and 1 (inclusive) representing a percentage of the total stay amount for an early check-in or late check-out, e.g. 0.25 for 25%. Direction (surcharge vs. discount) is determined by which field this charge is assigned to, not the sign of this value.

number format: float
<= 1
type
required

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

string
Allowed values: FIXED PERCENTAGE
extraPaxRateModifier

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

object
fixedAmount

A localized amount, always non-negative. Direction (surcharge vs. discount) is determined by which field this charge is assigned to, not the sign of this value.

object
amount
required

Monetary amount value

number
currency
required

ISO 4217 currency code

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

A fraction between 0 and 1 (inclusive) representing a percentage of the total stay amount for an early check-in or late check-out, e.g. 0.25 for 25%. Direction (surcharge vs. discount) is determined by which field this charge is assigned to, not the sign of this value.

number format: float
<= 1
type
required

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

string
Allowed values: FIXED PERCENTAGE
guestRoomIdentifier
required

Guest room (room type) identifier for this rate

string format: uuid
>= 1 characters
hotelIdentifier
required

Property identifier that owns this daily rate

string format: uuid
>= 1 characters
id

Unique document identifier (UUID)

string format: uuid
master
required

Whether this rate is available for booking on this date

boolean
default: true
maxLengthOfStay

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

integer format: int32
default: -1
minLengthOfStay

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

integer format: int32
default: -1
month

Month of the year (1-12)

integer format: int32
quantity

Number of available rooms for this date

integer format: int32
0
rate
required

Nightly rate amount in the specified currency

number
ratePlanIdentifier
required

Rate plan identifier for pricing controls and restrictions

string format: uuid
>= 1 characters
rateSource
required

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

string
default: NONE >= 1 characters
singleOccupancyRateModifier

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

object
fixedAmount

A localized amount, always non-negative. Direction (surcharge vs. discount) is determined by which field this charge is assigned to, not the sign of this value.

object
amount
required

Monetary amount value

number
currency
required

ISO 4217 currency code

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

A fraction between 0 and 1 (inclusive) representing a percentage of the total stay amount for an early check-in or late check-out, e.g. 0.25 for 25%. Direction (surcharge vs. discount) is determined by which field this charge is assigned to, not the sign of this value.

number format: float
<= 1
type
required

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

string
Allowed values: FIXED PERCENTAGE
year

Year in ISO format

integer format: int32
Example
[
  {
    "closedOnArrival": false,
    "closedOnDeparture": false,
    "currencyCode": "THB",
    "day": 14,
    "extraChildRateModifier": {
      "percent": 0.15,
      "type": "PERCENTAGE"
    },
    "extraPaxRateModifier": {
      "percent": 0.25,
      "type": "PERCENTAGE"
    },
    "guestRoomIdentifier": "4b7e2c9a-6f1d-4a0b-8c3e-5d2f9b1a7c84",
    "hotelIdentifier": "7d4f2a1b-3e8c-4b0d-a5f9-1c2e6b4d8f07",
    "id": "3c6b1a5d-8e2f-4a0b-9c7d-6e4f0a8b2c51",
    "master": true,
    "maxLengthOfStay": 30,
    "minLengthOfStay": 2,
    "month": 1,
    "quantity": 9,
    "rate": 4500,
    "ratePlanIdentifier": "9a2d5e8c-1f4b-4c7a-b3e6-2d0f8a5c3e91",
    "rateSource": "NONE",
    "singleOccupancyRateModifier": {
      "percent": 0.8,
      "type": "PERCENTAGE"
    },
    "year": 2026
  }
]

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
Examplegenerated
{
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  },
  "status": 1,
  "title": "example",
  "type": "https://example.com"
}

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
Examplegenerated
{
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  },
  "status": 1,
  "title": "example",
  "type": "https://example.com"
}

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
Examplegenerated
{
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  },
  "status": 1,
  "title": "example",
  "type": "https://example.com"
}

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
Examplegenerated
{
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  },
  "status": 1,
  "title": "example",
  "type": "https://example.com"
}

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
Examplegenerated
{
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  },
  "status": 1,
  "title": "example",
  "type": "https://example.com"
}

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
Examplegenerated
{
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  },
  "status": 1,
  "title": "example",
  "type": "https://example.com"
}

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
Examplegenerated
{
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  },
  "status": 1,
  "title": "example",
  "type": "https://example.com"
}

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
Examplegenerated
{
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  },
  "status": 1,
  "title": "example",
  "type": "https://example.com"
}

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
Examplegenerated
{
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  },
  "status": 1,
  "title": "example",
  "type": "https://example.com"
}