Toggle Master Rate

PATCH

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

const url = 'https://api.wink.travel/api/managing-entity/hotel-1/extranet/master-rate/master-rate-1/toggle';
const options = {
  method: 'PATCH',
  headers: {'Wink-Version': '2.0', 'Content-Type': 'application/json'},
  body: '{"enabled":false}'
};

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

curl --request PATCH \
  --url https://api.wink.travel/api/managing-entity/hotel-1/extranet/master-rate/master-rate-1/toggle \
  --header 'Content-Type: application/json' \
  --header 'Wink-Version: 2.0' \
  --data '{ "enabled": false }'

Update a master rate by its identifier

Parameters

Path Parameters

managingEntityIdentifier

required

string

Update existing master rate owned by this property identifier.

Example

hotel-1

masterRateIdentifier

required

string

Update existing master rate with this identifier.

Example

master-rate-1

Header Parameters

Wink-Version

string

default: 2.0.0

Allowed values: 2.0

Request Body^required

application/json

object

enabled

required

Whether master rate should be enable or disabled

boolean

Example

true

Responses

200

application/json

object

Document UUID

string

createdDate

Datetime this record was first created

string format: date-time

lastUpdate

Datetime this record was last updated

string format: date-time

version

Version property that shows how many times this document has been persisted. Document will not persist if the version property is less than current version property in the system. Result in an optimistic locking exception.

integer format: int64

hotelIdentifier

required

Hotel identifier.

string format: uuid

name

required

Internal name of master rate. The name is generated by guest room and rate plan names respectively.

string

roomType

required

object

identifier

required

Room type ID

string

"" >= 1 characters

hotelIdentifier

required

Hotel ID

string

"" >= 1 characters

featuredInd

required

Indicates whether this inventory is featured. Use this flag as a way to signify that this inventory is special.

boolean

lifestyleType

Indicate the type of lifestyle this inventory should be associated with.

string

Allowed values: LIFESTYLE_HEALTH_FITNESS LIFESTYLE_RELAX LIFESTYLE_ADULT_ONLY LIFESTYLE_ADVENTURE LIFESTYLE_BUSINESS LIFESTYLE_LGBT LIFESTYLE_SINGLE_PARENT LIFESTYLE_SOLO_FEMALE LIFESTYLE_BEAUTY LIFESTYLE_FOODIE LIFESTYLE_FAMILY LIFESTYLE_ROMANCE LIFESTYLE_COUPLE LIFESTYLE_SOLO LIFESTYLE_BACKPACKER LIFESTYLE_SHOPPING LIFESTYLE_SPORTS LIFESTYLE_MOUNTAIN LIFESTYLE_BEACH LIFESTYLE_CITY LIFESTYLE_COUNTRY LIFESTYLE_CULTURE LIFESTYLE_ECO

location

required

Geo-location point where inventory takes place. Defaults to location of property.

object

number format: double

type

string

coordinates

Array<number>

descriptions

required

Localized descriptions describing inventory.

Array<object>

>= 1 items

object

name

required

Use as title or short text description

string

description

required

Longer text description

string

"" >= 1 characters <= 2147483647 characters

language

required

Indicate which language this description is written in.

string

default: en >= 2 characters <= 2 characters

creator

Whether it was user or system generated.

string

default: USER

Allowed values: SYSTEM USER

md5ContentHash

The md5 hash of the name, description and language.

string

hashMismatch

boolean

multimedias

required

List of images / videos of inventory.

Array<object>

>= 1 items

Multimedia that contains less information than Multimedia object

object

multimediaIdentifier

required

Document identifier

string format: uuid

"" >= 1 characters

identifier

required

Use this identifier to communicate with Cloudinary.

string

"" >= 1 characters

type

required

Whether Cloudinary media is a VIDEO or IMAGE.

string

Allowed values: IMAGE VIDEO AUDIO RAW

source

required

Currently ONLY using Cloudinary to store all image / video assets.

string

default: CLOUDINARY

Allowed values: YOUTUBE CLOUDINARY

sort

required

Sort allows you to control how you want to sort this record in a list of media records.

integer format: int32

default: 999

angle

Media angle

string

width

required

Media width in pixels.

integer format: int32

"" >= 1

height

required

Media height in pixels.

integer format: int32

"" >= 1

published

Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.

boolean

category

Supported OTA specification PIC code. See OTA geoname data

string

descriptions

Localized media captions to give user some context about where this media was taken.

Array<object>

object

name

required

Use as title or short text description

string

description

required

Longer text description

string

"" >= 1 characters <= 2147483647 characters

language

required

Indicate which language this description is written in.

string

default: en >= 2 characters <= 2 characters

creator

Whether it was user or system generated.

string

default: USER

Allowed values: SYSTEM USER

md5ContentHash

The md5 hash of the name, description and language.

string

hashMismatch

boolean

lifestyleType

Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.

string

attribution

Whether image has attribution properties

Array<object>

object

url

URL to contributor

string

name

required

Name of contributor

string

"" >= 1 characters

isLandscape

True if media width is greater or equal to height

boolean

contact

required

Associate a contact person for this inventory (if applicable).

object

firstName

Contact first name

string

lastName

Contact last name

string

email

Contact E-mail

string format: email

secondaryEmail

Contact secondary Email

string

phoneNumber

Contact phone number

string

fullName

First and last name

string

summary

Summary

string

address

required

Defaults to property address.

object

address1

Address line 1

string

address2

Address line 2

string

state

State

string

postalCode

Postal / zip code

string

county

County

string

city

City name

string

countryCode

Country

string

country

Country

string

fullAddress

Address 1, Address 2, City, State, Postal / Zip code, Country

string

commissionable

required

Indicate whether sales channels receive commission for selling this inventory.

boolean

default: true

name

required

Internal name of inventory.

string

"" >= 1 characters

proximityCode

required

Supported OTA specification PRX code. See OTA geoname data

string

sort

Use this property to sort an inventory in a list of activities.

integer format: int32

minAgeAppropriateCode

Supported OTA specification AQC code. See OTA geoname data

string

bookable

required

Indicates if this inventory can be added to a booking or if it is read-only marketing material only.

boolean

default: true

active

required

Modify inventory availability with this flag.

boolean

default: true

disabilityFeatures

Supported OTA specification PHY code. See OTA geoname data

Array<string>

securityFeatures

Supported OTA specification SEC code. See OTA geoname data

Array<string>

socials

Social network accounts for inventory (if applicable).

Array<object>

Social network

object

type

Type of social network.

string

Allowed values: FACEBOOK INSTAGRAM SKYPE TRIP_ADVISOR TWITTER GOOGLE_PLUS WHATSAPP LINE WECHAT VIBER SNAPCHAT WEIBO RENREN WEBSITE QQ TIKTOK

location

URL or social network identifier to social network profile

string

pricePoint

required

Level of expensiveness.

string

default: THREE

Allowed values: HALF ONE ONE_HALF TWO TWO_HALF THREE THREE_HALF FOUR FOUR_HALF FIVE

recognitionList

Inventory-level recognition.

Array<object>

Recognition for the ancillary blocking.

object

identifier

required

Recognition identifier.

string format: uuid

"" >= 1 characters

category

required

Recognition category.

string

Allowed values: THIRD_PARTY_REVIEW PUBLICATION AWARD

type

required

Type of rating system the recognition operated on. This allows us to display the score properly.

string

Allowed values: STAR_RATING NUMERIC_RATING PERCENT_RATING

provider

required

The name of the entity that administers this recognition.

string

"" >= 1 characters

rating

required

The actual award or rating received by the hotel facility.

number format: float

maxRating

required

Use this to let hotels indicate what the total score for this award is.

number format: float

date

The date the award was received

string format: date

officialAppointmentInd

When true, this indicates the property has received official permission from the award provider to use the rating in publications and marketing materials; when false this permission has not been granted.

boolean

ratingSymbol

Provides the symbol used in the rating. Used in conjunction with the Rating.

string

transactionalInventoryList

Purchasable items for this inventory.

Array<object>

This is one bookable item that can stand alongside a restaurant / meeting room etc.

object

identifier

required

Unique transactional identifier

string format: uuid

"" >= 1 characters

name

required

Internal name of transactional blocking.

string

"" >= 1 characters

descriptions

required

Localized descriptions describing inventory.

Array<object>

>= 1 items <= 2147483647 items

object

name

required

Use as title or short text description

string

description

required

Longer text description

string

"" >= 1 characters <= 2147483647 characters

language

required

Indicate which language this description is written in.

string

default: en >= 2 characters <= 2 characters

creator

Whether it was user or system generated.

string

default: USER

Allowed values: SYSTEM USER

md5ContentHash

The md5 hash of the name, description and language.

string

hashMismatch

boolean

pricingType

required

How this blocking item should be priced.

string

Allowed values: PER_STAY PER_DAY PER_NIGHT PER_USE PER_HOUR PER_PERSON PER_PERSON_PER_NIGHT PER_PERSON_PER_HOUR PER_ADULT PER_ADULT_PER_NIGHT PER_ADULT_PER_HOUR PER_CHILD PER_CHILD_PER_NIGHT PER_CHILD_PER_HOUR

basePrice

required

Base price of booking this blocking.

object

amount

required

number

currency

required

string

>= 1 characters

discountedPrice

required

If you are selling this blocking at a discount, indicate the discounted selling price. Leave empty if there is no discount.

object

amount

required

number

currency

required

string

>= 1 characters

multimedias

List of images / videos of item.

Array<object>

Multimedia that contains less information than Multimedia object

object

multimediaIdentifier

required

Document identifier

string format: uuid

"" >= 1 characters

identifier

required

Use this identifier to communicate with Cloudinary.

string

"" >= 1 characters

type

required

Whether Cloudinary media is a VIDEO or IMAGE.

string

Allowed values: IMAGE VIDEO AUDIO RAW

source

required

Currently ONLY using Cloudinary to store all image / video assets.

string

default: CLOUDINARY

Allowed values: YOUTUBE CLOUDINARY

sort

required

Sort allows you to control how you want to sort this record in a list of media records.

integer format: int32

default: 999

angle

Media angle

string

width

required

Media width in pixels.

integer format: int32

"" >= 1

height

required

Media height in pixels.

integer format: int32

"" >= 1

published

Instead of deleting the media, choose to un-publish it instead for later re-use. Could be you keep seasonal images of the property.

boolean

category

Supported OTA specification PIC code. See OTA geoname data

string

descriptions

Localized media captions to give user some context about where this media was taken.

Array<object>

object

name

required

Use as title or short text description

string

description

required

Longer text description

string

"" >= 1 characters <= 2147483647 characters

language

required

Indicate which language this description is written in.

string

default: en >= 2 characters <= 2 characters

creator

Whether it was user or system generated.

string

default: USER

Allowed values: SYSTEM USER

md5ContentHash

The md5 hash of the name, description and language.

string

hashMismatch

boolean

lifestyleType

Associate this media with a specific lifestyle type. A user searching and filtering inventory based on lifestyles can be shown relevant media first.

string

attribution

Whether image has attribution properties

Array<object>

object

url

URL to contributor

string

name

required

Name of contributor

string

"" >= 1 characters

isLandscape

True if media width is greater or equal to height

boolean

minPax

Whether there is a limit to minimum group size.

integer format: int32

maxPax

Whether there is a limit to maximum group size.

integer format: int32

percentDiscount

Calculates the percent difference between basePrice and discountedPrice.

number

percentPremium

Calculates the percent difference between basePrice and discountedPrice.

number

maxOccupancy

required

Maximum number of guest allowed in a room type.

integer format: int32

default: 2 >= 1

minOccupancy

required

Minimum number of guests allowed in a room type.

integer format: int32

default: 1 >= 1

quantity

required

Defines the number of rooms of this type

integer format: int32

"" >= 1

nonSmoking

required

Non-smoking indicator

boolean

bedroomConfigurationList

required

A room type can have more than one bed configuration.

Array<object>

>= 1 items

object

identifier

required

Unique identifier

string format: uuid

"" >= 1 characters

name

required

Name of layout

string

"" >= 1 characters

bedroomList

required

A room type can have more than one bedroom configuration.

Array<object>

>= 1 items

object

type

required

Type of bedroom

string

Allowed values: MASTER QUEEN JUNIOR DORMITORY BEDROOM_1 BEDROOM_2 BEDROOM_3 BEDROOM_4 BEDROOM_5 BEDROOM_6 BEDROOM_7 BEDROOM_8 BEDROOM_9 BEDROOM_10

bedList

required

A bedroom can have more than one bed type.

Array<object>

>= 1 items

object

bedTypeCode

required

Indicates the type of bed(s) found in the room. Typical values would be Double, Twin, Queen, or King. Supported OTA specification BED code. See OTA geoname data.

string

"" >= 1 characters

quantity

required

Number of beds for this bed type.

integer format: int32

"" >= 1

size

required

Number of square meters that defines the size of this room type.

number format: float

"" >= 1

maxAdultOccupancy

required

Maximum number of adults allowed in a room type.

integer format: int32

default: 2 >= 1

maxChildOccupancy

required

Maximum number of children allowed in a room type.

integer format: int32

bathroomCount

required

Number of bathrooms

integer format: int32

default: 1

livingRoomCount

required

Number of living rooms

integer format: int32

default: 1

maxRollaways

required

Maximum number of rollaway beds allowed in this room type.

integer format: int32

roomCategory

required

Indicates the category of the room. Typical values would be Moderate, Standard, or Deluxe. Supported OTA specification SEG code. See OTA geoname data

string

"" >= 1 characters

floor

Floor an which a room is located

string

roomLocationCode

required

Indicates the location of the room within the hotel structure. Typical values would be “Near Exit”,“Close to elevator”, “Low Floor” or “High Floor”. Supported OTA specification RLT code. See OTA geoname data

string

"" >= 1 characters

roomViewCode

required

Indicates the view of the room. Typical values would be “Ocean view”, “Pool view” or “Garden View”. Supported OTA specification RVT code. See OTA geoname data

string

"" >= 1 characters

composite

required

Indicates that the room (suite) is a composite of smaller units.

boolean

compositeCount

required

Number of rooms of this room type that makes up a larger unit (composite) such as a two bedroom suite could be comprised of two king rooms plus other room types. A 0 means disabled.

integer format: int32

roomClassificationCode

required

Specifies the room classification (e.g., cabin, apartment). Supported OTA specification GRI code. See OTA geoname data

string

"" >= 1 characters

roomArchitectureCode

required

Specifies the architectural style of a room. Supported OTA specification ARC code. See OTA geoname data

string

"" >= 1 characters

roomGender

Used to request or specify a gender assignment for a room. Note: Typically used by Hosteliers.

string

default: Unknown

Allowed values: Male Female MaleAndFemale Unknown

sharedRoomInd

required

If TRUE, the room requires or has sharing available. Note: Typically used by Hosteliers.

boolean

maxCribs

required

Maximum number of cribs allowed in a room type.

integer format: int32

amenities

Collection of room amenity items available to the guest. Supported OTA specification RMA code. See OTA geoname data

Array<string>

includedAdultOccupancy

required

The number of pax the room price was meant for

integer format: int32

default: 2

includedChildOccupancy

required

The number of children the room price was meant for

integer format: int32

baseRate

required

Typical one night rate during regular remand period

object

amount

required

number

currency

required

string

>= 1 characters

minRate

required

Typical one night rate in a distressed period

object

amount

required

number

currency

required

string

>= 1 characters

ratePlan

required

object

identifier

required

Rate plan identifier

string format: uuid

"" >= 1 characters

hotelIdentifier

required

Hotel ID

string

"" >= 1 characters

name

required

Provides the name of the rate plan.

string

"" >= 1 characters

prepaid

required

When true, indicates if the rate is a prepaid rate.

boolean

enabled

required

Whether rate plan is active or not.

boolean

breakfast

required

When true, indicates breakfast is included.

boolean

brunch

required

When true, indicates brunch is included.

boolean

lunch

required

When true, indicates lunch is included.

boolean

dinner

required

When true, indicates dinner is included.

boolean

allInclusive

required

Everything included except alcohol

boolean

allInclusivePlusAlcohol

required

Everything included with alcohol

boolean

sellStartDate

Set a start date for when to start selling this rate. When sellStartDate and sellEndDate are set, this rate is only available for sale within that date range.

string format: date

sellEndDate

Set an end date for when to finish selling this rate. When sellStartDate and sellEndDate are set, this rate is only available for sale within that date range.

string format: date

stayStartDate

Set a start date for when the guest can visit. When stayStartDate and stayEndDate are set, this rate is only available for stay within that date range.

string format: date

stayEndDate

Set an end date for when the guest can visit. When stayStartDate and stayEndDate are set, this rate is only available for stay within that date range.

string format: date

loyaltyPointsAccrue

Property honors loyalty points with this rate plan.

boolean

maxAdvanceBookingOffset

Maximum days before the arrival date for which this rate plan may be booked.

integer format: int32

minAdvanceBookingOffset

Minimum days before the arrival date for which this rate plan may be booked.

integer format: int32

minTotalOccupancy

Defines the minimum number of total occupants required for this rate plan.

integer format: int32

maxTotalOccupancy

Defines the maximum number of total occupants required for this rate plan.

integer format: int32

minLOS

Indicates the minimum length of stay required for this rate plan.

integer format: int32

maxLOS

Indicates the maximum length of stay.

integer format: int32

minAge

The minimum age to qualify for this rate plan.

integer format: int32

maxAge

The maximum age to qualify for this rate plan.

integer format: int32

ratePlanLevelFees

This can be a one-time fee such as a cleaning fee

Array<object>

object

descriptions

required

List of localized descriptions for this fee.

Array<object>

"" >= 1 items

object

description

required

Longer text description

string

"" >= 1 characters <= 2147483647 characters

language

required

Indicate which language this description is written in.

string

default: en >= 2 characters <= 2 characters

creator

Whether it was user or system generated.

string

default: USER

Allowed values: SYSTEM USER

md5ContentHash

The md5 hash of the name, description and language.

string

hashMismatch

boolean

fixedAmount

required

Rate plan level fixed fee amount in property currency

object

amount

required

number

currency

required

string

>= 1 characters

type

required

Rate plan fee type

string

Allowed values: PER_DAY PER_STAY PER_PERSON_PER_DAY PER_PERSON_PER_STAY

availableDaysOfWeek

object

mon

Set to true to enable Monday.

boolean

tue

Set to true to enable Tuesday.

boolean

wed

Set to true to enable Wednesday.

boolean

thu

Set to true to enable Thursday.

boolean

fri

Set to true to enable Friday.

boolean

sat

Set to true to enable Saturday.

boolean

sun

Set to true to enable Sunday.

boolean

disabled

Convenience property to quickly determine if this existing object has any active days enabled.

boolean

arrivalDaysOfWeek

object

mon

Set to true to enable Monday.

boolean

tue

Set to true to enable Tuesday.

boolean

wed

Set to true to enable Wednesday.

boolean

thu

Set to true to enable Thursday.

boolean

fri

Set to true to enable Friday.

boolean

sat

Set to true to enable Saturday.

boolean

sun

Set to true to enable Sunday.

boolean

disabled

Convenience property to quickly determine if this existing object has any active days enabled.

boolean

departureDaysOfWeek

object

mon

Set to true to enable Monday.

boolean

tue

Set to true to enable Tuesday.

boolean

wed

Set to true to enable Wednesday.

boolean

thu

Set to true to enable Thursday.

boolean

fri

Set to true to enable Friday.

boolean

sat

Set to true to enable Saturday.

boolean

sun

Set to true to enable Sunday.

boolean

disabled

Convenience property to quickly determine if this existing object has any active days enabled.

boolean

requiredDaysOfWeek

object

mon

Set to true to enable Monday.

boolean

tue

Set to true to enable Tuesday.

boolean

wed

Set to true to enable Wednesday.

boolean

thu

Set to true to enable Thursday.

boolean

fri

Set to true to enable Friday.

boolean

sat

Set to true to enable Saturday.

boolean

sun

Set to true to enable Sunday.

boolean

disabled

Convenience property to quickly determine if this existing object has any active days enabled.

boolean

earlyCheckInCharge

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

lateCheckOutCharge

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

cancellationPolicy

The cancellation policy for this rate plan.

object

identifier

required

Unique cancellation policy identifier

string format: uuid

hotelIdentifier

required

Property this cancellation is associated with

string format: uuid

refundable

required

Whether this cancellation policy is refundable or not

boolean

advanceCancellationFreeOfCharge

When the cancellation policy is refundable, this flag can be set and indicates there is more rules involved than just a no-questions-asked refundable.

string

Allowed values: UNTIL_EIGHTEEN_HUNDRED_HOURS_ON_DAY_OF_ARRIVAL UNTIL_FOURTEEN_HUNDRED_HOURS_ON_DAY_OF_ARRIVAL ONE_DAY_BEFORE_ARRIVAL TWO_DAYS_BEFORE_ARRIVAL THREE_DAYS_BEFORE_ARRIVAL FIVE_DAYS_BEFORE_ARRIVAL SEVEN_DAYS_BEFORE_ARRIVAL FOURTEEN_DAYS_BEFORE_ARRIVAL TWENTYONE_DAYS_BEFORE_ARRIVAL THIRTY_DAYS_BEFORE_ARRIVAL FOURTY_TWO_DAYS_BEFORE_ARRIVAL SIXTY_DAYS_BEFORE_ARRIVAL

refundableCancellationCharge

If advanceCancellationFreeOfCharge rules is not honored, this property explains what the guest will be charged.

string

Allowed values: FIRST_NIGHT THIRTY_PERCENT FIFTY_PERCENT SIXTY_PERCENT SEVENTY_PERCENT NINENTY_PERCENT ONE_HUNDRED_PERCENT

noShowCharge

In case the ‘Refundable cancellation charge’ is set, a different no show charge can be applied.

string

Allowed values: SAME_AS_CANCELLATION_FEE ONE_HUNDRED_PERCENT_OF_TOTAL_CHARGE

nonRefundableCancellationCharge

When the cancellation policy is non-refundable, this flag can be set and indicates there is more rules involved to calculate what the guest will owe in case of a cancellation.

string

Allowed values: FIRST_NIGHT TEN_PERCENT THIRTY_PERCENT FIFTY_PERCENT SEVENTY_PERCENT

nonRefundableDeadline

The non-refundable charge might can have a deadline. If that deadline passes, the guest might be charged more.

string

Allowed values: ONE_DAY_BEFORE_ARRIVAL TWO_DAYS_BEFORE_ARRIVAL THREE_DAYS_BEFORE_ARRIVAL FIVE_DAYS_BEFORE_ARRIVAL SEVEN_DAYS_BEFORE_ARRIVAL FOURTEEN_DAYS_BEFORE_ARRIVAL TWENTYONE_DAYS_BEFORE_ARRIVAL THIRTY_DAYS_BEFORE_ARRIVAL FOURTY_TWO_DAYS_BEFORE_ARRIVAL SIXTY_DAYS_BEFORE_ARRIVAL

nonRefundableAfterDeadlineCancellationCharge

If the guest does not honor the non-refundable deadline rule, this charge dictates what she owes after the deadline passes.

string

Allowed values: FIRST_NIGHT TEN_PERCENT THIRTY_PERCENT FIFTY_PERCENT SEVENTY_PERCENT ONE_HUNDRED_PERCENT

policyCode

string

cancellationPolicyExceptions

Allows a property to dynamically use another cancellation policy for a specific date range

object

list

required

List of cancellation policy exceptions

Array<object>

>= 1 items

object

cancellationPolicyIdentifier

required

Cancellation policy

string format: uuid

"" >= 1 characters

cancellationPolicy

required

Cancellation policy

object

identifier

required

Unique cancellation policy identifier

string format: uuid

hotelIdentifier

required

Property this cancellation is associated with

string format: uuid

refundable

required

Whether this cancellation policy is refundable or not

boolean

advanceCancellationFreeOfCharge

When the cancellation policy is refundable, this flag can be set and indicates there is more rules involved than just a no-questions-asked refundable.

string

refundableCancellationCharge

If advanceCancellationFreeOfCharge rules is not honored, this property explains what the guest will be charged.

string

Allowed values: FIRST_NIGHT THIRTY_PERCENT FIFTY_PERCENT SIXTY_PERCENT SEVENTY_PERCENT NINENTY_PERCENT ONE_HUNDRED_PERCENT

noShowCharge

In case the ‘Refundable cancellation charge’ is set, a different no show charge can be applied.

string

Allowed values: SAME_AS_CANCELLATION_FEE ONE_HUNDRED_PERCENT_OF_TOTAL_CHARGE

nonRefundableCancellationCharge

When the cancellation policy is non-refundable, this flag can be set and indicates there is more rules involved to calculate what the guest will owe in case of a cancellation.

string

Allowed values: FIRST_NIGHT TEN_PERCENT THIRTY_PERCENT FIFTY_PERCENT SEVENTY_PERCENT

nonRefundableDeadline

The non-refundable charge might can have a deadline. If that deadline passes, the guest might be charged more.

string

nonRefundableAfterDeadlineCancellationCharge

If the guest does not honor the non-refundable deadline rule, this charge dictates what she owes after the deadline passes.

string

Allowed values: FIRST_NIGHT TEN_PERCENT THIRTY_PERCENT FIFTY_PERCENT SEVENTY_PERCENT ONE_HUNDRED_PERCENT

policyCode

string

startDate

required

Start date for when this cancellation policy should start to override the default cancellation policy.

string format: date

endDate

required

End date for when this cancellation policy should end overriding the default cancellation policy.

string format: date

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

enabled

required

Flag to enable / disable master rate across all sales channels

boolean

default: true

perkTypes

Array<object>

The perks associated with this master rate

object

identifier

required

Enum identifier identifier for this perk. Makes the persistent version backwards compatible.

string

"" >= 1 characters

guaranteed

Whether perk is guaranteed or not.

boolean

level

The platform value of this perk.

integer format: int32

descriptions

required

Localized description for this perk

Array<object>

"" >= 1 items

object

name

required

Use as title or short text description

string

description

required

Longer text description

string

"" >= 1 characters <= 2147483647 characters

language

required

Indicate which language this description is written in.

string

default: en >= 2 characters <= 2 characters

creator

Whether it was user or system generated.

string

default: USER

Allowed values: SYSTEM USER

md5ContentHash

The md5 hash of the name, description and language.

string

hashMismatch

boolean

sort

This is how perks get sorted when in a list

integer format: int32

Example

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

{}

Toggle Master Rate

Parameters

Path Parameters

Example

Example

Header Parameters

Request Body required

Example

Responses

200

Example

400

Example generated

401

403

500

Example generated

Request Body^required

Example ^generated

Example ^generated