Create Add-On

POST

/api/managing-entity/{managingEntityIdentifier}/extranet/add-on

curl --request POST \
  --url https://api.wink.travel/api/managing-entity/hotel-1/extranet/add-on \
  --header 'Content-Type: application/json' \
  --header 'Wink-Version: 2.0' \
  --data '{ "featuredInd": false, "lifestyleType": "LIFESTYLE_HEALTH_FITNESS", "location": "", "descriptions": [ "" ], "multimedias": [ "" ], "contact": "", "address": "", "commissionable": true, "name": "", "proximityCode": "", "sort": "", "minAgeAppropriateCode": "", "bookable": true, "active": true, "disabilityFeatures": [ "" ], "securityFeatures": [ "" ], "socials": [ "" ], "pricePoint": "HALF", "recognitionList": [ "" ], "transactionalInventoryList": [ "" ], "applicableStart": "", "applicableEnd": "", "reservationRequiredInd": false, "opens": "", "closes": "", "daysOfWeek": "", "numberOfUnits": 0, "ratePlanIdentifier": "", "mandatory": false, "dateRanges": "" }'

• Endpoint

Create a new add-on.

Parameters

Path Parameters

managingEntityIdentifier

required

string

""

Create a new add-on record owned by this property identifier

Example

hotel-1

Header Parameters

Wink-Version

string

default: 2.0.0

Allowed values: 2.0

Request Body ^required

Media type application/json

object

featuredInd

required

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

boolean

Example

false

lifestyleType

Indicate the type of lifestyle this blocking 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

Example

LIFESTYLE_HEALTH_FITNESS

location

required

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

object

x

number format: double

y

number format: double

type

string

coordinates

Array<number>

Example

{
  "type": "POINT",
  "coordinates": [
    100.5581533,
    13.7370197
  ]
}

descriptions

required

Localized descriptions describing inventory.

Array<object>

>= 1 items

object

name

required

Use as title or short text description

string

""

Example

An example title

description

required

Longer text description

string

"" >= 1 characters <= 2147483647 characters

Example

This is a longer description in the specified language.

language

required

Indicate which language this description is written in.

string

default: en >= 2 characters <= 2 characters

Example

en

multimedias

required

List of images / videos of blocking.

Array<object>

>= 1 items

Multimedia that contains less information than Multimedia object

object

multimediaIdentifier

required

Document identifier

string format: uuid

"" >= 1 characters

Example

image-1

identifier

required

Use this identifier to communicate with Cloudinary.

string

"" >= 1 characters

Example

cloudinary-image-1

type

required

Whether Cloudinary media is a VIDEO or IMAGE.

string

""

Allowed values: IMAGE VIDEO AUDIO RAW

Example

IMAGE

source

required

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

string

default: CLOUDINARY

Allowed values: YOUTUBE CLOUDINARY

Example

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

Example

10

angle

Media angle

string

""

Example

-90

width

required

Media width in pixels.

integer format: int32

"" >= 1

Example

2560

height

required

Media height in pixels.

integer format: int32

"" >= 1

Example

1600

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

Example

true

category

Supported OTA specification PIC code. See OTA geoname data

string

""

Example

1

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

""

Example

An example title

description

required

Longer text description

string

"" >= 1 characters <= 2147483647 characters

Example

This is a longer description in the specified language.

language

required

Indicate which language this description is written in.

string

default: en >= 2 characters <= 2 characters

Example

en

creator

Whether it was user or system generated.

string

default: USER

Allowed values: SYSTEM USER

Example

SYSTEM

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

""

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

Example

LIFESTYLE_HEALTH_FITNESS

attribution

Whether image has attribution properties

Array<object>

""

object

url

URL to contributor

string

""

Example

https://maps.google.com/maps/contrib/111628493169070103594

name

required

Name of contributor

string

"" >= 1 characters

Example

Samuel Adams

isLandscape

True if media width is greater or equal to height

boolean

Example

true

contact

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

object

firstName

Contact first name

string

""

Example

John

lastName

Contact last name

string

""

Example

Smith

email

Contact E-mail

string format: email

""

Example

[email protected]

secondaryEmail

Contact secondary Email

string

""

Example

[email protected]

phoneNumber

Contact phone number

string

""

Example

+12125551212

fullName

First and last name

string

""

Example

John Smith

summary

Summary

string

""

Example

John Smith ([email protected] / +12125551212)

address

required

Defaults to property address.

object

address1

Address line 1

string

""

Example

234 Near da beach

address2

Address line 2

string

""

Example

Pebble #5001

state

State

string

""

Example

CA

postalCode

Postal / zip code

string

""

Example

90210

county

County

string

""

Example

Alameda county

city

City name

string

""

countryCode

Country

string

""

country

Country

string

""

Example

United States

fullAddress

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

string

""

Example

11 At home, Suite 3C, New York City, NY 10010, United States

commissionable

required

Indicate whether sales channels receive commission for selling this blocking.

boolean

default: true

Example

true

name

required

Internal name of blocking.

string

"" >= 1 characters

Example

Archery lesson

proximityCode

Supported OTA specification PRX code. See OTA geoname data

string

""

Example

1

sort

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

integer format: int32

""

Example

1

minAgeAppropriateCode

Supported OTA specification AQC code. See OTA geoname data

string

""

Example

1

bookable

required

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

boolean

default: true

Example

true

active

required

Modify blocking availability with this flag.

boolean

default: true

Example

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 blocking (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

Example

THREE

recognitionList

Inventory-level recognition.

Array<object>

Recognition for the ancillary blocking.

object

identifier

required

Recognition identifier.

string format: uuid

"" >= 1 characters

Example

recognition-1

category

required

Recognition category.

string

""

Allowed values: THIRD_PARTY_REVIEW PUBLICATION AWARD

Example

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

Example

PERCENT_RATING

provider

required

The name of the entity that administers this recognition.

string

"" >= 1 characters

Example

Michelin

rating

required

The actual award or rating received by the hotel facility.

number format: float

""

Example

8.5

maxRating

required

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

number format: float

""

Example

10

date

The date the award was received

string format: date

""

Example

2020-10-24

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

Example

true

ratingSymbol

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

string

""

Example

*

transactionalInventoryList

Purchasable items for this blocking.

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

Example

travel-blocking-1

name

required

Internal name of transactional blocking.

string

"" >= 1 characters

Example

1 hour session

descriptions

required

Localized descriptions describing inventory.

Array<object>

>= 1 items <= 2147483647 items

object

name

required

Use as title or short text description

string

""

Example

An example title

description

required

Longer text description

string

"" >= 1 characters <= 2147483647 characters

Example

This is a longer description in the specified language.

language

required

Indicate which language this description is written in.

string

default: en >= 2 characters <= 2 characters

Example

en

creator

Whether it was user or system generated.

string

default: USER

Allowed values: SYSTEM USER

Example

SYSTEM

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

Example

image-1

identifier

required

Use this identifier to communicate with Cloudinary.

string

"" >= 1 characters

Example

cloudinary-image-1

type

required

Whether Cloudinary media is a VIDEO or IMAGE.

string

""

Allowed values: IMAGE VIDEO AUDIO RAW

Example

IMAGE

source

required

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

string

default: CLOUDINARY

Allowed values: YOUTUBE CLOUDINARY

Example

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

Example

10

angle

Media angle

string

""

Example

-90

width

required

Media width in pixels.

integer format: int32

"" >= 1

Example

2560

height

required

Media height in pixels.

integer format: int32

"" >= 1

Example

1600

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

Example

true

category

Supported OTA specification PIC code. See OTA geoname data

string

""

Example

1

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

""

Example

An example title

description

required

Longer text description

string

"" >= 1 characters <= 2147483647 characters

Example

This is a longer description in the specified language.

language

required

Indicate which language this description is written in.

string

default: en >= 2 characters <= 2 characters

Example

en

creator

Whether it was user or system generated.

string

default: USER

Allowed values: SYSTEM USER

Example

SYSTEM

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

""

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

Example

LIFESTYLE_HEALTH_FITNESS

attribution

Whether image has attribution properties

Array<object>

""

object

url

URL to contributor

string

""

Example

https://maps.google.com/maps/contrib/111628493169070103594

name

required

Name of contributor

string

"" >= 1 characters

Example

Samuel Adams

isLandscape

True if media width is greater or equal to height

boolean

Example

true

minPax

Whether there is a limit to minimum group size.

integer format: int32

""

Example

2

maxPax

Whether there is a limit to maximum group size.

integer format: int32

""

Example

10

percentDiscount

Calculates the percent difference between basePrice and discountedPrice.

number

""

Example

0.1

percentPremium

Calculates the percent difference between basePrice and discountedPrice.

number

""

Example

0.1

applicableStart

Start month and day or date for which the attraction (e.g. the start of a season) is available. This date property signifies that the blocking is recurring and / or seasonal. If the date is in the past, only day and month will be used to infer seasonality. If the date is a future date, it will be interpreted as a starting date.

string format: date

""

Example

1970-1-1

applicableEnd

End month and day or date for which the attraction (e.g. the start of a season) is available. This date property signifies that the blocking is recurring and / or seasonal. If the date is in the past, only day and month will be used to infer seasonality. If the date is a future date, it will be interpreted as a ending date.

string format: date

""

Example

1970-12-1

reservationRequiredInd

Indicates whether a reservation is required to participate in this blocking.

boolean

Example

false

opens

Opening time of blocking (if applicable). Leave empty if blocking is always available.

string

""

Example

09:00

closes

Closing time of blocking (if applicable). Leave empty if blocking is always available.

string

""

Example

17:30

daysOfWeek

Indicate which days this blocking is open.

object

mon

Set to true to enable Monday.

boolean

Example

true

tue

Set to true to enable Tuesday.

boolean

Example

true

wed

Set to true to enable Wednesday.

boolean

Example

true

thu

Set to true to enable Thursday.

boolean

Example

true

fri

Set to true to enable Friday.

boolean

Example

true

sat

Set to true to enable Saturday.

boolean

Example

true

sun

Set to true to enable Sunday.

boolean

Example

true

disabled

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

boolean

Example

true

numberOfUnits

required

Total number of add-ons available to purchase.

integer format: int32

0

Example

10

ratePlanIdentifier

Pass an optional rate plan identifier to restrict this add-on to guests on a specific rate plan. Mutually exclusive with dateRanges.

string format: uuid

""

mandatory

required

Make this add-on mandatory for all guests by enabling this flag.

boolean

Example

true

dateRanges

Optional list of date ranges restricting add-on availability to specific periods. Mutually exclusive with ratePlanIdentifier.

Array<object>

""

object

startDate

required

Retrieve data range starting with and including this start date

string format: date

""

Example

2020-12-24

endDate

required

Retrieve data range ending with and including this end date

string format: date

""

Example

2020-12-31

Responses

201

Created

Media type application/json

Add-On

Add-On is a type of ABS.

object

id

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

"" >= 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 blocking 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 blocking takes place. Defaults to location of property.

object

x

number format: double

y

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 blocking.

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

""

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

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 blocking (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 blocking.

boolean

default: true

name

required

Internal name of blocking.

string

"" >= 1 characters

proximityCode

required

Supported OTA specification PRX code. See OTA geoname data

string

""

sort

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

integer format: int32

""

minAgeAppropriateCode

Supported OTA specification AQC code. See OTA geoname data

string

""

bookable

required

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

boolean

default: true

active

required

Modify blocking 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 blocking (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 blocking.

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

""

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

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

""

applicableStart

Start month and day or date for which the attraction (e.g. the start of a season) is available. This date property signifies that the blocking is recurring and / or seasonal. If the date is in the past, only day and month will be used to infer seasonality. If the date is a future date, it will be interpreted as a starting date.

string format: date

""

applicableEnd

End month and day or date for which the attraction (e.g. the start of a season) is available. This date property signifies that the blocking is recurring and / or seasonal. If the date is in the past, only day and month will be used to infer seasonality. If the date is a future date, it will be interpreted as a ending date.

string format: date

""

reservationRequiredInd

Indicates whether a reservation is required to participate in this blocking.

boolean

opens

Opening time of blocking (if applicable). Leave empty if blocking is always available.

string

""

closes

Closing time of blocking (if applicable). Leave empty if blocking is always available.

string

""

daysOfWeek

Indicate which days this blocking is open.

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

numberOfUnits

required

Total number of add-ons available to purchase.

integer format: int32

0

ratePlan

An optional rate plan can be applied to the add-on. The rate plan can help to create availability restrictions.

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

""

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

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

mandatory

required

Make this add-on mandatory for all guests by enabling this flag.

boolean

dateRanges

Optional list of date ranges restricting add-on availability to specific periods. Mutually exclusive with ratePlan.

Array<object>

""

object

startDate

required

Retrieve data range starting with and including this start date

string format: date

""

endDate

required

Retrieve data range ending with and including this end date

string format: date

""

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

object

type

string format: uri

title

string

status

integer format: int32

detail

string

instance

string format: uri

properties

object

key

additional properties

object

type

string format: uri

title

string

status

integer format: int32

detail

string

instance

string format: uri

properties

object

key

additional properties

object

type

string format: uri

title

string

status

integer format: int32

detail

string

instance

string format: uri

properties

object

key

additional properties

object

type

string format: uri

title

string

status

integer format: int32

detail

string

instance

string format: uri

properties

object

key

additional properties

401

Unauthorized

Media type */*

object

type

string format: uri

title

string

status

integer format: int32

detail

string

instance

string format: uri

properties

object

key

additional properties

403

Forbidden

Media type */*

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

{}

object

object

object

object