Show Daily Rate Page

POST

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

const url = 'https://api.wink.travel/api/managing-entity/hotel-1/extranet/master-rate/master-rate-1/rate/grid';
const options = {
  method: 'POST',
  headers: {'Wink-Version': '2.0', '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/hotel-1/extranet/master-rate/master-rate-1/rate/grid \
  --header 'Content-Type: application/json' \
  --header 'Wink-Version: 2.0' \
  --data '{ "skip": 0, "take": 30, "sort": "", "filter": "", "group": "" }'

Retrieve daily rates for a master rate within a certain date range.

Parameters

Path Parameters

managingEntityIdentifier

required

string

Show daily rate page owned by this property identifier.

Example

hotel-1

masterRateIdentifier

required

string

Show daily rate page owned by this master rate.

Example

master-rate-1

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

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

Document UUID

string

hotelIdentifier

required

Owner of daily rate.

string format: uuid

"" >= 1 characters

rateSource

required

Indicate where this rate originated from. Leave as TRAVELIKO unless you are a channel manager and responsible for the property’s rates externally of this platform.

string

default: TRAVELIKO >= 1 characters

ratePlanIdentifier

required

Rate plan associated with this daily rate.

string format: uuid

"" >= 1 characters

guestRoomIdentifier

required

Guest room associated with this daily rate.

string format: uuid

"" >= 1 characters

rate

required

Guest room associated with this daily rate.

number

currencyCode

required

The currencyCode property operates in.

string

"" >= 1 characters

master

required

This flag indicates whether this rate is available for this date.

boolean

default: true

closedOnArrival

required

This flag indicates whether a guest can arrive at the property on this date.

boolean

closedOnDeparture

required

This flag indicates whether a guest can leave the property on this date.

boolean

day

Day of month

integer format: int32

month

Month

integer format: int32

year

Year

integer format: int32

quantity

Amount of rooms available for this date.

integer format: int32

minLengthOfStay

Control the minimum length of stay at the day-level. This means that a guest arriving within this date range is required to stay at least these number of days in order to get this rate. Leave empty if you don’t want to update this property.

integer format: int32

default: -1

maxLengthOfStay

Control the maximum length of stay at the day-level. This means that a guest arriving within this date range is required to stay no longer than these number of days in order to get this rate. Leave empty if you don’t want to update this property.

integer format: int32

default: -1

singleOccupancyRateModifier

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

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

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

When this rate can be safely removed.

string format: date-time

available

boolean

number

integer format: int32

numberOfElements

integer format: int32

sort

object

empty

boolean

unsorted

boolean

sorted

boolean

first

boolean

last

boolean

pageable

object

offset

integer format: int64

sort

object

empty

boolean

unsorted

boolean

sorted

boolean

pageSize

integer format: int32

paged

boolean

pageNumber

integer format: int32

unpaged

boolean

empty

boolean

Example

{
  "content": [
    null
  ]
}

400

Bad Request

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

Unauthorized

*/*

object

type

string format: uri

title

string

status

integer format: int32

detail

string

instance

string format: uri

properties

object

key

additional properties

403

Forbidden

*/*

object

type

string format: uri

title

string

status

integer format: int32

detail

string

instance

string format: uri

properties

object

key

additional properties

500

Internal Server Error

object

Example ^generated

{}

Show Daily Rate Page

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

500

Example generated

Request Body^required

Example ^generated

Example ^generated