Show Daily Rates

GET

/api/channel-manager/property/{propertyIdentifier}/master-rate/{masterRateIdentifier}

const url = 'https://integrations.wink.travel/api/channel-manager/property/property-1/master-rate/master-rate-1?startDate=2018-01-01&endDate=2018-01-02';
const options = {method: 'GET', headers: {'Wink-Version': '2.0'}};

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

curl --request GET \
  --url 'https://integrations.wink.travel/api/channel-manager/property/property-1/master-rate/master-rate-1?startDate=2018-01-01&endDate=2018-01-02' \
  --header 'Wink-Version: 2.0'

Retrieves all daily rates for for property / master rate combo and a date range.

Parameters

Path Parameters

propertyIdentifier

required

string

default: ##default

Retrieve record owned by this propertyIdentifier

Example

property-1

masterRateIdentifier

required

string

default: ##default

Retrieve record owned by this masterRateIdentifier

Example

master-rate-1

Query Parameters

startDate

required

string

default: ##default

Limit results on date range starting with

Example

2018-01-01

endDate

required

string

default: ##default

Limit results on date range ending with

Example

2018-01-02

Header Parameters

Wink-Version

string

default: 2.0.0

Allowed values: 2.0

Responses

200

application/json

object

room

required

object

identifier

required

string

>= 1 characters

propertyIdentifier

required

string

>= 1 characters

name

required

string

>= 1 characters

roomTypeIdentifier

required

string

>= 1 characters

ratePlanIdentifier

required

string

>= 1 characters

guestRoomName

required

string

>= 1 characters

ratePlanName

required

string

>= 1 characters

minOccupancy

required

integer format: int32

maxOccupancy

required

integer format: int32

maxAdultOccupancy

required

integer format: int32

maxChildOccupancy

required

integer format: int32

includedAdultOccupancy

required

integer format: int32

includedChildOccupancy

required

integer format: int32

baseRate

required

object

amount

required

number

currency

required

string

>= 1 characters

singleOccupancyRateModifier

required

object

type

required

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

string

default: ##default

Allowed values: FIXED PERCENTAGE

percent

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

number format: float

default: ##default

fixedAmount

A localized amount

object

amount

required

number

currency

required

string

>= 1 characters

extraPaxRateModifier

required

object

type

required

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

string

default: ##default

Allowed values: FIXED PERCENTAGE

percent

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

number format: float

default: ##default

fixedAmount

A localized amount

object

amount

required

number

currency

required

string

>= 1 characters

extraChildRateModifier

required

object

type

required

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

string

default: ##default

Allowed values: FIXED PERCENTAGE

percent

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

number format: float

default: ##default

fixedAmount

A localized amount

object

amount

required

number

currency

required

string

>= 1 characters

rates

Array<object>

object

identifier

string

propertyIdentifier

required

string

>= 1 characters

roomRateIdentifier

required

string

>= 1 characters

guestRoomIdentifier

required

string

>= 1 characters

ratePlanIdentifier

required

string

>= 1 characters

amount

required

number

currencyCode

required

string

>= 1 characters

master

required

boolean

closedOnArrival

required

boolean

closedOnDeparture

required

boolean

date

required

string format: date

quantity

integer format: int32

minOccupancy

integer format: int32

maxOccupancy

integer format: int32

minLengthOfStay

integer format: int32

maxLengthOfStay

integer format: int32

singleOccupancyRateModifier

object

type

required

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

string

default: ##default

Allowed values: FIXED PERCENTAGE

percent

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

number format: float

default: ##default

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

default: ##default

Allowed values: FIXED PERCENTAGE

percent

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

number format: float

default: ##default

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

default: ##default

Allowed values: FIXED PERCENTAGE

percent

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

number format: float

default: ##default

fixedAmount

A localized amount

object

amount

required

number

currency

required

string

>= 1 characters

startDate

string format: date

endDate

string format: date

Example

{
  "room": {
    "singleOccupancyRateModifier": {
      "type": "FIXED",
      "percent": "##default",
      "fixedAmount": "##default"
    },
    "extraPaxRateModifier": {
      "type": "FIXED",
      "percent": "##default",
      "fixedAmount": "##default"
    },
    "extraChildRateModifier": {
      "type": "FIXED",
      "percent": "##default",
      "fixedAmount": "##default"
    }
  },
  "rates": [
    {
      "singleOccupancyRateModifier": {
        "type": "FIXED",
        "percent": "##default",
        "fixedAmount": "##default"
      },
      "extraPaxRateModifier": {
        "type": "FIXED",
        "percent": "##default",
        "fixedAmount": "##default"
      },
      "extraChildRateModifier": {
        "type": "FIXED",
        "percent": "##default",
        "fixedAmount": "##default"
      }
    }
  ]
}

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 Rates

Parameters

Path Parameters

Example

Example

Query Parameters

Example

Example

Header Parameters

Responses

200

Example

400

Example generated

401

403

500

Example generated

Example ^generated

Example ^generated