Get daily rates grid

POST

/api/managing-entity/{managingEntityIdentifier}/extranet/master-rate/{masterRateIdentifier}/rate/grid

const url = 'https://api.wink.travel/api/managing-entity/d5b8a3c2-9e6f-4a1b-8d34-7c2e1f0a5b69/extranet/master-rate/5e8a3b7c-0d4f-4a2b-8c1d-9e6f2a0b4c73/rate/grid';
const options = {
  method: 'POST',
  headers: {
    'Wink-Version': '2.0',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: '{"skip":0,"take":30,"sort":"","filter":"","group":""}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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 '{ "skip": 0, "take": 30, "sort": "", "filter": "", "group": "" }'

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

Authorizations

oauth2ClientCredentials

Parameters

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

Wink-Version

string

default: 2.0.0

Allowed values: 2.0

Request Body^required

application/json

object

skip

Number of records to be skipped by the pager.

integer format: int32

Example

take

Number of records to take.

integer format: int32

default: 30 >= 1 <= 180

Example

sort

Descriptors used for sorting result set.

Array<object>

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

filter

Descriptors used for filtering result set

object

logic

Whether to filter inclusively or exclusively

string

Allowed values: and or

Example

and

filters

Descriptors used for filtering the result set

Array<object>

object

field

required

Field name to filter on

string

"" >= 1 characters

Example

hotel.name

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

ignoreCase

Make filter comparison case insensitive. Default: Case sensitive

boolean

Example

true

group

Descriptors to group result sets by.

Array<object>

object

field

Field to group data set on

string

Example

createdDate

dir

Group sort direction

string

Allowed values: asc desc

Example

asc

aggregates

Primitive aggregate data points

Array<object>

object

field

Field to run aggregate function on

string

Example

hotel.bookings

aggregate

Aggregate function

string

Allowed values: count sum average min max

Example

count

Responses

200

Successfully retrieved paginated daily rates

application/json

object

totalPages

integer format: int32

totalElements

integer format: int64

size

integer format: int32

content

Array<object>

Holds all the information for one rate date

object

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

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

number

integer format: int32

first

boolean

last

boolean

numberOfElements

integer format: int32

sort

object

empty

boolean

unsorted

boolean

sorted

boolean

pageable

object

offset

integer format: int64

pageNumber

integer format: int32

sort

object

empty

boolean

unsorted

boolean

sorted

boolean

pageSize

integer format: int32

paged

boolean

unpaged

boolean

empty

boolean

Example

{
  "content": [
    null
  ]
}

400

Invalid request parameters (malformed filter, invalid page size)

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

Authentication required

*/*

object

type

string format: uri

title

string

status

integer format: int32

detail

string

instance

string format: uri

properties

object

key

additional properties

403

Insufficient permissions to access this property

*/*

object

type

string format: uri

title

string

status

integer format: int32

detail

string

instance

string format: uri

properties

object

key

additional properties

404

Property or master rate not found

application/json

object

totalPages

integer format: int32

totalElements

integer format: int64

size

integer format: int32

content

Array<object>

Holds all the information for one rate date

object

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

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

number

integer format: int32

first

boolean

last

boolean

numberOfElements

integer format: int32

sort

object

empty

boolean

unsorted

boolean

sorted

boolean

pageable

object

offset

integer format: int64

pageNumber

integer format: int32

sort

object

empty

boolean

unsorted

boolean

sorted

boolean

pageSize

integer format: int32

paged

boolean

unpaged

boolean

empty

boolean

Example

{
  "content": [
    null
  ]
}

500

Internal Server Error

object

Example ^generated

{}

Get daily rates grid

Authorizations

Parameters

Path Parameters

Example

Example

Header Parameters

Request Body required

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Example

Responses

200

Example

400

Example generated

401

403

404

Example

500

Example generated

Request Body^required

Example ^generated

Example ^generated