ReferenceProperty API

Revision history

Property API online documentation will only be maintained for the latest available version. When a new version is published, the documentation will only reflect the latest version of the API.

The following updates have been made to the Property API, from newest to oldest updates:

November 28, 2023

Updated the enumerations list with new tattoo restrictions.

March 24, 2023

Updating PET_POLICY notes to reflect the legal guidelines.

March 15, 2023

Updated the enumerations list to include accessibility attributes.

March 04, 2023

Update languages spoken section to take out CHINESE and replace it with MANDARIN and CANTONESE.

November 03, 2022

Deprecated freeform text paragraphs in Property API. We strongly recommend the use of structured attributes to ensure important information is surfaced appropriately.

August 26, 2022

Documentation has been updated to move the following amenities from Mandatory fees to Policies. They were moved because they would not sync in our system when sent as mandatory fees.

  • NO_CLEANING_FEE
  • CLEANING_FEE_IN_RATE
  • CLUB_CARD_FEE_IN_RATE
  • DESTINATION_FEE_IN_RATE
  • FACILITIES_FEE_IN_RATE
  • NO_RESORT_FEE
  • TRANSFER_FEE_IN_RATE
  • SANITATION_FEE_IN_RATE
  • TOWELS_SHEETS_FEE_IN_RATE
  • UTILITY_FEE_IN_RATE
  • SEASONAL_HEATING_IN_RATE

In addition, CLEANING_FEES_OPTIONAL_AMOUNT_VARIES_BY_UNIT was moved from Optional fees to Policies.

The following parking codes were missing from the documentation and have been added to Property amenities, under "Parking and transportation amenities":

  • VALET_PARKING (FREE)
  • NO_ELECTRIC_CAR_CHARGING_STATION

Finally, the documentation was updated to indicate that partners must send PET_FEE + scope + duration, if a surcharge must be displayed. See the "Other policies in effect at a property" section of Policies.

April 20, 2021

Added MOBILE_HOME to the Enumeration list of supported structure type.

January 25, 2021
  • Added enumerations under Property API Policy section to support ONLINE_REGISTRATION_REQUIRED_BEFORE_ARRIVAL, GOVERNMENT_ISSUED_ID_REQUIRED_BEFORE_ARRIVAL and PASSPORT_COPY_REQUIRED_BEFORE_ARRIVAL.
  • Added CLEANING_FEE_OPTIONAL enumeration under Property API Optional Fees section to support Optional Cleaning Fees.
  • Added STROLLER enumeration under Property API Property Amenities.
September 14, 2021

Added enumerations to support bulk media scraping.

March 18, 2021

Added additional amenities under Enhanced Cleaning and Traveler Safety.

March 05, 2021

Added warning codes under Error handling section.

November 19, 2020

Added SKI_STORAGE amenity code to Skiing and snow activities section of Enumerations.

October 7, 2020
  • Removed fax as notification channel. LCAM team reached out to partners regarding this change. This just needed partner documentation update.
  • Moved Breakfast DetailCodes, which need start and end time added to Policies section.
August 14, 2020

Changed POOL_CHILDRENS to CHILDRENS_POOL.

July 8, 2020

Deprecated NO_DATE_RANGE detailCode for CLOSURE_ONE and RENOVATION_ONE codes. Added PERCENTAGE_PER_STAY duration to be used with PERCENTAGE_PER_ACCOMMODATION scope for CLEANING_FEE code.

June 16, 2020

Added additional detail codes for FORMS_OF_PAYMENT_ACCEPTED code under Policy Section.

June 15, 2020

Added additional Fee codes under Mandatory Fees section.

June 10, 2020

Moved Fee codes with no values under Fee Inclusive / Excluded section. Made Fee Inclusive / Excluded a sub-section under Policies.

June 2, 2020

Added Enhanced Cleaning and Traveler Safety codes under Policy Section.

May 22, 2020

Added more detail to error messages returned during property status GET request on the Code Lists page.

April 29, 2020

Removed view_* amenity codes from Property API, as they are used in Product API. Added text to clarify values for SPA_TUB with detail code MULTIPLE.

April 24, 2020

Made changes to ROOM_COFFEE_TEA_MAKER, ROOM_ESPRESSO_MAKER, ROOM_ELECTRIC_KETTLE, and THEME_SHOPPING_PROPERTY in the Appliances and other room features and Property theme sections.

April 7, 2020

Updated CUISINE_INDONESIAN typo in RESTAURANT_TWO, THREE, FOUR and FIVE in the Restaurant specifics section.

April 1, 2020

Removed SURCHARGE_AMT from Optional Fees section in Enumerations.

March 31, 2020

Made changes to DEPOSIT and PERCENTAGE_ DURATION in Mandatory Fees section of Enumerations.

March 26, 2020

Updated the Mandatory Fees section to remove Amount or Surcharge_Amount. Updated DATE attributes to retrieve the correct format of START_DATE and END_DATE. Updated new Image Subcategories for Accessibility, Room Facilities and Property Exterior sections in Enumerations.

January 30, 2020

Removed Registrations section. isVacationRental is now the only field sent within Property API while the majority of regulatory information will be captured at the unit level within Product API under the regulatoryRecords section.

December 12, 2019

Added support of new "cash only" form of payment in Payment information section of Enumerations.

December 2, 2019

Added additional self check-in instructions amenities under the Check-in, check-out, and front desk policies section in Enumerations.

October 30, 2019

Added additional activities including Adventure Activities, Safari, Sports Activities, Water Based Activities, and Skiing and Snowboarding.

August 16, 2019

Added support of isVacationRental boolean within the API.

July 3, 2019

Added support of Hide Address and Hide Exact location capabilities.

June 21, 2019

Added additional content in Enumerations including: additional amenities, activities, property themes, and negative amenities.

November 19, 2018

Added support of Breakage Deposits in the Enumerations.

August 20, 2018

Updated the Enumerations page to have all the Amenity, Attribute, Policy, Image Category codes called out.

May 18, 2018

Added Languages Spoken to the Enumerations for Amenities.

May 15, 2018

Added ContractTermsChanging and CurrencyCodeChanging to PendingReview Reason Codes.

April 25, 2018

Added support for Number of Bedrooms, Number of Bathrooms, Occupancy under Enumerations - Policies.

April 20, 2018

Added support for the Read/Update by ExpediaID use case.

November 10, 2017

Added support Decentralized Billing and sample onboarding request to the documentation.