New message type was added (CANCEL_WAIVER_RESOLVED) to indicate when a cancellation waiver is resolved.
The following limits are now in place for address fields:
The following limits are now in place for address fields:
Updated the list of accepted value-adds for standalone and package rate plans.
Released the initial version of the Payments API.
Released enhancements to reservation retrieval:
supplierAmount
has been replace by the amounts
object on Reservation
; amounts
returns comprehensive, detailed reservation amount valuespaymentInstructions
has been replaced by the payment : instructions
object on the Reservations
objectpayment : instrument
and payment : installments
is now available on the Reservation
object to retrieve credit card, EVC, and payment informationcancellationPolicy
object was added to the Reservation
object to retrieve the cancellation policy that was in place when the reservation was madepayment : installments
object was added to the Reservation
object so you can retrieve the payment schedule used to collect payment for the reservation
remittanceType
object was added to the Reservation
object to indicate the remittance type used for a reservation
supplierOperatingModel
was added to the Reservation
object to indicate the operation model of the lodging partner
affiliateSource
and invoicing
fields added, to support corporate travelers
itineraryReference
field was added to the ReservationAlternativeIds
object to enable partners to pass itinerary IDs to travelers
Introduced enhancements to reservation update:
reason
input argument to the changeReservationReconciliation
mutationrefundReservation
mutation to enable partners to refund a reservation's rate on or after a reservation’s check-in dateIntroduced reservation delivery, which includes
ReservationNotificationEvent
event type) confirmReservationNotification
mutationCreateReservationInput
object: Changed type of primaryGuest
field from PrimaryGuestInput
to GuestInput
PrimaryGuestInput
to GuestInput
and added the companyName
and corporateTravelPurpose
fieldsInvoicingInput
object: Removed the pointOfSaleDisplay
fieldPaymentInstrumentTypeInput
enumeration: Added the AFFILIATE_VIRTUAL_CARD valueReservationPaymentStatus
enumerationTravelPurpose
enumerationAdded the Japanese-style value to the roomClassEnum enumeration.
Special check-in instructions (specified by the Property API's SPECIAL_CHECKIN_INSTRUCTIONS field) are no longer considered as part of the HasCheckInInstructions
checkpoint.
New featured amenities (featuredAmenityEnum) added:
Updated featured amenities (featuredAmenityEnum):
Deprecated featured amenities (featuredAmenityEnum):
Deprecated room views (viewEnum) from the Room Name attribute:
Added support for affiliate (corporate) credit cards for Hotel Collect bookings. The <SpecialRequests> element (RequestCode=5) can now include guest-handling instructions that include corporate reservation information.
Added support for affiliate (corporate) credit cards for Hotel Collect bookings. The <SpecialRequests> element (code=5) can now include guest-handling instructions that include corporate reservation information.
"Full Kitchen" has been deprecated as a value-add for standalone and corporate rate plans (in favor of relying only on room amenities to indicate kitchens).
clientMutationId
field to all mutation input and payload objects.companyName
field to the Guest
object, to enable partners to retrieve the company a guest works for.The refreshNotificationCallbackConfigSecret mutation now enables you to specify whether the new secret is used immediately or whether it is persisted for 3 more days (if the secret is refreshed more than 3 days before expiration). In addition, a new HTTP notification header called x-eg-notification-signature-v2
was added to replace the x-eg-notification-signature
header.
message_attributes
attribute was added to the MessageAttributesUpdated
notification payload.
Type changed from Int to String for SupplierLoyaltyPlanInfo : membershipNumber
.
Removed support for GIF attachment types.
An email address (contactEmail
) must now be configured when creating a callback configuration using the createNotificationCallbackConfig mutation. The email address is used to send email notifications when the callback configuration's secret is about to expire (sent 30 days, 7 days, and 1 days prior to expiration).
Deprecated the paymentInstructions
field on the Reservation
object. Use payment : instructions
instead.
To maintain the security of our platform and continue building trust with our lodging partners and travelers, we are implementing a new moderation process where a subset of Expedia Group messages may be flagged and held for review before being released. Two enhancements were introduced:
reviewStatus
field to the MessageThreadMessage
object, to indicate a review's status as it goes through moderation. "In Review" indicates that a message is currently being reviewed (could take up to 24 hours), "Approved" indicates that the message has been approved, and "Blocked" indicates that the message contains offending material or links.MessageAttributesUpdated
event type was added to send a webhook notification when a message's review status changes.MessageAttributesUpdated
event type was added to send a notification when a message's review status changes.
When retrieving message threads, you can now specify whether they are returning in ascending or descending order based on creation date. The orderBy
input parameter is now available. You can also specify the order of messages that are retrieved using the messageThread query.
An email address (contactEmail
) can now be configured for each callback configuration. The email address is used to send email notifications when the callback configuration's secret is about to expire (sent 30 days, 7 days, and 1 days prior to expiration).
The undeliveredNotifications
query is now available, to retrieve any undelivered notifications for a given event type.
brandNames
field was added to the ReviewFilter
input type to support this. In addition, the brandName
field in the Review
object has been deprecated; use the new brandNameV2
field instead when retrieving reviews.pageSize
argument's limit (for the reviews
query) has been increased, enabling you to retrieve up to 100 reviews per page of results.Added the aggregatedReviews
query to enable partners to retrieve average ratings for reviews collected on Expedia brand sites.
Released the initial version of the messaging capability of the Lodging Partner GraphQL API.
Property status notifications added.
Added the travelPurpose
field to the Guest
object (in the reservation management capability) to enable partners to identify the reason for a guest's reservation.
Added the cancelReservation
mutation to reservation management capability to enable partners to cancel reservations on or before a reservation’s check-in date.
Updated the enumerations list with new tattoo restrictions.
Added the sendTestNotification
mutation to the capability, which enables partners to send a test notification to their callback URL.
The following types have been added or updated to bring the API into parity with EPC:
Guest : phoneNumbers
SupplierLoyaltyPlanInfo : planCode
SupplierLoyaltyPlanInfo : membershipNumber
Reservation : childAges
Reservation : tidsCode
Guest : emailAddress
In addition, these fields have been deprecated:
Reservation : loyaltyTier
(loyaltyTier
is now in the Guest
object)Reservation : guestContact
(replaced by primaryGuest
)For more information, refer to the reservations query.
Added the following values to the RegistrationNumberType
enumeration to support DAC7 (European regulatory mandate that enforces annual reporting obligations for digital online platforms, crypto-assets and e-money):
In addition, the IS_CONDITION and HOUSE_NUMBER values were added to support properties in jurisdictions of France, San Diego, London, and Tasmania. AUSTRALIAN_BUSINESS_NUMBER was added to support properties in Australia.
Released the initial version of the notifications capability.
Released the initial version of the reviews capability of the Lodging Partner GraphQL API.
Updating PET_POLICY notes to reflect the legal guidelines.
Added the guestContact
object, reconciliationType
field, and isReconciled
field to the reservations query.
Updated the enumerations list to include accessibility attributes.
Update languages spoken section to take out CHINESE and replace it with MANDARIN and CANTONESE.
Added new error code 3027 to ensure strict Per Person fees validation for a same age category in a given duration.
Added the reservation update feature to the reservation management capability, which added the cancelReservationReconciliation
and changeReservationReconciliation
mutations.
Released the initial version of the compliance capability.
Updated GET request to include pagination, which enables partners to call for lists of images beyond the first 1000 active images.
Released the initial version of the property status capability of the Lodging Partner GraphQL API.
lastUpdatedDateTime
filter to the reservations query, enabling partners to backload reservation data for reservation events that were impacted by a delivery connection outage.loyaltyTier
field to the Reservation
object to enable partners to retrieve guest loyalty tier.accessibilityText
field to the Reservation
object to enable partners to retrieve accessibility requests made by the guest for the reservation.valueAddedPromotions
field to the Reservation
object, enabling partners to retrieve value add promotions (VAP) used to book the reservation.checkInTime
, checkOutTime
, petCount
, and paymentSchedule
from the Reservation
object.and
phoneNumberfrom the
Guest` object.Deprecated freeform text paragraphs in Property API. We strongly recommend the use of structured attributes to ensure important information is surfaced appropriately.
Updated error codes list with two new codes, 3806 and 3807.
Updated endpoints:
https://apis.expediaconnectivity.com/oauth/token
to https://api.expediagroup.com/identity/oauth2/v3/token
https://apis.expediaconnectivity.com/graphql
to https://api.expediagroup.com/supply/lodging/graphql
Schema changes:
Property : geoLocation
is deprecated and replaced with coordinates
Address : city
is deprecated and replaced with locality
Address : country
is deprecated and replaced with countryCode
Address : line1, line2, line3
are deprecated and replaced with addressLines
Address : province
is deprecated and replaced with administrativeArea
sublocality
field added to the Address
objectUpdated endpoints:
https://apis.expediaconnectivity.com/oauth/token
to https://api.expediagroup.com/identity/oauth2/v3/token
https://apis.expediaconnectivity.com/graphql
to https://api.expediagroup.com/supply/lodging/graphql
Schema changes:
Property : geoLocation
is deprecated and replaced with coordinates
Address : city
is deprecated and replaced with locality
Address : country
is deprecated and replaced with countryCode
Address : line1, line2, line3
are deprecated and replaced with addressLines
Address : province
is deprecated and replaced with administrativeArea
sublocality
field added to the Address
objectDocumentation 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.
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":
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.
Support for "evergreen" promotions was added, to enable partners to create promotions with no end date. To do this, specify these restrictions: "bookingLocalDateTimeTo": "2079-06-06T23:59:00"
and "travelDateTo": "2079-06-06"
Added the reservation ID filter to the reservations query, enabling partners to query for reservations based on ID.
Added new error codes 3083 and 3089 to ensure strict Cancelation Penalty validations in RatePlan level.
Allowed amenity PUT, amenity GET, and rateThresholds endpoints to receive and return v3 amenity content type.
Maximum number of cancellation policy exceptions was reduced from 200 to 50.
Added reconciliationEligibility
to the Reservation
type to enable partners to determine whether a reservation can be reconciled (using the reservation reconciliation capability).
Maximum number of cancellation policy exceptions was reduced from 500 to 200.
Added enumerations to support bulk media scraping.
Added isContractedPromotion
to the Promotion
interface and DiscountPromotion
type to enable partners to determine whether a promotion was negotiated. Negotiated promotions can be queried but not changed.
Added sellStatus
to the Promotion
interface and DiscountPromotion
type to enable partners to query for a promotion's sell status (whether the promotion is currently bookable based on the its reservation date/time range.)
Added cap for Deposit Percentage to not exceed 50% for Expedia Traveler Preference properties. Updated the error message section with new error code 3032 which is returned when Deposit percentage exceed 50%.
Updated request and best practice information to note that only the first 1,000 active images are returned during a GET of all images.
Released the initial version of the reservation retrieval feature of the reservation management capability of the Lodging Partner GraphQL API.
Added MOBILE_HOME to the Enumeration list of supported structure type.
Updated the categoryCodesEnum
list with new Category Codes for Wardrobe, Elevator, Cleanliness standards, Property map, Pet-friendly amenities, Capsule, In-room fitness, Wardrobe, and Surfing/boogie boarding.
The Date
type was renamed LocalDate
, and the DateTime
type is now LocalDateTime
. This affects the promotions capability. Here is a summary of the schema changes:
BlackoutDateRange
object: travelDateFrom
and travelDateTo
now use the LocalDate
type (from Date
)BlackoutDateRangeInput
input object: travelDateFrom
and travelDateTo
now use the LocalDate
type (from Date
)BookingLocalDateTimeInput
object: from
and to
now use the LocalDateTime
type (from DateTime
)CheckoutDateFilter
input object: from
and to
now use the LocalDate
type (from String
)Reservation
object: checkInDate
and checkOutDate
now use the LocalDate
type (from String
)Restrictions
object:bookingLocalDateTimeFrom
and bookingLocalDateTimeTo
now use the LocalDateTime
type (from DateTime)travelDateFrom
and travelDateTo
now use the LocalDate
type (from Date
)RestrictionsCreateInput
input object:bookingLocalDateTimeFrom
and bookingLocalDateTimeTo
now use the LocalDateTime
type (from DateTime
)
-travelDateFrom
and travelDateTo
now use the LocalDate
type (from Date
)RestrictionsUpdateInput
input object:bookingLocalDateTimeFrom
and bookingLocalDateTimeTo
now use the LocalDateTime
type (from DateTime
)travelDateFrom
and travelDateTo
now use the LocalDate
type (from Date
)Restrictions
object: travelDateFrom
and travelDateTo
now use the LocalDate
type (from Date
)SupplierRate
object: fromDate
and toDate
now use the LocalDate
type (from String
)TravelDateInput
input object: from
and to
now use the LocalDate
type (from Date
)Added additional amenities under Enhanced Cleaning and Traveler Safety.
Added warning codes under Error handling section.
Updated support of custom cancellation policy.
Updated Eligibility for Hotel Loyalty Points value addition to Eligible for Hotel Loyalty Points.
API now supports multiple, concurrent requests to update availability and rates on the same hotel.
Released the initial version of the Lodging Partner GraphQL API to Expedia partners, including the promotions capability.
Added SKI_STORAGE amenity code to Skiing and snow activities section of Enumerations.
Added fitness codes for Room Amenity:
Added 4202 error description.
Added details on Changes to Expedia Collect (see blog from Sept. 7th, 2020 for more info).
Added details on Changes to Expedia Collect (see blog from Sept. 7th, 2020 for more info).
Changed POOL_CHILDRENS to CHILDRENS_POOL.
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.
Updated ROOM_NO_HAIRDRYER to ROOM_NO_HAIR_DRYER.
Added section for error codes that only appear in partner reports.
Added description for booking confirmation warning code 10105. Updated hotel collect example to reflect guest address is NOT actually sent.
Updated the categoryCodesEnum
list with new Category Codes for Exterior Patio and Spa category groups.
Added additional detail codes for FORMS_OF_PAYMENT_ACCEPTED code under Policy Section.
Added additional Fee codes under Mandatory Fees section.
Moved Fee codes with no values under Fee Inclusive / Excluded section. Made Fee Inclusive / Excluded a sub-section under Policies.
Added Enhanced Cleaning and Traveler Safety codes under Policy Section.
Added more detail to error messages returned during property status GET request on the Code Lists page.
Updated the maximum number of updates allowed in one message from 3000 to 5000.
Added support for the No Room Size Amenity.
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.
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.
Updated the categoryCodesEnum
list with new Category Codes for Exterior, Room and Property Amenity groups.
Updated the Expedia Virtual Card sample messages to indicate CVV details being sent (seriesCode field).
Updated CUISINE_INDONESIAN typo in RESTAURANT_TWO, THREE, FOUR and FIVE in the Restaurant specifics section.
Added support for 100+ new amenities spread across all categories: Internet access, Bathroom, Food-related, In-room entertainment, Bedding and linens, Room layout, In-room service, Room features, and Club/executive level. Added a new category for accessibility amenities inside guest accommodations.
Removed SURCHARGE_AMT from Optional Fees section in Enumerations.
Made changes to DEPOSIT and PERCENTAGE_ DURATION in Mandatory Fees section of Enumerations.
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.
Added support for Regulatory Exemption Categories under regulatoryRecords
for Room type actions.
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.
Updated Room type resource management to the V3 version, which includes bedroom and living room details. V2 versions moved over to the Archived section.
Added support of new "cash only" form of payment in Payment information section of Enumerations.
Updated the Expedia Virtual Card address to the new Expedia Group headquarters address.
Updated the Cardholder address for Expedia Virtual Cards to the new Expedia Group headquarters address in all applicable sample messages.
Added additional self check-in instructions amenities under the Check-in, check-out, and front desk policies section in Enumerations.
Added additional activities including Adventure Activities, Safari, Sports Activities, Water Based Activities, and Skiing and Snowboarding.
Updated the categoryCodesEnum
list with structure type-neutral codes.
Added support of isVacationRental boolean within the API.
Launched Unicode support, which applies to China, Hong Kong, Japan, Korea, and Taiwan. Requires partner systems to support UTF-8 encoding. For additional details see Unicode Support.
Added support of Hide Address and Hide Exact location capabilities.
Added additional content in Enumerations including: additional amenities, activities, property themes, and negative amenities.
Released new feature to expose <allowedAgeCategories> for Property level GET. Added documentation references in Sample Messages and Reference.
Added sample message for email alias.
Added sample message for email alias.
Updated Sample BR Responses with a No Credit Card booking example.
Updated Sample BR Responses with a No Credit Card booking example.
Added support of Breakage Deposits in the Enumerations.
Updated the Enumerations page to have all the Amenity, Attribute, Policy, Image Category codes called out.
Added support documentation about Per Stay Service Fees at the Rate plan level (GET, POST, PUT).
Added Languages Spoken to the Enumerations for Amenities.
Added ContractTermsChanging and CurrencyCodeChanging to PendingReview Reason Codes.
Added support for Number of Bedrooms, Number of Bathrooms, Occupancy under Enumerations - Policies.
Added support for the Read/Update by ExpediaID use case.
Added support Decentralized Billing and sample onboarding request to the documentation.
Added HTTP header information.
Launched the Deposit API v1.
Added access to room type and rate plan resources without "/products" in endpoint path.
Corrected list of support room views.
Added new point of sale brands: American Express Travel, Amex The Hotel Collection, and Amex FINE HOTELS AND RESORTS.
Added new point of sale brands: Travelocity, Orbitz, Wotif, and other Expedia Group, Inc. brands.
Removed Simulator Documentation as this feature was deprecated.
Released new feature to expose a rate plan's deposit required flag, create, and last update dates in read-only format. These attributes can be read via GET. They cannot be provided with a create request (deposit is set to false by default), and they cannot be changed in update requests.
Released a new feature to expose a room type's rate thresholds, in read-only format. Only GET operation is allowed on this sub resource.
Released a new feature to expose RatePlanLinkage information in read-only format in rate plan GET. Added a links section to the show rate plan resource's link to itself, its rate plan linkage parent, if any, and/or its derived child rate plans, if any.
Added new section documenting changes between V1 and V2 to the documentation.
The API now supports updates to existing images’ metadata via PATCH verb. The PATCH modify operation is a way for you to send a request containing only the data you would like to modify about the image, as opposed to the entire data about the resource. From your perspective, the PATCH feature allows for modification of the image resource without having to pre-load the entire data about the resource.
Expedia Group implemented the Merge-PATCH strategy for Image API. You can send any of the top-level elements you'd like to modify, and omit the ones you do not want to change. Expedia Group will take care of merging the resource updates and preserve what was not included in your PATCH request.
For complete information, refer to PATCH feature.
Renamed guide by resourceID.
Clarified categories and added examples to documentation.
Release Image API v1.
Released Product API v2. Versioning strategy changed from URL to using content-type and accept headers. As a result, URLs have all changed to have V1 removed when you are ready to use V2. Room type resource changed significantly for defining bed types and occupancy.
Released the initial version of the API.
Released the initial version of the API.
Added support for cancel policy exceptions.
Added support for Rate Plan Delete.
Refreshed list of supported value adds, added more pricing models supported, clarified required VS optional fields.
Added support for room-level amenities (GET and PUT).
Support for read/create/update room views and wheelchair accessibility in room type resource.
Released the first version of the API. Additional feature since last PDF version: support for read/create/update room size in room type resource.