HTTP method

Get

Authorization

string

required

Basic Authentication token for API access.

Basic VzM4dFI4S1lvNzh2OnczMnowME15RXk2Q1hGMTI=

Content-Type

string

required

Specifies the media type of the request.

application/json;charset=UTF-8

contextCode

string

required

page

object

Contains pagination details.

page.index

integer

The current page index (starting from 0).

page.size

integer

The number of elements per page.

page.totalElements

integer

The total number of elements in the dataset.

page.totalPages

integer

The total number of pages in the dataset.

items

array

A list of properties, where each object represents a hotel.

items.contextCode

string

Business context code, possibly indicating the data source or usage.

items.propertyCode

string

Unique identifier for the property (hotel).

items.propertyName

string

The name of the hotel.

items.countryCode

string

The ISO country code where the property is located (e.g., US, CN, FR).

items.brandCode

string

The brand code indicates the brand the property belongs to (e.g., Hilton, Marriott).

items.chainCode

string

The chain code represents the hotel’s parent chain.

items.operateStatus

string

Indicates the operational status of the property.

Enum: [ ENABLED, PAUSED ]

ENABLED

HTTP method

URL

Get

Authorization

String

required

Basic Authentication token for API access.

Basic VzM4dFI4S1lvNzh2OnczMnowME15RXk2Q1hGMTI=

Content-Type

String

required

Specifies the media type of the request.

application/json;charset=UTF-8

contextCode

String(query)

required

Context Code in DerbySoft's system.

DERBYDEMO

propertyCode

String(path)

required

Property code provided by content suppliers, only the following characters are allowed.

1. Digits (0-9) 

2. Uppercase letters (A-Z) 

3. Hyphen ('-')

BONITAPROPERTY

HTTP method

POST

Authorization

String

required

Basic Authentication token for API access.

Basic VzM4dFI4S1lvNzh2OnczMnowME15RXk2Q1hGMTI=

Content-Type

String

required

Specifies the media type of the request.

application/json;charset=UTF-8

contextCode

Yes

String

Context Code in DerbySoft's system.

derbydemo

supplierCode

Yes

String

Supplier Code in DerbySoft's system.

DERBYHOTEL

propertyCode

Yes

String

Property code provided by content suppliers, only the following characters are allowed.

1. Digits (0-9)

2. Uppercase letters (A-Z)

3. Hyphen ('-')

derbydemo001

operateStatus

Yes

String

Indicates the operational status of the property.

Enum: [ ENABLED, PAUSED ]

ENABLED

Basic Information

Yes(create properties)

Object

<PropertyBasicInformation>

Basic information about the property.

propertyNameLangs

Yes(create properties)

String

Name of the property.

DerbySoft Demo Hotel

propertyShortNameLangs

String

Short name for the property.

Derby Demo

propertyDescriptionLangs

String

Description of the property.

A modern hotel located in the heart of the city, offering premium services and amenities.

status

String

Current status of the property.

Enum: [ OPEN, CLOSED, PRE_OPENING, DE_FLAGGED, TEST, INACTIVATE, REACTIVATED, DELETED, LOCKED, UNLOCKED ]

OPEN

countryCode

String

Country code (ISO format).

US

chainCode

String

Unique identifier for the property chain.

DERBYCHAIN

chainNameLangs

String

Name of the property chain.

brandCode

String

Unique identifier for the property brand.

DERBYBRAND

brandNameLangs

String

Name of the property brand.

timeZone

String

Time zone for the property location.

currencyCode

String

Currency code for the charge.

USD

whenBuilt

String

The property build date.

Date Format: yyyy

2010

firstOpenDate

String

The property first opening date.

Date Format: yyyy-MM-dd

2010-06-15

renovations

List<Renovation>

List of renovations done to the property.

renovations.completionDate

String

The property renovation completion date.

Date Format: yyyy

2022

renovations.descriptionLangs

List<I18N>

The property renovation description.

floors

List<FloorRange>

List of floor ranges in the property.

floors.start

Integer

Starting floor number of the property.

1

floors.end

Integer

Ending floor number (top floor) of the property.

10

propertyCategories

List<Category>

List of property categories (e.g., luxury, economy).

propertyCategories.code

String

Specifies the property class type code.

propertyCategories.detailLangs

List<I18N>

Description of the category in multiple languages.

segmentCategories

List<Category>

Segmentation of the property type (e.g., extended stay, economy).

segmentCategories.code

String

Specifies the type of property such as luxury, extended stay, economy.

segmentCategories.detailLangs

List<I18N>

Description of the segment in multiple languages.

locationCategories

List<Category>

Categories describing the property’s location (e.g., airport, suburban).

locationCategories.code

String

Specifies the general location of the property such as airport, suburban, downtown.

locationCategories.detailLangs

List<I18N>

Description of the location category in multiple languages.

position

Object<Position>

Geolocation information for the property.

position.latitude

Yes(create property)

String

Latitude coordinate for the property.

40.7128

position.longitude

Yes(create property)

String

Longitude coordinate for the property.

-74.006

position.positionAccuracyCode

String

Accuracy of the geo-coding for the reference point. Refer to OpenTravel Code List Position Accuracy Code (PAC).

contact

Object<ContactInfo>

Contact information for the property.

contact.companyNameLangs

List<I18N>

Company name in multiple languages.

contact.departmentLangs

List<I18N>

The department name or ID with which the contact is associated.

contact.addresses

contact.phones

List<Phone>

Phone numbers for contacting the property.

contact.phones.locationType

String

Describes the location of the phone, such as Home, Office, Property

Reservation Office, etc. Refer to OpenTravel Code List Phone Location Type (PLT).

contact.phones.techType

String

Indicates type of technology associated with this telephone number, such as Voice, Data, Fax, Pager, Mobile, TTY, etc. Refer to OpenTravel Code List Phone Technology Type (PTT).

contact.phones.countryAccessCode

String

Code assigned by telecommunications authorities for international country access identifier.

contact.phones.areaCityCode

String

Code assigned for telephones in a specific region, city, or area.

contact.phones.phoneNumber

String

Telephone number assigned to a single location.

contact.emails

List<Email>

Email addresses for the property contact.

contact.emails.type

String

Defines the purpose of the e-mail address (e.g. personal, business, listserve).

contact.emails.address

String

The email address.

contact.urls

String

Provides a Website address.

capacities

List<GuestRoomInfoCapacity>

The types and quantities of guest rooms at a property.

capacities.code

String

Refer to OpenTravel Code List Guest Room Info (GRI).

capacities.detailLangs

List<I18N>

May be used to give further detail on the code.

capacities.quantity

Integer

Specifies the number of guest rooms.

awards

List<Award>

Awards received by the property.

awards.date

Date

Format: yyyy-MM-dd

The date the award was received.

awards.providerLangs

List<I18N>

The name of the award or ratings provider (e.g., Michelin, American Automobile Association (AAA)).

awards.ratingLangs

List<I18N>

The actual award or rating received by the property facility (e.g. 4 stars, 3 diamonds). If used in conjunction with RatingSymbol only the numeric rating would be passed here.

awards.officialAppointment

Boolean

Indicates whether the property has permission to use the award in publications.

awards.ratingSymbol

String

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

spokenLanguages.primaryLanguage

Boolean

Primary language spoken at property.

spokenLanguages.languageCode

String

Language spoken by the property staff.

labels.code

String

Property label code.

labels.descriptionLangs

List<I18N>

Multilingual descriptions of the property label.

richMedias.url

String

URL linking to a collection of rich media, including images, videos, and 360° tours.

lastUpdated

String

Date of the last update to the basic information.

facilityLastUpdated

String

Date of the last update to facility-related data.

policyLastUpdated

String

Date of the last update to policy-related data.

referencePointLastUpdated

String

Date of the last update to reference point data.

attractionsLastUpdated

String

Date of the last update to attraction-related data.

recreationLastUpdated

String

Date of the last update to recreation-related data.

otherHotelsLastUpdated

String

Date of the last update to data about other hotels in the area.

affiliationsLastUpdated

String

Date of the last update to affiliation-related data.

imagesLastUpdated

String

Date of the last update to image-related data.

masterChainCode

String

Master chain code identifying a specific hotel chain recognized by all GDSs.

generalUnit

String

Default unit of measurement for general purposes (fallback logic, based on OpenTravel Unit of Measure Code (UOM)).

generaWeightUnit

String

Default unit of measurement for weight (e.g., kg, lbs), using fallback logic based on OpenTravel UOM code.

generaAreaUnit

String

Default unit of measurement for weight (e.g., kg, lbs), using fallback logic based on OpenTravel UOM code.

generaDistanceUnit

String

Default unit of measurement for distance (e.g., kilometers, miles), using fallback logic based on OpenTravel Unit of Measure Code (UOM).

facilityInformation

Object<FacilityInformation>

Information about the amenities and services available at the property.

amenities

List<Amenity>

List of amenities available at the property.

amenities.id

String

Unique ID for the amenity.

amenities.code

String

Refer to OpenTravel Code List property Amenity Code (HAC).

amenities.detailLangs

List<I18N>

May be used to give further detail on the code.

amenities.included

Boolean

This may be used to identify a standard service included in the room rate.

amenities.proximityCode

String

Denotes whether a service is onsite, offsite or information is not available.

Refer to OpenTravel Code Table Proximity (PRX).

amenities.quantity

Integer

Denotes the total number of service items identified by the Code attribute.

amenities.operationSchedules

List<OperationSchedule>

Defines service availability, including operating dates, hours, and applicable fees.

amenities.operationSchedules.start

String

Start date.

Must follow the format yyyy-MM-dd (Year-Month-Day), e.g., 2023-11-22.

amenities.operationSchedules.end

String

End date.

Must follow the format yyyy-MM-dd (Year-Month-Day), e.g., 2023-11-22.

amenities.operationSchedules.

operationTimes

List<OperationTime>

List of operation times.

amenities.operationSchedules.

operationTimes.weekDay

String

Day of operation.

Enum: [ MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY ]

amenities.operationSchedules.

operationTimes.startTime

String

Start time.

Must follow the format HH:mm (Hour:Minute, 24-hour format), e.g., 10:22.

amenities.operationSchedules.

operationTimes.endTime

String

End time.

Must follow the format HH:mm (Hour:Minute, 24-hour format), e.g., 10:22.

amenities.operationSchedules.charges

List<ServiceCharge>

Charges for the amenity.

amenities.operationSchedules.charges.

amount

Double

A monetary amount.

amenities.operationSchedules.charges.

percent

Double

Fee percentage; if zero, assume use of the Amount attribute

(Amount or Percent must be a zero value).

amenities.operationSchedules.charges.

currency

String

Currency code for the charge.

amenities.operationSchedules.charges.

unitCode

String

This is the unit for which the charge applies (e.g. room, person, seat).

Refer to OpenTravel Code List Charge Type (CHG).

amenities.operationSchedules.charges.

frequencyCode

String

This is the timeframe used to apply the charge during the course of the reservation

(e.g. Daily, Weekly, Stay). Refer to OpenTravel Code List Charge Type (CHG).

businessServices

List<Amenity>

List of business services available at the property.

businessServices.id

String

Unique ID for the business service.

businessServices.code

String

Refer to OpenTravel Code List property Business Code (HAC).

businessServices.detailLangs

List<I18N>

May be used to give further detail on the code.

businessServices.included

Boolean

This may be used to identify a standard service included in the room rate.

businessServices.proximityCode

String

Denotes whether a service is onsite, offsite or information is not available.

Refer to OpenTravel Code Table Proximity (PRX).

businessServices.quantity

Integer

Denotes the total number of service items identified by the Code attribute.

businessServices.operationSchedules

List<OperationSchedule>

Defines service availability, including operating dates, hours, and applicable fees.

businessServices.operationSchedules.start

String

Start date.

Must follow the format yyyy-MM-dd (Year-Month-Day), e.g., 2023-11-22.

businessServices.operationSchedules.

end

String

End date.

Must follow the format yyyy-MM-dd (Year-Month-Day), e.g., 2023-11-22.

businessServices.operationSchedules.

operationTimes

List<OperationTime>

List of operation times.

businessServices.operationSchedules.

operationTimes.weekDay

String

Day of operation.

Enum: [ MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY ]

businessServices.operationSchedules.

operationTimes.startTime

String

Start time.

Must follow the format HH:mm (Hour:Minute, 24-hour format), e.g., 10:22.

businessServices.operationSchedules.

operationTimes.endTime

String

End time.

Must follow the format HH:mm (Hour:Minute, 24-hour format), e.g., 10:22.

businessServices.operationSchedules.

charges

List<ServiceCharge>

Charges for the service.

businessServices.operationSchedules.

charges.amount

Double

A monetary amount.

businessServices.operationSchedules.

charges.percent

Double

Fee percentage; if zero, assume use of the Amount attribute

(Amount or Percent must be a zero value).

businessServices.operationSchedules.

charges.currency

String

Currency code for the charge.

businessServices.operationSchedules.

charges.unitCode

String

This is the unit for which the charge applies (e.g. room, person, seat).

Refer to OpenTravel Code List Charge Type (CHG).

businessServices.operationSchedules.

charges.frequencyCode

String

This is the timeframe used to apply the charge during the course of the reservation (e.g. Daily, Weekly, Stay). Refer to OpenTravel Code List Charge Type (CHG).

meetingServices

List<Amenity>

List of meeting services available at the property.

meetingServices.id

String

Unique ID for the meeting service.

meetingServices.code

String

Refer to OpenTravel Code List property MeetingRoom Code (MRC).

meetingServices.detailLangs

List<I18N>

May be used to give further detail on the code.

meetingServices.included

Boolean

This may be used to identify a standard service included in the room rate.

meetingServices.proximityCode

String

Denotes whether a service is onsite, offsite or information is not available.

Refer to OpenTravel Code Table Proximity (PRX).

meetingServices.quantity

Integer

Denotes the total number of service items identified by the Code attribute.

meetingServices.operationSchedules

List<OperationSchedule>

Defines service availability, including operating dates, hours, and applicable fees.

meetingServices.operationSchedules.start

String

Start date.

Must follow the format yyyy-MM-dd (Year-Month-Day), e.g., 2023-11-22.

meetingServices.operationSchedules.end

String

End date.

Must follow the format yyyy-MM-dd (Year-Month-Day), e.g., 2023-11-22.

meetingServices.operationSchedules.

operationTimes

List<OperationTime>

List of operation times.

meetingServices.operationSchedules.

operationTimes.weekDay

String

Day of operation.

Enum: [ MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY ]

meetingServices.operationSchedules.

operationTimes.startTime

String

Start time.

Must follow the format HH:mm (Hour:Minute, 24-hour format), e.g., 10:22.

meetingServices.operationSchedules.

operationTimes.endTime

String

End time.

Must follow the format HH:mm (Hour:Minute, 24-hour format), e.g., 10:22.

meetingServices.operationSchedules.

charges

List<ServiceCharge>

Charges for the service.

meetingServices.operationSchedules.

charges.amount

Double

A monetary amount.

meetingServices.operationSchedules.

charges.percent

Double

Fee percentage; if zero, assume use of the Amount attribute

(Amount or Percent must be a zero value).

meetingServices.operationSchedules.

charges.currency

String

Currency code for the charge.

meetingServices.operationSchedules.

charges.unitCode

String

This is the unit for which the charge applies (e.g. room, person, seat).

Refer to OpenTravel Code List Charge Type (CHG).

meetingServices.operationSchedules.

charges.frequencyCode

String

This is the timeframe used to apply the charge during the course of the reservation (e.g. Daily, Weekly, Stay). Refer to OpenTravel Code List Charge Type (CHG).

mealServices

List<Amenity>

List of meals available at the property.

mealServices.id

String

Unique ID for the meal service.

mealServices.code

String

Refer to OpenTravel Code List property MealPlan Code (MPT).

mealServices.detailLangs

List<I18N>

May be used to give further detail on the code.

mealServices.included

Boolean

This may be used to identify a standard service included in the room rate.

mealServices.proximityCode

String

Denotes whether a service is onsite, offsite or information is not available.

Refer to OpenTravel Code Table Proximity (PRX).

mealServices.quantity

Integer

Denotes the total number of service items identified by the Code attribute.

mealServices.operationSchedules

List<OperationSchedule>

Defines service availability, including operating dates, hours, and applicable fees.

mealServices.operationSchedules.start

String

Start date.

Must follow the format yyyy-MM-dd (Year-Month-Day), e.g., 2023-11-22.

mealServices.operationSchedules.end

string

End date.

Must follow the format yyyy-MM-dd (Year-Month-Day), e.g., 2023-11-22.

mealServices.operationSchedules.

operationTimes

List<OperationTime>

List of operation times.

mealServices.operationSchedules.

operationTimes.weekDay

String

Day of operation.

Enum: [ MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY ]

mealServices.operationSchedules.

operationTimes.startTime

String

Start time.

Must follow the format HH:mm (Hour:Minute, 24-hour format), e.g., 10:22.

mealServices.operationSchedules.

operationTimes.endTime

String

End time.

Must follow the format HH:mm (Hour:Minute, 24-hour format), e.g., 10:22.

mealServices.operationSchedules.

charges

List<ServiceCharge>

Charges for the service.

mealServices.operationSchedules.

charges.amount

Double

A monetary amount.

mealServices.operationSchedules.

charges.percent

Double

Fee percentage; if zero, assume use of the Amount attribute

(Amount or Percent must be a zero value).

mealServices.operationSchedules.

charges.currency

String

Currency code for the charge.

mealServices.operationSchedules.

charges.unitCode

String

This is the unit for which the charge applies (e.g. room, person, seat).

Refer to OpenTravel Code List Charge Type (CHG).

mealServices.operationSchedules.

charges.frequencyCode

String

This is the timeframe used to apply the charge during the course of the reservation (e.g. Daily, Weekly, Stay). Refer to OpenTravel Code List Charge Type (CHG).

accessibleFeatures

List<Feature>

List of accessibility features available at the property.

accessibleFeatures.id

String

Unique ID for the accessibility feature.

accessibleFeatures.code

String

Refer to OpenTravel Code List Disability Feature Code (PHY).

accessibleFeatures.detailLangs

List<I18N>

May be used to give further detail on the code.

accessibleFeatures.quantity

Integer

This is the numeric value associated with the measurement.

accessibleFeatures.unit

String

Unit of measure code based on OpenTravel Unit of Measure Code (UOM).

accessibleFeatures.chargeCurrencyCode

String

Currency code for the charge.

accessibleFeatures.chargeAmount

Double

A monetary amount.

accessibleFeatures.descriptionLangs

List<I18N>

Descriptions of the accessibility feature in multiple languages.

securityFeatures

List<Feature>

List of security features available at the property.

securityFeatures.id

String

Unique ID for the security feature.

securityFeatures.code

String

Refer to OpenTravel Code List Security Feature Code (SEC).

securityFeatures.detailLangs

List<I18N>

May be used to give further detail on the code.

securityFeatures.quantity

Integer

This is the numeric value associated with the measurement.

securityFeatures.unit

String

Unit of measure code based on OpenTravel Unit of Measure Code (UOM).

securityFeatures.chargeCurrencyCode

String

Currency code for the charge.

securityFeatures.chargeAmount

Double

A monetary amount.

securityFeatures.descriptionLangs

List<I18N>

Descriptions of the security feature in multiple languages.

meetingRoomInformation

Object

<MeetingRoomInformation>

Information related to meeting rooms at the property.

total

Integer

Total number of meeting rooms available at the property.

totalRoomSpace

Double

Total room space provided at the property (grand ballroom counted as one).

totalSeatingCapacity

Total seating capacity available for meetings at the property.

largestRoomSpace

Double

Room space of the largest meeting room at the property.

smallestRoomSpace

Double

Room space of the smallest meeting room at the property.

largestSeatingCapacity

Integer

Largest seating capacity for the biggest meeting room, usually for theatre-style setups.

smallestSeatingCapacity

Integer

Smallest seating capacity for a meeting room.

unit

String

Unit of measure code based on OpenTravel Unit of Measure Code (UOM).

meetingRooms

List<MeetingRoom>

List of meeting rooms at the property.

meetingRooms.id

String

Unique identifier for the meeting room.

meetingRooms.nameLangs

List<I18N>

Names of the meeting room in multiple languages.

meetingRooms.dimension

Object

<MeetingRoomDimension>

Details on the dimensions of the meeting room.

meetingRooms.dimension.area

Integer

Area of the meeting room in square units.

meetingRooms.dimension.height

Integer

Height of the meeting room.

meetingRooms.dimension.length

Integer

Length of the meeting room.

meetingRooms.dimension.width

Integer

Width of the meeting room.

meetingRooms.dimension.unit

String

Unit of measure code based on OpenTravel Unit of Measure Code (UOM).

meetingRooms.capacities

List<MeetingRoomFormat>

Capacities for different types of setups in the meeting room (e.g., boardroom, theatre).

meetingRooms.capacities.formatCode

String

Defines the type of the meeting room being described (eg. boardroom, ballroom, exhibit space). Refer to OpenTravel Codelist Meeting Room Format Code (MRF).

meetingRooms.capacities.maxOccupancy

Integer

The total number of people permitted in the meeting room.

meetingRooms.services

List<MeetingRoomService>

Services available in the meeting room (e.g., projector, whiteboard).

meetingRooms.services.code

String

This is used to define items that may be available for any of the meeting rooms. Refer to OpenTravel Code List Meeting Room Code (MRC).

meetingRooms.services.detaillangs

List<I18N>

May be used to give further detail on the code.

meetingRooms.services.quantity

Integer

Used to define the quantity for an associated element or attribute.

meetingRooms.services.chargePercent

Double

Fee percentage; if zero, assume use of the Amount attribute (Amount or Percent must be a zero value).

meetingRooms.services.chargeAmount

Double

A monetary amount.

meetingRooms.services.

chargeCurrencyCode

String

meetingRooms.services.chargeUnitCode

String

This is the unit for which the charge applies (e.g. room, person, seat).

Refer to OpenTravel Code List Charge Type (CHG).

meetingRooms.services.

chargeFrequencyCode

String

This is the timeframe used to apply the charge during the course of the reservation (e.g. Daily, Weekly, Stay). Refer to OpenTravel Code List Charge Type (CHG).

meetingRooms.images

List<Image>

Collection of multimedia images.

meetingRooms.images.categoryCode

String

Image category. Refer to OpenTravel Picture Category Code (PIC).

meetingRooms.images.sort

Integer

Display order of images.

meetingRooms.images.sourceId

String

Unique ID of the image source (e.g., original file identifier).

meetingRooms.images.captionLangs

List<I18N>

Multilingual image captions.

meetingRooms.images.applicableStart

Date

Format: yyyy-MM-dd

Start date or recurring start period when the image is relevant (e.g., season start).

meetingRooms.images.applicableEnd

Date

Format: yyyy-MM-dd

End date or recurring end period when the image is relevant (e.g., season end).

meetingRooms.images.items

List<ImageItem>

List of image file variations.

meetingRooms.images.items.url

String

URL of the image.

meetingRooms.images.items.width

Integer

Image width (unit defined by UOM).

meetingRooms.images.items.height

Integer

Image height (unit defined by UOM).

meetingRooms.images.items.size

String

Image file size (e.g., MB, KB).

meetingRooms.images.items.unit

String

Unit of measurement. Refer to OpenTravel Unit of Measure (UOM).

meetingRooms.images.items.fileSize

Integer

File size in bytes.

meetingRooms.images.items.format

String

Image format (e.g., JPEG, PNG). Refer to OpenTravel Content Format Code (CFC).

restaurantInformation

Object<RestaurantInformation>

Information related to restaurants at the property.

total

Integer

Total number of restaurants at the property.

restaurants

List<Restaurant>

List of restaurants at the property.

restaurants.id

String

Unique identifier for the restaurant.

restaurants.nameLangs

List<I18N>

Names of the restaurant in multiple languages.

restaurants.descriptionLangs

List<I18N>

Descriptions of the restaurant in different languages.

restaurants.maxCapacity

Integer

Maximum seating capacity of the restaurant.

restaurants.proximityCode

String

Denotes whether a service is onsite, offsite or information is not available. Refer to OpenTravel Code Table Proximity (PRX).

restaurants.reservationsRequired

Boolean

If TRUE, a reservation must be made to dine in the restaurant.

restaurants.mealOffers

List<String>

Enum: [ BREAKFAST, LUNCH, DINNER, BRUNCH ]

restaurants.relativePosition

Object<RelativePosition>

Position details relative to the property or facility.

restaurants.relativePosition.direction

String

Defines the cardinal direction (e.g., north, south, southwest).

restaurants.relativePosition.distance

String

Defines the distance between two points.

restaurants.relativePosition.unit

String

Unit of measure code based on OpenTravel Unit of Measure Code (UOM).

restaurants.relativePosition.toFrom

String

Used to indicate whether the context is to a facility or from a facility.

restaurants.restaurantTypeCodes

List<RestaurantType>

Types of restaurant at the property.

restaurants.restaurantTypeCodes.code

String

Refer to OpenTravel Code List Restaurant Category (RES).

restaurants.restaurantTypeCodes.detailLangs

List<I18N>

May be used to give further detail on the code.

restaurants.cuisines

List<Cuisine>

Cuisine types offered by the restaurant.

restaurants.cuisines.code

String

Collection of cuisine types of restaurant. Refer to OpenTravel Code List Main Cuisine Code (CUI).

restaurants.cuisines.detailLangs

List<I18N>

May be used to give further detail on the code.

restaurants.cuisines.main

Boolean

Indicates whether this cuisine code is the main cuisine offered by restaurant.

restaurants.restaurantSchedules

RestaurantSchedule

Restaurant operating schedule details.

restaurants.restaurantSchedules.weekDay

String

Day of operation.

Enum: [ MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY ]

restaurants.restaurantSchedules.startTime

String

Start time.

Must follow the format HH:mm (Hour:Minute, 24-hour format), e.g., 10:22.

restaurants.restaurantSchedules.endTime

String

End time.

Must follow the format HH:mm (Hour:Minute, 24-hour format), e.g., 10:22.

restaurants.restaurantSchedules.

descriptionLangs

List<I18N>

Descriptions of the restaurant schedule in multiple languages.

restaurants.restaurantServices

List<RestaurantService>

List of services offered by the restaurant.

restaurants.restaurantServices.code

String

Refer to OpenTravel Code List Restaurant Srvc Info (RSI).

restaurants.restaurantServices.detailLangs

List<I18N>

May be used to give further detail on the code.

restaurants.images

List<Image>

Collection of multimedia images.

restaurants.images.categoryCode

String

Image category. Refer to OpenTravel Picture Category Code (PIC).

restaurants.images.sort

Integer

Display order of images.

restaurants.images.sourceId

String

Unique ID of the image source (e.g., original file identifier).

restaurants.images.captionLangs

List<I18N>

Multilingual image captions.

restaurants.images.applicableStart

Date

Format: yyyy-MM-dd

Start date or recurring start period when the image is relevant (e.g., season start).

restaurants.images.applicableEnd

Date

Format: yyyy-MM-dd

End date or recurring end period when the image is relevant (e.g., season end).

restaurants.images.items

List<ImageItem>

List of image file variations.

restaurants.images.items.url

String

URL of the image.

restaurants.images.items.width

Integer

Image width (unit defined by UOM).

restaurants.images.items.height

Integer

Image height (unit defined by UOM).

restaurants.images.items.size

String

Image file size (e.g., MB, KB).

restaurants.images.items.unit

String

Unit of measurement. Refer to OpenTravel Unit of Measure (UOM).

restaurants.images.items.fileSize

Integer

File size in bytes.

restaurants.images.items.format

String

Image format (e.g., JPEG, PNG). Refer to OpenTravel Content Format Code (CFC).

host

Object<Host>

[Vacation rental API fields]

Refers to the individual or entity providing accommodation services, typically the owner or operator of a house, apartment, or lodging establishment. The host is responsible for managing and offering the services needed by guests, ensuring a pleasant and smooth stay.

id

String

A unique identifier for the host.

name

String

The name of the host.

introductionLangs

List<I18N>

A description of the host.

jobLangs

List<I18N>

The host's occupation or role.

closeSeasons

List<CloseSeason>

List of close seasons for the property.

start

String

Start date.

Must follow the format yyyy-MM-dd (Year-Month-Day), e.g., 2023-11-22.

end

String

End date.

Must follow the format yyyy-MM-dd (Year-Month-Day), e.g., 2023-11-22.

loyaltyPrograms

List<LoyaltyProgram>

List of loyalty programs available for the property.

nameLangs

List<I18N>

This identifies the loyalty program.

travelSector

String

Used to identify the specific travel sector to which the loyalty program applies. Refer to OpenTravel Codelist Travel Sector (TVS).

refPoints

List<ReferencePoint>

List of reference points related to the property.

id

String

Unique ID for the reference point.

nameLangs

List<I18N>

This is used to accommodate a city name, rail station name etc. when using the indexPoint attribute.

descriptionLangs

List<I18N>

Descriptions of the reference point in different languages.

detailLangs

List<I18N>

Further details about the reference point.

indexPointCode

String

Refers to the object related to the reference point (e.g., cross street, airport). Refer to OpenTravel Code List (IPC).

categoryCode

String

Code for the type of reference point (e.g., landmark, station). Refer to OpenTravel Code List (REF).

direction

String

Defines the cardinal direction.

Enum: [ N, S, E, W, NE, NW, SE, SW ]

distance

String

Defines the distance between two points.

unit

String

Unit of measure code based on OpenTravel Unit of Measure Code (UOM).

countryCode

String

Country code (ISO format).

stateCode

String

State or province code.

cityCode

String

position

Object<Position>

Position details for the reference point.

position.latitude

String

The measure of the angular distance on a meridian north or south of the equator.

position.longitude

String

The measure of the angular distance on a meridian east or west of the prime meridian.

position.positionAccuracyCode

String

Accuracy of the geo-coding for the reference point. Refer to OpenTravel Code List Position Accuracy Code (PAC).

nearest

Boolean

The indicator for whether this location is nearest.

primary

Boolean

Indicates whether the reference point is considered the main reference point for the specific type of IndexPointCode (e.g., in Dallas, where IndexPointCode=airport Dallas/Fort Worth airport would be the primary airport even if another airport such as Love Field is closer).

sort

String

Defines the display order of the reference points.

toFrom

String

Used to indicate whether the context is to a facility or from a facility.

transportations

List

<ReferencePointTransportation>

Collection of directions to/from a specific location via various modes of transportation.Defines the type of transportation offered.

transportations.code

String

This attribute is used to explicitly define whether the type of transportation applies. Refer to OpenTravel Code list Option Type Code (OTC).

transportations.chargeUnitCode

String

This is the unit for which the charge applies (e.g. room, person, seat).

Refer to OpenTravel Code List Charge Type (CHG).

transportations.chargeFrequencyCode

String

This is the timeframe used to apply the charge during the course of the reservation (e.g. Daily, Weekly, Stay). Refer to OpenTravel Code List Charge Type (CHG).

transportations.chargeAmount

String

transportations.currencyCode

String

Currency code for the charge.

transportations.included

Boolean

When true there is no additional charge for transportation.

transportations.descriptionLangs

List<I18N>

transportations.detailLangs

List<I18N>

transportations.Schedules

List<OperationSchedule>

Defines service availability, including operating dates, hours, and applicable fees.

transportations.Schedules.start

String

Start date.

Must follow the format yyyy-MM-dd (Year-Month-Day), e.g., 2023-11-22.

transportations.Schedules.end

String

End date.

Must follow the format yyyy-MM-dd (Year-Month-Day), e.g., 2023-11-22.

transportations.Schedules.

operationTimes

List<OperationTime>

List of operation times.

transportations.Schedules.

operationTimes.weekDay

String

Day of operation.

Enum: [ MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY ]

transportations.Schedules.

operationTimes.startTime

String

Start time.

Must follow the format HH:mm (Hour:Minute, 24-hour format), e.g., 10:22.

transportations.Schedules.

operationTimes.endTime

String

End time.

Must follow the format HH:mm (Hour:Minute, 24-hour format), e.g., 10:22.

attractions

List<Attraction>

List of attractions near the property.

id

String

Unique identifier for the attraction.

categoryCode

String

The code for the type of attraction in the proximity of the hotel facility. Refer to OpenTravel Code List Attraction Category Code (ACC).

nameLangs

List<I18N>

Multilingual names of the attraction.

detailLangs

List<I18N>

May be used to give further detail on the code.

descriptionLangs

List<I18N>

Multilingual descriptions of the attraction.

proximityCode

String

Indicates if the attraction is onsite, offsite, or unavailable. Refer to OpenTravel Code Table Proximity (PRX).

applicableStart

String

Start date.

applicableEnd

String

End date.

Url

String

The URL for contacting the attraction.

tags

List<AttractionTag>

Tags related to the attraction for categorization or filtering.

tags.textLangs

List<I18N>

Descriptions of the attraction tags in different languages.

refPoints

List<RefPoint>

Reference points for the attraction's location.

refPoints.countryCode

String

Country code (ISO format).

refPoints.stateCode

String

State or province code.

refPoints.direction

String

Defines the cardinal direction (e.g., north, south, southwest).

refPoints.distance

String

Defines the distance between two points.

refPoints.unit

String

Unit of measure code based on OpenTravel Unit of Measure Code (UOM).

refPoints.position

Object<Position>

Position details for the reference point.

refPoints.position.latitude

String

Latitude of the reference point.

refPoints.position.longitude

String

Longitude of the reference point.

refPoints.position.positionAccuracyCode

String

Accuracy of the geo-coding for the reference point. Refer to OpenTravel Code List Position Accuracy Code (PAC).

recreations

List<Recreation>

List of recreation services.

id

String

Unique ID for the recreation.

serviceCode

String

Refer to OpenTravel Code List Recreation Srvc Type (RST).

nameLangs

List<I18N>

The name of the recreation.

detailLangs

List<I18N>

May be used to give further detail on the code.

descriptionLangs

List<I18N>

Descriptions of the recreation in different languages.

proximityCode

String

Indicates if the recreation is onsite, offsite, or unknown. Refer to OpenTravel Proximity (PRX).

included

Boolean

If TRUE, this recreation is included with basic room rates.

Schedules

List<OperationSchedule>

Defines service availability, including operating dates, hours, and applicable fees.

Schedules.start

String

Start date.

Must follow the format yyyy-MM-dd (Year-Month-Day), e.g., 2023-11-22.

Schedules.end

String

End date.

Must follow the format yyyy-MM-dd (Year-Month-Day), e.g., 2023-11-22.

Schedules.operationTimes

List<OperationTime>

List of operation times.

Schedules.operationTimes.

weekDay

String

Day of operation.

Enum: [ MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY ]

Schedules.operationTimes.

startTime

String

Start time.

Must follow the format HH:mm (Hour:Minute, 24-hour format), e.g., 10:22.

Schedules.operationTimes.

endTime

String

End time.

Must follow the format HH:mm (Hour:Minute, 24-hour format), e.g., 10:22.

Schedules.charges

List<ServiceCharge>

Charges for the recreation.

Schedules.charges.amount

Double

Fixed fee amount.

Schedules.charges.currency

String

Currency code for the charge.

Schedules.charges.unitCode

String

Charge unit. Refer to OpenTravel Charge Type (CHG).

Schedules.charges.

frequencyCode

String

This is the timeframe used to apply the charge during the course of the reservation (e.g. Daily, Weekly, Stay). Refer to OpenTravel Code List Charge Type (CHG).

services.code

String

Refer to OpenTravel Code List Recreation Srvc Detail Code (REC).

services.detailLangs

List<I18N>

May be used to give further detail on the code.

services.descriptionLangs

List<I18N>

Multilingual description of the service.

additionalDescriptions

List<AltDescription>

A collection of additional descriptive details for the property.

id

String

Unique identifier for the description.

additionalDetailCode

String

Refer to OpenTravel Code List Additional Detail Type (ADT).

recordId

String

Uniquely identifies this file in the message.

sourceId

String

Unique ID for the source of the description.

title

String

Title of the TextItem description.

descriptionLangs

List<I18N>

Text item description.

applicableStart

String

Start date.

Must follow the format yyyy-MM-dd (Year-Month-Day), e.g., 2023-11-22.

applicableEnd

String

End date.

Must follow the format yyyy-MM-dd (Year-Month-Day), e.g., 2023-11-22.

promotions

List<Promotion>

List of property promotions or packages.

category

String

Indicates whether it is a package or a promotion.

Enum: [ PACKAGE, PROMOTION ]

code

String

Unique identifier for the promotion or package.

packageTypeCode

String

Type of package or promotion. Refer to OpenTravel Package Type (PKG).

titleLangs

List<I18N>

Multilingual title of the package or promotion.

descriptionLangs

List<I18N>

Multilingual description of the package or promotion.

minLos

Integer

Minimum length of stay (in days) required for the promotion.

sort

Integer

Display order of the promotion.

schedules

List<PromotionSchedule>

List of schedule-based validity periods.

schedules.weekDay

String

Day of operation.

Enum: [ MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY ]

schedules.start

String

Start time.

Must follow the format HH:mm (Hour:Minute, 24-hour format), e.g., 10:22.

schedules.end

String

End time.

Must follow the format HH:mm (Hour:Minute, 24-hour format), e.g., 10:22.

policyInformation

Object<PolicyInformation>

Contains details about the property's policies.

propertyPolicy

Object<PropertyPolicy>

Contains specific policies for the property.

propertyPolicy.checkInTimeFrom

String

 [Vacation rental API fields]

Earliest check-in time (e.g., "14:00").

propertyPolicy.checkInTimeUntil

String

 [Vacation rental API fields]

Latest check-in time (e.g., "22:00").

propertyPolicy.checkOutTimeFrom

String

Earliest check-out time (e.g., "08:00").

propertyPolicy.checkOutTimeUtil

String

Latest check-out time (e.g., "12:00").

propertyPolicy.acceptedGuestType

String

Types of guest accepted: AdultOnly, CouplesOnly.

Enum: [ ADULT_ONLY, COUPLES_ONLY ]

propertyPolicy.

roomGuaranteedLateArrival

Boolean

If true, the property guarantees the room for late arrival.

propertyPolicy.descriptionLangs

List<I18N>

Multilingual policy descriptions.

propertyPolicy.petsAllowed

String

Specifies at a high level the pet policy at the hotel.

Enum: [ PETS_ALLOWED, PETS_NOT_ALLOWED, ASSISTIVE_ANIMALS_ONLY, PETS_BY_ARRANGEMENTS, PETS_FOR_FREE ]

childPolicy

Object<ChildPolicy>

Contains details about the property's children policy.

childPolicy.minGuestAge

Integer

The minimum guest age allowed for a guest at the hotel facility.

childPolicy.maxChildAge

Integer

The maximum age for a child price.

childPolicy.freeCutOffAge

Integer

The usual age limit at which a child can stay free with an adult at the property facility. If this value is not set, then there is no cutoff limit.

childPolicy.freeChildPerAdult

Integer

The usual number of children meeting the UsualStayFreeCutoffAge allowed to stay free with an adult at the property. If this value is not set, then there is no cutoff limit.

childPolicy.kidsStayFree

Boolean

If true there is no charge for children.

checkInPolicy

Object<CheckinPolicy>

 [Vacation rental API fields]

Contains details about the property's check-in policy.

checkInPolicy.category

String

 [Vacation rental API fields]

Specifies the type of check-in offered by the host. Supported values: doorman_entry, lockbox, smartlock, keypad, host_checkin, other_checkin.

checkInPolicy.instructionLangs

List<I18N>

 [Vacation rental API fields]

Instructions for guests on how to check in. These details are only shared with confirmed guests.

checkOutPolicy

Object<CheckOutPolicy>

Contains details related to the property's check-out policy.

checkOutPolicy.type

String

Number of nights used to calculate fees.

Enum: [ EARLY, LATE ]

checkOutPolicy.chargeNights

Integer

The fixed monetary amount charged.

checkOutPolicy.chargeAmount

Double

Percentage of the total stay amount charged as a fee.

checkOutPolicy.chargePercent

Double

The percentage of the total stay amount charged for early check-in or late checkout.

checkOutPolicy.currencyCode

String

Currency code for the charge.

checkOutPolicy.balanceOfStay

Boolean

If true, the charge for early checkout is equivalent to the cost of the remaining nights in the original reservation.

checkOutPolicy.descriptionLangs

List<I18N>

Multilingual policy descriptions.

commissionPolicy

Object<CommissionPolicy>

Contains details about the property's commission policy.

commissionPolicy.amount

Double

The fixed monetary amount of the commission fee.

commissionPolicy.percent

Double

The commission fee as a percentage. If 0, the amount attribute is used instead (either amount or percent must be set to 0).

commissionPolicy.currencyCode

String

Currency code for the charge.

commissionPolicy.paymentCompanyLangs

List<I18N>

The name of the company processing the commission payment for the property.

commissionPolicy.descriptionLangs

List<I18N>

Multilingual policy descriptions.

generalPolicies

List<GeneralPolicy>

A list of general policies applicable to the property.

generalPolicies.nameLangs

List<I18N>

The localized name of the general policy.

generalPolicies.descriptionLangs

List<I18N>

Multilingual policy descriptions.

cancelPolicies

List<CancelPolicy>

A list of cancellation policies that apply to the property.

cancelPolicies.code

String

A unique identifier for the cancellation policy.

cancelPolicies.nonRefundable

Boolean

Indicates whether the reservation is non-refundable. If true, a 100% penalty on the prepayment is applied, regardless of the cancellation deadline.

cancelPolicies.roomTypeCode

String

A system specific room type to which this cancellation penalty applies.

cancelPolicies.cancelPenalty

Object<CancelPenalty>

Defines the penalty details for cancellations under this policy.

cancelPolicies.cancelPenalty.

taxInclusive

Boolean

Indicates whether taxes are included when figuring the base amount.

cancelPolicies.cancelPenalty.

feeInclusive

Boolean

Indicates whether fees are included when calculating the penalty amount.

cancelPolicies.cancelPenalty.

chargeNights

Integer

The number of nights used to calculate the cancellation fee.

cancelPolicies.cancelPenalty.

chargeAmount

Double

The fixed monetary amount charged as a cancellation fee.

cancelPolicies.cancelPenalty.

chargePercent

Double

The percentage of the total stay amount used to calculate the cancellation fee.

cancelPolicies.cancelPenalty.

currencyCode

String

Currency code for the charge.

cancelPolicies.cancelPenalty.

descriptionLang

List<I18N>

Multilingual policy descriptions.

cancelPolicies.cancelDeadline

Object<CancelDeadline>

Defines the deadline for cancellations before penalties apply.

cancelPolicies.cancelDeadline.

absoluteDeadline

String

Defines the absolute deadline. Either this or the offset attributes may be used.

cancelPolicies.cancelDeadline.

offsetTimeUnit

String

The units of time.

Enum: [ YEAR, MONTH, WEEK, DAY, HOUR, MINUTE, SECOND, FULL_DURATION ]

cancelPolicies.cancelDeadline.

offsetUnitMultiplier

Integer

The number of units of DeadlineTimeUnit.

cancelPolicies.cancelDeadline.

offsetDropTimeType

String

Indicates when the deadline takes effect.

Enum: [ BEFORE_ARRIVAL, AFTER_ARRIVAL, AFTER_BOOKING, AFTER_CONFIRMATION, AFTER_DEPARTURE ]

cancelPolicies.schedules

List<CancelPolicySchedule>

A list of schedule-based cancellation policies that apply on specific days or date ranges.

cancelPolicies.schedules.weekDay

String

Day of operation.

Enum: [ MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY ]

cancelPolicies.schedules.start

String

Start time.

Must follow the format HH:mm (Hour:Minute, 24-hour format), e.g., 10:22.

cancelPolicies.schedules.end

String

End time.

Must follow the format HH:mm (Hour:Minute, 24-hour format), e.g., 10:22.

guaranteePaymentPolicies

List<GuaranteePaymentPolicy>

List of guarantee and payment policies.

guaranteePaymentPolicies.code

String

Unique identifier for the policy.

guaranteePaymentPolicies.type

String

Type of guarantee or payment policy.

Enum: [ REQUIRED_PAYMENT, GUARANTEE_POLICY, ACCEPTED_PAYMENT_FORMS ]

guaranteePaymentPolicies.

retributionType

String

Type of action taken when guarantee deadline has been exceeded.

Enum: [ RES_AUTO_CANCELLED, RES_NOT_CANCELLED ]

guaranteePaymentPolicies.

guaranteeType

String

GuaranteeType: GuaranteeType An enumerated type defining the guarantee to be applied to this reservation.

Enum: [ GUARANTEE_REQUIRED, CC_DC_VOUCHER, PROFILE, DEPOSIT, PREPAY, NONE ]

guaranteePaymentPolicies.

roomTypeCode

String

Room type applicable to this policy.

guaranteePaymentPolicies.

nonRefundable

Boolean

If true, prepayments are non-refundable, and a 100% penalty applies regardless of the deadline.

guaranteePaymentPolicies.

holdTime

String

The room will held up until this time without a guarantee.

guaranteePaymentPolicies.

offsetTimeUnit

String

The units of time.

Enum: [ YEAR, MONTH, WEEK, DAY, HOUR, MINUTE, SECOND, FULL_DURATION ]

guaranteePaymentPolicies.

offsetUnitMultiplier

Integer

The number of units of DeadlineTimeUnit.

guaranteePaymentPolicies

.offsetDropTimeType

String

Indicates when the deadline takes effect.

Enum: [ BEFORE_ARRIVAL, AFTER_ARRIVAL, AFTER_BOOKING, AFTER_CONFIRMATION, AFTER_DEPARTURE ]

guaranteePaymentPolicies.

chargeNights

Integer

Number of nights used to calculate fees.

guaranteePaymentPolicies.

chargeAmount

Double

The fixed monetary amount charged.

guaranteePaymentPolicies.

chargePercent

Double

Percentage of the total stay amount charged as a fee.

guaranteePaymentPolicies.

currencyCode

String

Currency code for the charge.

guaranteePaymentPolicies.

descriptions

List<GuaranteePayment

PolicyDescription>

Descriptions of the policy.

guaranteePaymentPolicies.

descriptions.descriptionLangs

List<I18N>

Multilingual policy descriptions.

guaranteePaymentPolicies.

schedule

List<GuaranteePayment

PolicySchedule>

Policy schedule based on specific days or date ranges.

guaranteePaymentPolicies.

schedule.weekDay

String

Day of operation.

Enum: [ MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY ]

guaranteePaymentPolicies.

schedule.start

String

Start time.

Must follow the format HH:mm (Hour:Minute, 24-hour format), e.g., 10:22.

guaranteePaymentPolicies.

schedule.end

String

End time.

Must follow the format HH:mm (Hour:Minute, 24-hour format), e.g., 10:22.

guaranteePaymentPolicies.

acceptedPayments

List<AcceptedPayment

Accepted payment and guarantee methods.

guaranteePaymentPolicies.

acceptedPayments.guarantee

Boolean

If true, this represents a guarantee rather than a payment method.

guaranteePaymentPolicies.

acceptedPayments.paymentTypeCode

String

AmericanExpress, BritishAirways,CarteBlanche, ChinaUnionPay, UnionCredit, ContinentalAirlines, DeltaAirlines, DinersClub, DiscoverCard, Disney, Eurocard, Forbrugsforeningskort, Hilton, Hyatt, JapanCreditBureau, Maestro, Marriott, Mastercard, RitzCarlton, SouthwestAirlines, StarwoodHotels, UnitedAirlines, USAirways, VISA

guaranteePaymentPolicies.

acceptedPayments.cardTypeCode

String

Type of payment card.

guaranteePaymentPolicies.

acceptedPayments.cardTypeDescriptionLangs

List<I18N>

Multilingual card type descriptions.

guaranteePaymentPolicies.addresses

Payment recipient and address details.

guaranteePaymentPolicies.

addresses.paymentReceiverName

String

Name of payment recipient.

guaranteePaymentPolicies.

addresses.useTypeCode

String

Address purpose (e.g., billing, delivery) based on OpenTravel Code List Address Use Type (AUT).

guaranteePaymentPolicies.

addresses.postalCode

String

Post Office Code number.

guaranteePaymentPolicies.

addresses.countryCode

String

Country code (ISO format).

guaranteePaymentPolicies.

addresses.stateCode

String

State or province code.

guaranteePaymentPolicies.

addresses.streetNumberPoBox

String

May contain the street number and optionally the street name.

guaranteePaymentPolicies.

addresses.countryNameLangs

List<I18N>

Country name (e.g., Ireland).The name or code of a country (e.g. as used in an address or to specify citizenship of a traveller).

guaranteePaymentPolicies.

addresses.stateNameLangs

List<I18N>

State or Province name (e.g., Texas).State, province, or region name or code needed to identify location.

guaranteePaymentPolicies.

addresses.cityNameLangs

List<I18N>

City (e.g., Dublin), town, or postal station (i.e., a postal service territory, often used in a military address).

guaranteePaymentPolicies.

addresses.addressLines

List<AddressLine>

List of address lines (e.g., street, suite).

guaranteePaymentPolicies.addresses

.addressLines.addressLineLangs

List<I18N>

Multilingual address line descriptions.

petPolicies

List<PetPolicy>

List of pet policies.

petPolicies.code

String

Pet policy code from OpenTravel Code Table (PET).

petPolicies.unit

String

Unit of measure code based on OpenTravel Unit of Measure Code (UOM).

petPolicies.quantity

Integer

This is the numeric value associated with the measurement.

petPolicies.maxPetQuantity

Integer

Maximum number of pets allowed (0-99).

petPolicies.refundableDeposit

Double

Refundable deposit amount for pet stays.

petPolicies.nonRefundableFee

Double

Specifies the charge associated with a pet staying in the room.

petPolicies.chargeUnitCode

String

Charge unit code. Refer to OpenTravel Charge Type (CHG).

petPolicies.currencyCode

String

Currency code for the charge.

petPolicies.restriction

Boolean

If true, there are restrictions on pet policies; if false, no restrictions apply.

petPolicies.descriptionLangs

List<I18N>

Multilingual policy descriptions.

taxPolicies

List<TaxPolicy>

List of applicable taxes.

taxPolicies.type

String

Enum: [ INCLUSIVE, EXCLUSIVE, CUMULATIVE ]

taxPolicies.code

String

Tax code (e.g., agency fee, municipality fee). Refer to OpenTravel Fee Tax Type (FTT).

taxPolicies.chargeAmount

Double

The fixed monetary amount charged.

taxPolicies.chargePercent

Double

Percentage of the total stay amount charged as a fee.

taxPolicies.currencyCode

String

Currency code for the charge.

taxPolicies.effectiveDate

String

Starting date of the policy

taxPolicies.expireDate

String

Ending date of the policy

taxPolicies.chargeUnitCode

String

Charge unit code. Refer to OpenTravel Charge Type (CHG).

taxPolicies.chargeFrequencyCode

String

Frequency of tax application (e.g., Daily, Weekly, Stay). Refer to OpenTravel Charge Type (CHG).

taxPolicies.sort

Integer

Used to define the display order.

taxPolicies.descriptionLangs

List<I18N>

Multilingual policy descriptions.

feePolicies

List<FeePolicy>

List of applicable fees.

feePolicies.type

String

Enum: [ INCLUSIVE, EXCLUSIVE, CUMULATIVE ]

feePolicies.code

String

Fee code (e.g., agency fee, municipality fee). Refer to OpenTravel Fee Tax Type (FTT).

feePolicies.chargeAmount

Double

The fixed monetary amount charged.

feePolicies.chargePercent

Double

Percentage of the total stay amount charged as a fee.

feePolicies.currencyCode

String

Currency code for the charge.

feePolicies.effectiveDate

String

Starting date of the policy

feePolicies.expireDate

String

Ending date of the policy

feePolicies.mandatory

Boolean

If true, the fee is mandatory; otherwise, it is optional.

feePolicies.chargeUnitCode

String

Charge unit code. Refer to OpenTravel Charge Type (CHG).

feePolicies.chargeFrequencyCode

String

Frequency of tax application (e.g., Daily, Weekly, Stay). Refer to OpenTravel Charge Type (CHG).

feePolicies.taxableIndicator

Boolean

If true, the fee is subject to tax.

feePolicies.descriptionLangs

List<I18N>

Multilingual policy descriptions.

ratePolicies

List<RatePolicy>

ratePolicies.corporateIdRequired

Boolean

If true, a corporate ID is required to book a corporate rate.

ratePolicies.type

String

Type of rate policy.

Enum: [ GOVERNMENT, NEGOTIATED, PREFERRED, OTHER ]

ratePolicies.identifyRequired

Boolean

If true, an ID is required at check-in.

ratePolicies.guestTypeCode

String

Guest type(s) applicable to the policy. Use values from OpenTravel property Guest Type (GUE) code list.

ratePolicies.minRoomNightCommitment

Integer

Minimum number of nights required to qualify for the rate.

ratePolicies.rateOfferTypeCode

String

Specifies an alternate rate plan type. Refer to OpenTravel Rate Plan Type (RPT) code list.

ratePolicies.descriptions

List<RatePolicyDescription>

Descriptions of the policy.

ratePolicies.descriptions.nameLangs

List<I18N>

Multilingual policy names.

ratePolicies.descriptions.descriptionLangs

List<I18N>

Multilingual policy descriptions.

otherProperties

List<OtherProperty>

Collection of nearby or related properties.

propertyCode

String

Unique code identifying a competitor property.

propertyName

List<I18N>

Multilingual property name.

chainCode

String

Code identifying the property's chain.

brandCode

String

Code identifying the property's brand.

segmentCode

String

Segment classification of the property.

contextCode

String

Identifies the context of the data.

competitor

Boolean

If true, the property is considered a competitor.

propertyMappings

List<PropertyMapping>

Collection of property channel codes.

sourceCode

String

Identifies the source of the data.

sourceName

String

Name of the source system.

sourceType

String

Type of source system.

Enum: [ GDS, CRS, OTA, WHOLESALER, TOUR_OPERATOR, TECHNICAL_PLATFORM, OTHER ]

propertyCode

String

Unique code for the property in the source system.

chainCode

String

Code identifying the property's chain.

propertyName

List<I18N>

Multilingual property name.

propertyShortName

List<I18N>

Multilingual short name of the property.

environmentImpact

Object<EnvironmentImpact>

Environmental sustainability details.

carbonFootprint

Object<CarbonFootprint>

Carbon dioxide emissions data.

carbonFootprint.meetingEvent

Integer

CO₂ emissions (in pounds) for meetings/events.

carbonFootprint.roomNight

Integer

CO₂ emissions (in pounds) per room night.

carbonFootprint.weatherNormalized

Integer

Weather-normalized CO₂ emissions (in pounds).

carbonFootprint.unit

String

Unit of measurement for carbon footprint.

water

Object<Water>

Water usage and conservation details.

water.grayWater

Boolean

Indicates if grey water recycling is used.

water.waterProgram

Boolean

Indicates if a water conservation program is in place.

water.perRoomNightUsage

Integer

Water consumption per room per night.

water.perRoomDayUsage

Integer

Water consumption per room per day.

water.wasteDiversionPercentage

Integer

Waste diversion rate as a percentage.

water.unit

String

Unit of measurement for water usage.

water.descriptionLangs

List<I18N>

Multilingual description of water conservation efforts.

energy

Object<Energy>

Energy efficiency and renewable energy details.

energy.efficientAppliances

Boolean

Indicates the use of energy-efficient appliances.

energy.efficientLighting

Boolean

Indicates if energy-efficient lighting is used.

energy.heatPowerComb

Boolean

Indicates if combined heat and power units are used.

energy.heatPump

Boolean

Indicates if heat pumps are in use.

energy.powerSavingPolicy

Boolean

Indicates if a power-saving policy is implemented.

energy.solar

Boolean

Indicates if solar energy is used.

energy.temperatureControl

Boolean

Indicates if temperature control measures are in place.

energy.windTurbine

Boolean

Indicates if wind turbines are used.

energy.energyGenerated

Integer

Amount of renewable energy generated (kilowatts).

energy.energyStarRating

String

Energy Star rating of the property.

energy.energyUsages

List<EnergyUsage>

Breakdown of energy consumption.

energy.energyUsages.powerType

String

Type of energy used.

Enum: [ DIESEL, ELECTRIC, GAS, OIL, SOLAR, DIESEL_FOR_EMERGENCY, PETROL_FOR_EMERGENCY, OTHER ]

energy.energyUsages.unit

String

Unit of measurement for energy consumption.

energy.energyUsages.quantity

Integer

Amount of energy consumed.

energy.energyUsages.descriptionLangs

List<I18N>

Multilingual description of energy programs.

recycling

Object<Recycling>

Recycling and waste reduction efforts.

recycling.activeProgram

Boolean

Indicates if a recycling program is active.

recycling.ecologicalDishware

Boolean

Indicates the use of non-disposable dishware.

recycling.descriptionLangs

List<I18N>

Multilingual description of the recycling program.

environmentGeneral

Object<EnvironmentGeneral>

General environmental sustainability policies.

environmentGeneral.certificationAvail

Boolean

Indicates if environmental certifications are available.

environmentGeneral.chemicalAllergies

Boolean

Indicates if the property accommodates guests with chemical sensitivities.

environmentGeneral.environmentalCleaner

Boolean

Indicates if environmentally friendly cleaning products are used.

environmentGeneral.linenReuse

Boolean

Indicates if a linen reuse program is in place.

environmentGeneral.procurementPolicy

Boolean

Indicates if the property has a sustainable procurement policy.

environmentGeneral.certifications

List<Certification>

List of environmental certifications obtained.

environmentGeneral.

certifications.nameLangs

Multilingual certification names.

environmentGeneral.environmentals

List<Environment>

Additional environmental policies.

environmentGeneral.

environmentals.nameLangs

List<I18N>

Multilingual names of environmental policies.

environmentGeneral.

environmentals.descriptionLangs

List<I18N>

Multilingual descriptions of environmental policies.

viewerShips

List<ViewerShip>

List of property distribution channels.

distributorCode

String

Unique code identifying the distributor.

distributorTypeCode

String

Code representing the type of distributor.

descriptionLangs

List<I18N>

Multilingual description of the distributor.

images

List<Image>

Collection of multimedia images.

categoryCode

String

Image category. Refer to OpenTravel Picture Category Code (PIC).

sort

Integer

Display order of images.

sourceId

String

Unique ID of the image source (e.g., original file identifier).

captionLangs

List<I18N>

Multilingual image captions.

applicableStart

Date

Format: yyyy-MM-dd

Start date or recurring start period when the image is relevant (e.g., season start).

applicableEnd

Date

Format: yyyy-MM-dd

End date or recurring end period when the image is relevant (e.g., season end).

items

List<ImageItem>

List of image file variations.

items.url

String

URL of the image.

items.width

Integer

Image width (unit defined by UOM).

items.height

Integer

Image height (unit defined by UOM).

items.size

String

Image file size (e.g., MB, KB).

items.unit

String

Unit of measurement. Refer to OpenTravel Unit of Measure (UOM).

items.fileSize

Integer

File size in bytes.

items.formatCode

String

Image format (e.g., JPEG, PNG). Refer to OpenTravel Content Format Code (CFC).

items.resolution

Integer

Image resolution in DPI (Dots Per Inch).

items.recordId

String

Unique identifier for this image record.

contextCode

string

Context Code in DerbySoft's system.

DERBYDEMO

supplierCode

string

Supplier Code in DerbySoft's system.

DERBYDEMO

propertyCode

string

Property code provided by content suppliers, only the following characters are allowed.

1. Digits (0-9) 

2. Uppercase letters (A-Z) 

3. Hyphen ('-')

BONITAPROPERTY

operateStatus

String

Indicates the operational status of the property.

Enum: [ ENABLED, PAUSED ]

ENABLED