Skip to content
Wink

Get daily rates grid

POST
/api/managing-entity/{managingEntityIdentifier}/extranet/master-rate/{masterRateIdentifier}/rate/grid
curl --request POST \
  --url https://api.wink.travel/api/managing-entity/d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69/extranet/master-rate/5e8a3b7c-0d4f-4a2b-8c1d-9e6f2a0b4c73/rate/grid \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Wink-Version: 2.0' \
  --data null

Retrieve a paginated grid of daily rates for a single master rate. Supports filtering and pagination via the State request body.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
managingEntityIdentifier
required
string
""

Property identifier (managing entity UUID) owning these rates

Example
d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69
masterRateIdentifier
required
string
""

Master rate identifier for the room type and rate plan

Example
5e8a3b7c-0d4f-4a2b-8c1d-9e6f2a0b4c73

Header Parameters

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

Request Bodyrequired

Section titled “Request Bodyrequired”

Pagination and filter state controlling which daily rate records are returned in the grid view

Media typeapplication/json

Pagination, sorting, filtering, and grouping state used to query a paged result set.

object
filter

Descriptors used for filtering result set

object
filters

Descriptors used for filtering the result set

Array<object>

A single field-level filter criterion that specifies what to match and how to compare it.

object
field
required

Field name to filter on

string
"" >= 1 characters
Example
hotel.name
ignoreCase

Make filter comparison case insensitive. Default: Case sensitive

boolean
Example
true
operator
required

Filter operator to use on field

string
""
Allowed values: neq eq contains doesnotcontain isnull isnotnull isempty isnotempty startswith endswith gte lte gt lt in nin
Example
startsWith
value

Value to filter dataset against

""
Example
Happy Res
Example
{
  "field": "hotel.name",
  "ignoreCase": true,
  "operator": "startsWith",
  "value": "Happy Res"
}
logic

Whether to filter inclusively or exclusively

string
""
Allowed values: and or
Example
and
Example
{
  "filters": [
    {
      "field": "hotel.name",
      "ignoreCase": true,
      "operator": "startsWith",
      "value": "Happy Res"
    }
  ],
  "logic": "and"
}
group

Descriptors to group result sets by.

Array<object>
""

Descriptor that defines how a result set should be grouped, including sort direction and optional aggregate calculations.

object
aggregates

Primitive aggregate data points

Array<object>

Descriptor that defines an aggregate function to apply to a specific field in a grouped result set.

object
aggregate

Aggregate function

string
""
Allowed values: count sum average min max
Example
count
field

Field to run aggregate function on

string
""
Example
hotel.bookings
Example
{
  "aggregate": "count",
  "field": "hotel.bookings"
}
dir

Group sort direction

string
""
Allowed values: asc desc
Example
asc
field

Field to group data set on

string
""
Example
createdDate
Example
{
  "aggregates": [
    {
      "aggregate": "count",
      "field": "hotel.bookings"
    }
  ],
  "dir": "asc",
  "field": "createdDate"
}
skip

Number of records to be skipped by the pager.

integer format: int32
0
Example
0
sort

Descriptors used for sorting result set.

Array<object>
""

Descriptor that defines the sort direction and field for ordering a result set.

object
dir

Descriptors used for sorting result set

string
""
Allowed values: asc desc
Example
asc
field

Data set field to sort on

string
""
Example
hotel.name
Example
{
  "dir": "asc",
  "field": "hotel.name"
}
take

Number of records to take.

integer format: int32
default: 30 >= 1 <= 180
Example
10
Example
{
  "filter": {
    "filters": [
      {
        "field": "hotel.name",
        "ignoreCase": true,
        "operator": "startsWith",
        "value": "Happy Res"
      }
    ],
    "logic": "and"
  },
  "group": [
    {
      "aggregates": [
        {
          "aggregate": "count",
          "field": "hotel.bookings"
        }
      ],
      "dir": "asc",
      "field": "createdDate"
    }
  ],
  "skip": 0,
  "sort": [
    {
      "dir": "asc",
      "field": "hotel.name"
    }
  ],
  "take": 10
}

Responses

Section titled “Responses”

200

Section titled “200”

Paginated grid of daily rates for the specified master rate

Media typeapplication/json

Owned pagination envelope: a page of content plus flat page metadata.

object
content

The elements on this page.

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

Whether this is the first page.

boolean
last

Whether this is the last page.

boolean
number

Zero-based index of this page.

integer format: int32
""
numberOfElements

Number of elements on this page.

integer format: int32
""
size

The requested page size.

integer format: int32
""
totalElements

Total number of elements across all pages.

integer format: int64
""
totalPages

Total number of pages for the current page size.

integer format: int32
""
Example
{
  "content": [
    {
      "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
    }
  ],
  "first": true,
  "last": false,
  "number": 0,
  "numberOfElements": 20,
  "size": 20,
  "totalElements": 1234,
  "totalPages": 62
}

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