Documentation

ReferenceReservations

cancelReservation mutation

Cancels a reservation on or before a reservation’s check-in date, enabling the partner to reconcile a reservation if requested by the guest or if the method of payment is invalid (Hotel Collect only).

Here are the validation rules that determine if a reservation can be cancelled:

A reservation cannot be cancelled if the check-in date is in the past.
A reservation cannot be cancelled if it is already in a cancelled state.
Cancellations can be performed on Expedia Collect and Hotel Collect reservations. Reservations made through the Expedia Group Affiliate Program cannot be cancelled prior to check-in using the API.
Only Expedia IDs (for property and reservation IDs) are allowed as arguments.
Partners must provide a reason for the cancellation and agree to waive (or refund, if applicable) any cancellation fees and other amounts associated with the reservation.

If a reservation cannot be canceled or modified using this API, the guest must contact customer service of the originating booking service for assistance.

Syntax

1mutation {
2  cancelReservation(
3    input: CancelReservationInput!
4  ): CancelReservationPayload
5}

Example

This example cancels a reservation as requested by the guest. It returns the reservation ID.

Request
Response

1mutation { 
2  cancelReservation( 
3    input: 
4      {    
5        propertyId: "1559", 
6        reason: GUEST_REQUESTED_CANCEL, 
7        reservationId: "1401316073" 
8      } 
9  ) 
10  { 
11    reservation { 
12      reservationIds { 
13        id 
14        idSource 
15      } 
16    } 
17  } 
18}

Arguments

Name	Description
`input`	Required. Reservation ID and other details needed to cancel a reservation. Type: CancelReservationInput

Types

Name

Type

Boolean

The Boolean scalar type represents true or false.

BusinessModel

Enum

Entity that collects payment.

Name	Description
`EXPEDIA_COLLECT`	Expedia collects payment.
`HOTEL_COLLECT`	Property collects payment.

CancelReservationInput

InputObject

Property and reservation IDs and the reason for the cancellation.

Field	Description
`propertyId`	Not nullable. Expedia ID of the property for which the cancellation is requested. Type: ID
`reason`	Not nullable. Reason for cancelling the reservation. Type: ReservationPreStayCancellationReason
`reservationId`	Not nullable. Expedia ID of the reservation to be cancelled. Type: ID

CancelReservationPayload

Object

Response to the cancellation request.

Field	Description
`reservation`	Reservation details. Type: Reservation

EmailAddress

A field whose value conforms to the standard internet email address format as specified in HTML Spec.

ExpediaSupplierAmount

Object

Field	Description
`currencyCode`	Not nullable. Currency in which the amount is shown. Type: String
`rates`	Not nullable. Nightly rates for the reservation. Type: Array of non nullable SupplierRate
`rateType`	Not nullable. Rate type: NET for Expedia Collect or SELL for Hotel Collect. Type: RateType
`total`	Not nullable. Total rates for the reservation. Type: SupplierTotal

Float

The Float scalar type represents signed double-precision fractional values as specified by IEEE 754.

Guest

Object

Field	Description
`emailAddress`	Guest's email address. Type: EmailAddress
`firstName`	Not nullable. Guest's first (given) name. Type: String
`lastName`	Not nullable. Guest's last name (surname). Type: String
`loyaltyTier`	Guest loyalty tier. Values include MEMBER, VIP, PREMIUMVIP, and null. You must include this field to complete certification. Type: String
`phoneNumbers`	The phone numbers of the guest. Type: Array of non nullable GuestContactPhoneNumber
`supplierLoyaltyPlanInfo`	Details about the frequent traveler reward program. Type: SupplierLoyaltyPlanInfo
`travelPurpose`	Purpose of the guest's reservation. Type: TravelPurpose

GuestContactPhoneNumber

Object

Guest phone number.

Field	Description
`areaCode`	Not nullable. Area code (three digits). Type: String
`countryCode`	Not nullable. Country code (two digits). Type: String
`number`	Not nullable. Phone number (seven digits, no hyphen). Type: String

The ID scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as "4") or integer (such as 4) input value will be accepted as an ID.

IdNode

Object

Known IDs in the source system.

Field	Description
`id`	ID in the source system. Type: ID
`idSource`	Not nullable. Source of the ID. Type: IdSource

IdSource

Enum

Source of a given ID.

Name	Description
`EXPEDIA`	Expedia is the source of the ID.
`SUPPLIER`	Connectivity provider or lodging partner is the source of the ID. This value is not supported for use in `promotions`.
`VRBO`	Unsupported.

Int

The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.

InvalidScenario

Object

Reason and description of the scenario that makes the reservation ineligible for reconciliation.

Field Description

reason

Not nullable.

Description of why the reservation is ineligible for reconciliation.

Type: String

scenario

Not nullable.

Reason why the reservation cannot be reconciled. Values include the following:

GUEST_REQUESTED_CANCEL - Traveler cancelled the reservation
NO_SHOW - Traveler was a no-show
MODIFY_DATES_AMOUNTS - There was a difference in the booking price when the lodging partner charged the traveler (for example, because an extra night was added at the time of stay)

Type: String

LocalDate

A type representing a date in ISO 8601 format: YYYY-MM-DD (such as 2007-12-03).

Payment

Object

Payment details.

Field	Description
`instructions`	Not nullable. Text that is displayed to travelers if a payment type is associated with the reservation. Type: String

RateTimeUnit

Enum

Time frame to which the rate is applied.

Name	Description
`PER_DAY`	Rate is applied per day.
`PER_WEEK`	Unsupported at this time.
`PER_STAY`	Unsupported at this time.

RateType

Enum

Name	Description
`NET`	Net amount (excludes compensation and taxes).
`SELL`	Gross amount (includes compensation and taxes).

ReconEligibility

Object

Reason(s) why the reservation can or cannot be reconciled.

Field Description

invalidScenarios

Reasons and descriptions why the reservation cannot be reconciled.

Type: Array of non nullable InvalidScenario

validScenarios

Reason why the reservation can be reconciled. Values include the following:

GUEST_REQUESTED_CANCEL - Traveler cancelled the reservation
NO_SHOW - Traveler was a no-show
MODIFY_DATES_AMOUNTS - There was a difference in the booking price when the lodging partner charged the traveler (for example, because an extra night was added at the time of stay)

Type: Array of non nullable String

Reservation

Object

Reservation details.

Field	Description
`accessibilityText`	Accessibility requests made by the guest for the reservation. We strongly recommend that you include this field in your implementation. Type: Array of non nullable String
`adultCount`	Not nullable. Count for all adult guests associated with the reservation. Type: Int
`bedTypes`	Bed type of the reservation. Type: String
`businessModel`	Not nullable. Entity that collects payment for the reservation. Type: BusinessModel
`checkInDate`	Not nullable. Check-in date (format: YYYY-MM-DD) of the reservation. Type: LocalDate
`checkOutDate`	Not nullable. Checkout date (format: YYYY-MM-DD) of the reservation. Type: LocalDate
`childAges`	Ages of children associated with the reservation. Type: Array of Int
`childCount`	Not nullable. Count for all child guests associated with the reservation. Type: Int
`creationDateTime`	Not nullable. Timestamp of when the reservation was created (format: yyyy-mm-ddThh:mm:ssTZD, where TZD is a time zone designator in the form +/-hh:mm). Compare this value to that of `lastUpdatedDateTime` to determine if a reservation has been modified. Type: String
`id`	Expedia's reservation ID. Type: ID
`isReconciled`	Whether one or more reconciliation attempts have been made on the reservation. Type: Boolean
`lastUpdatedDateTime`	Not nullable. Date and time when the reservation was last updated. Compare this value to that of `creationDateTime` to determine if a reservation has been modified. Type: String
`messageThreadId`	ID of message thread (conversation) associated with the reservation. This requires implementation and certification of the messaging capability. If no message threads exist for a reservation, null is returned. Type: ID
`multiRoomText`	Text that is displayed to guests if there is a multi-room booking associated with the reservation. Type: String
`payment`	Not nullable. Text that is displayed to travelers if a payment type is associated with the reservation. Type: Payment
`paymentInstructions`	Not nullable. Instructions that describe how to retrieve payment for the reservation. Type: String
`primaryGuest`	Not nullable. Guest who made the reservation. Type: Guest
`rateIds`	Not nullable. ID of the rate/rate plan and the source of the ID. In the response, when `idSource` is set to SUPPLIER, the `id` field returns the same value as returned by the existing booking APIs. However, for Hotel Collect properties, the A- prefix is no longer added to the `source` value and the A suffix is no longer appended to the rate ID as was done by the booking APIs. Type: Array of non nullable IdNode
`reconciliationEligibility`	The reason(s) why the reservation can or cannot be reconciled. Type: ReconEligibility
`reconciliationType`	Reconciliation type of the reservation, either MODIFY, CANCEL, NO_SHOW, or null. Type: String
`reservationIds`	Not nullable. IDs associated with the reservation and the source of the IDs. Type: Array of non nullable IdNode
`smokingType`	Not nullable. Whether smoking is allowed for the reservation. Type: String
`source`	Not nullable. Source of the reservation. Refer to Booking sources for the list of possible values (though \"A-\" is not included in Hotel Collect sources returned by this API). Type: String
`specialRequest`	Text that is displayed to guests if there is a special request associated with the reservation. Type: String
`status`	Not nullable. Current status of the reservation. Type: ReservationStatus
`subStatus`	Current substatus of the reservation. Applicable for Vrbo reservations only. Type: String
`supplierAmount`	Connectivity or lodging partner's amount for the reservation. Type: SupplierAmount
`tidsCode`	Travel Industry Designator Service (TIDS) code that allows a reservation to be recognized by industry suppliers. Type: Int
`totalGuestCount`	Not nullable. Total number of guests associated with the reservation. Type: Int
`unitIds`	Not nullable. Known IDs for the unit/room in the source system(s). IDs that are returned depend on where the property was onboarded: If the property was onboarded onto Vrbo, three IDs are returned: the partner’s (external ID), Vrbo’s (Vrbo internal ID), and Expedia's (EID). If the property was onboarded onto Expedia, only the Expedia ID is included in the response. Type: Array of non nullable IdNode
`valueAddedPromotions`	Not nullable. Value add promotion(s) used to book the reservation. If a value add promotion (VAP) was not used, an empty array is returned. We strongly recommend that you include this field in your implementation. Type: Array of non nullable ReservationValueAddedPromotion

ReservationPreStayCancellationReason

Enum

Reason the reservation was cancelled.

Name	Description
`GUEST_REQUESTED_CANCEL`
`INVALID_PAYMENT_METHOD`

ReservationStatus

Enum

Status of the reservation.

Name	Description
`BOOKED`
`CANCELLED`
`COMPLETE`	For Vrbo reservations only.
`CREATED`	For Vrbo reservations only.
`DECLINED`	For Vrbo reservations only.
`IN_PROGRESS`	For Vrbo reservations only.
`INVALID`	For Vrbo reservations only.
`RESERVED`	For Vrbo reservations only.

ReservationValueAddedPromotion

Object

Value add promotion(s) used to book the reservation. If no value add promotion (VAP) was used, an empty array is returned.

Field	Description
`description`	Not nullable. Description of the promotion. Type: String
`id`	Not nullable. ID of the promotion. Type: String

String

The String scalar type represents textual data, represented as UTF-8 character sequences. The String type is most often used by GraphQL to represent free-form human-readable text.

SupplierAmount

Interface

Implemented by

ExpediaSupplierAmount

Field	Description
`currencyCode`	Not nullable. Currency in which the amount is shown. Type: String
`rateType`	Not nullable. Rate type. Type: RateType

SupplierAmountCompensation

Object

Compensation information associated with the reservation for this date range.

Field	Description
`acceleratorPercent`	Accelerator percentage, expressed as a fraction of 1 (for example, 0.25). Type: Float
`basePercent`	Compensation base percentage, expressed as a fraction of 1 (for example, 0.25). Type: Float

SupplierFeeType

Enum

Type of fee charged by the lodging partner.

Name	Description
`BASE_RATE`	Nightly rate with no additional taxes, fees, or surcharges.
`EXTRA_GUEST_FEES`	Fees that are included in the price that guests see when booking. They are paid in advance for Expedia Collect reservations or upon arrival for Hotel Collect reservations.
`SERVICE_FEES`	Fees that only apply to guests who make use of specific facilities or services, such as resort fees, parking fees, or fees for rollaway beds.
`RECONCILED_AMOUNT`	Updated rate, which must be the commissionable value for the stay date. Amounts for dates included in the original reservation cannot be modified to a value of three times more than the commissionable rate applicable to that date.

SupplierLoyaltyPlanInfo

Object

Details about the frequent traveler reward program.

Field	Description
`membershipNumber`	Traveler's membership number. Type: Int
`planCode`	Reward program code. Type: String

SupplierRate

Object

Field	Description
`fromDate`	Not nullable. Date when the rate becomes effective (format: YYYY-MM-DD). Type: LocalDate
`rateItems`	Not nullable. Itemized list of fees. Type: Array of non nullable SupplierRateItem
`rateTimeUnit`	Not nullable. Time unit of the rate. Type: RateTimeUnit
`toDate`	Not nullable. Date when the rate expires (format: YYYY-MM-DD). Type: LocalDate

SupplierRateItem

Object

Field	Description
`amount`	Not nullable. Amount of the fee. Type: Float
`feeType`	Not nullable. Type of fee for this itemized rate. Type: SupplierFeeType

SupplierTotal

Object

Field	Description
`amountAfterTax`	Not nullable. Total amount of the fee after tax is applied. Type: Float
`amountBeforeTax`	Not nullable. Total amount of the fee before tax is applied. Type: Float
`compensation`	Not nullable. Compensation information associated with the reservation. Type: SupplierAmountCompensation

TravelPurpose

Enum

Values for a guest's travel purpose, to identify business bookings.

Name	Description
`NONE`
`KNOWN_BUSINESS_VISIT`
`SUSPECTED_BUSINESS_VISIT`
`KNOWN_PERSONAL_VISIT`
`SUSPECTED_PERSONAL_VISIT`

Availability and Rates APIs

Booking APIs

Property Mgmt APIs

Reservations

cancelReservation mutation

Syntax

Example

Arguments

Types

Availability and Rates APIs

Booking APIs

Property Mgmt APIs

Reservations

cancelReservation mutationCopy link

Syntax

Example

Arguments

Types

cancelReservation mutation