Documentation

LSGQL API referenceReservation management

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). Reservations can be cancelled on or before the reservation’s check-in date until 11:59 p.m. (property local time.) For example, if the reservation’s check-in date is on January 4, the reservation must be cancelled by January 4 at 11:59 p.m. This behavior differs from the validation in Expedia Partner Central, which allows for cancellation 24 hours prior to check-in date only.

All penalties are waived when a reservation is cancelled before the check-in date. Supplier-initiated cancellation that require penalty charges is not supported.

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

Address

Object

Property address information.

Field	Description
`addressLines`	Not nullable. Lines that describe the physical street address. Two address lines are supported, and up to 40 characters are allowed in each address line. Type: Array of non nullable String
`administrativeArea`	State or province of the property. Up to 40 characters are allowed. Type: String
`countryCode`	Not nullable. Three-character ISO-3166-1 country code. Type: CountryCode
`locality`	Not nullable. City or locality where the property is located. Up to 40 characters are allowed. Type: String
`postalCode`	Not nullable. Postal code of the address. Up to 20 characters are allowed. Type: String

Boolean

The Boolean scalar type represents true or false.

BusinessModel

Enum

Entity that collects payment.

Name	Description
`EXPEDIA_COLLECT`	Expedia collects payment; this is also referred to as "EC" or "Merchant".
`HOTEL_COLLECT`	Property collects payment; this is referred to as "HC," "Agency," or "Property Collect".

CancellationPenaltyRuleType

Enum

How the cancellation penalty (fee) is applied.

Name	Description
`FLAT_AMOUNT`
`NUMBER_OF_NIGHTS`
`PERCENTAGE`

CancellationPolicyCancellationWindow

Object

Policy period (number of days, hour, or weeks before the check-in date that a cancellation can be done).

Field	Description
`cutoff`	Not nullable. Number of days, hours, or weeks before the check-in date to which this policy applies. If cutoff is set to 12000 hours or 500 days, which is the the maximum reservation length, the policy applies to all days leading up to the next cutoff period. Type: Int
`temporalUnit`	Not nullable. Time unit of the cutoff. Type: CancellationWindowTemporalUnit

CancellationWindowTemporalUnit

Enum

Time unit used for the cancellation window.

Name	Description
`DAY`
`HOUR`
`WEEK`

CancelReservationInput

InputObject

Property and reservation IDs and the reason for the cancellation.

Field	Description
`clientMutationId`	Partner's transaction ID that uniquely identifies the request, which can be used to associate requests and responses for troubleshooting purposes. This ID must be unique across requests and cannot be reused. However, if a request needs to be retried, such as because it failed or timed out, the ID provided in the original request should be used. The ID can be in any format as long as it uniquely identifies the request. Type: String
`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
`clientMutationId`	Partner's transaction ID that identifies the request, which can be used to correlate with partner's transaction logs. This ID must be unique across requests and cannot be reused. Type: String
`reservation`	Reservation details. Type: Reservation

CountryCode

Scalar representing a country code using the ISO 3166-1 alpha-3 standard.

CurrencyCode

Scalar that represents the three-letter currency code defined by the ISO 4217 standard.

DateTime

Scalar that represents a date-time string at UTC, such as 2007-12-03T10:15:30Z, compliant with the date-time format outlined in section 5.6 of the RFC 3339 profile of the ISO 8601 standard for representation of dates and times using the Gregorian calendar.

Decimal

A type represending a signed decimal number (supporting up to two decimal places), which is serialized as a string.

EffectivePolicy

Object

Effective cancellation policy for the reservation.

Field	Description
`endDateTimeUtc`	Not nullable. End date and time of the policy in UTC. Type: DateTime
`policyType`	Not nullable. Type of policy being applied. Valid value includes REGULATORY_WAIVER. Type: String
`startDateTimeUtc`	Not nullable. Start date and time of the policy in UTC. Type: DateTime

EmailAddress

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

Float

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

Guest

Object

Field	Description
`companyName`	Name of the company that the guest works for. Type: String
`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`	The traveler's Expedia Group VIP Access loyalty tier. These reservations often include value add promotions (VAPs), therefore it is important to associate this field and `reservation:valueAddedPromotions` in your systems so that end-users can properly identify loyal travelers and loyalty perks that the traveler is expecting. 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. This field identifies if the traveler is a member of the supplier's loyalty program to ensure the supplier is able to greet the guest accordingly and award loyalty points as needed. Type: SupplierLoyaltyPlanInfo
`travelPurpose`	Purpose of the guest's reservation. Properties that recognize business travelers are better positioned to meet their expectations. 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.

Installment

Object

Details of a single payment installment associated with the reservation.

Field	Description
`amount`	Not nullable. The total amount of the payment installment. Type: Money
`dueDate`	Not nullable. The due date of the payment installment. Type: LocalDate
`id`	Unique identifier for the payment installment. Type: ID

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

Invoicing

Object

Invoice details for a corporate traveler.

Field	Description
`company`	Traveler's company (legal entity) that appears on the invoice. Type: LegalEntity
`invoiceEmail`	Email address where the invoice was sent. Type: EmailAddress
`vatNumber`	VAT number to included on the invoice. Type: String

LegalEntity

Object

Traveler's company (legal entity) that appears on the invoice.

Field	Description
`address`	Postal address of the company. Type: Address
`name`	Not nullable. Legal entity name. Type: String

LocalDate

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

Money

Object

Monetary amount value and its currency code.

Field	Description
`amount`	Not nullable. Monetary amount value. The scale of the amount varies according to the currency or any rate conversion that may have been applied. Type: Decimal
`currencyCode`	Not nullable. Currency code. Type: CurrencyCode

Payment

Object

Guest payment details.

Field	Description
`installments`	Not nullable. Schedule and details of each payment installment. Type: Array of non nullable Installment
`instructions`	Not nullable. Text that is displayed to travelers if a payment type is associated with the reservation. Type: String
`instrument`	Payment instrument details, including the token needed to retrieve credit card information from the Payments API. Type: PaymentInstrument
`status`	Payment status associated with the reservation. Type: ReservationPaymentStatus

PaymentInstrument

Object

Payment instrument details, including the token needed to retrieve credit card information from the Payments API.

Field	Description
`token`	Not nullable. Payment token and its expiration date and time. Tokens are valid for one hour only. Type: PaymentToken
`type`	Not nullable. Payment type used to book the reservation. Type: PaymentInstrumentType

PaymentInstrumentType

Enum

Payment type used to book the reservation.

Name	Description
`AFFILIATE_VIRTUAL_CARD`
`GUEST_CREDIT_CARD`
`EXPEDIA_VIRTUAL_CARD`
`BANK_TRANSFER`
`CASH`
`NONE`

PaymentToken

Object

Token value and expiration date. The token is then passed to the paymentInstrument query (Payments API) to retrieve card information.

Field	Description
`expirationDateTime`	Expiration date and time of the token. Type: String
`value`	Value of the token. Type: String

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

RemittanceType

Enum

Remittance type used for the reservation.

Name	Description
`NET`	Nightly net rate + applicable taxes (only taxes the property is liable to pay to the government).
`GROSS`	Nightly net rate + Expedia compensation + total taxes.

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
`affiliateSource`	Affiliate source of the reservation. Type: String
`amounts`	Rate amounts for the reservation, including the summary list of the reservation amounts (base rates, extra person charges, discounts, taxes, fees, and various adjustments or compensations) and detailed reservation amounts that are calculated on a daily basis. Type: ReservationAmounts
`bedTypes`	Bed type of the reservation. Type: String
`businessModel`	Not nullable. Entity that collects payment for the reservation. Type: BusinessModel
`cancellationPolicy`	Cancellation policy that was in place when the reservation was made. Type: ReservationCancellationPolicy
`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`	Not nullable. Expedia's reservation ID. Type: ID
`invoicing`	Invoice details for a corporate traveler. Supported for pilot partners only. Type: Invoicing
`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. Guest payment details. Type: Payment
`primaryGuest`	Not nullable. Guest who made the reservation. Type: Guest
`rateIds`	Not nullable. ID(s) of the rate/rate plan and the source of each 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 reservations, 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
`remittanceType`	Remittance type used for the reservation. This field helps identify whether the reservation uses the Updated Expedia Collect business model (returns GROSS if so). Type: RemittanceType
`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
`supplierOperatingModel`	Operation model of the lodging partner. This field helps identify whether the reservation uses the Updated Expedia Collect business model (returns AGENCY if so). Type: SupplierOperatingModel
`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, which are additional benefits that travelers receive based on loyalty tier status, chosen property, and room type or rate plan they book. If a value add promotion was not used, an empty array is returned. We strongly recommend that you include this field in your implementation to ensure traveler-promised perks can be properly fulfilled by suppliers. Type: Array of non nullable ReservationValueAddedPromotion

ReservationAmounts

Object

Rate amounts for the reservation.

Field	Description
`nightlyPayments`	Not nullable. Detailed reservation amounts that are calculated on a daily basis. Type: ReservationNightlyPayments
`summary`	Not nullable. Summary list of the reservation amounts including base rates, extra person charges, discounts, taxes, fees, and various adjustments or compensations. Type: Array of non nullable ReservationPerStayAmount

ReservationCancellationPenaltyRule

Object

Penalty type and amount. Only one of the following fields may be defined: percentage, flatAmount, and numberOfNights.

Field	Description
`costFlatAmount`	Cancellation penalty amount for the reservation paid by the traveler, minus the Expedia commission. Note that this value will be that same as `priceAmount` unless the booking is Expedia Collect and a flat fee penalty type on the property. Type: Money
`numberOfNights`	Number of nights for which the penalty is applied. Type: Int
`percentage`	Percentage of the total booking amount that is charged as a penalty. Represented as a fraction of 1 (for example,: 15% should be represented as 0.15. Note that to charge 100% penalty, specify 1.0. Type: Float
`priceAmount`	Total penalty amount for the reservation paid by the traveler, including the Expedia commission. Note that this value will be that same as `costFlatAmount` unless the booking is Expedia Collect and a flat fee penalty type on the property. Type: Money
`type`	Not nullable. How the cancellation penalty is applied. Type: CancellationPenaltyRuleType

ReservationCancellationPolicy

Object

Cancellation policy that was in place when the reservation was made.

Field	Description
`effectivePolicy`	Policy that was applied to the reservation. For example, a property might have a non-refundable cancellation policy as their default policy. However, if a traveler cancels their reservation within 24 hours of creating the reservation, the property's cancellation policy is overridden and the effective policy is "fully refundable" due to a regulatory requirement in places like California or Brazil. Type: EffectivePolicy
`tiers`	Details about the cancellation rules. Type: Array of non nullable ReservationCancellationPolicyTier

ReservationCancellationPolicyTier

Object

Penalty or penalties applied based on cancellation window.

Field	Description
`cancellationWindow`	Not nullable. Policy period (number of days, hour, or weeks before the check-in date that a cancellation can be done). Type: CancellationPolicyCancellationWindow
`penaltyRule`	Not nullable. Penalty type and amount for the specified policy period. Type: ReservationCancellationPenaltyRule

ReservationDailyAmount

Object

Reservation amount that applies to a specific stay date.

Field	Description
`amount`	Not nullable. Amount value and currency code. Type: Money
`date`	Not nullable. Date when the amount was applied. Type: LocalDate
`description`	User-friendly name associated with the amount. Type: String
`percent`	Percentage of the commissionable amount (for any COMMISSION_* type fields) for Hotel Collect reservations. This field is only available for these types in the `summary` object: COMMISSION_TOTAL: available for Expedia Collect, Hotel Collect and Updated Expedia Collect reservations only ACCELERATOR: available for Hotel Collect reservations only And this field only available for COMMISSION_BASE in the `nightlyPayments` object, for Hotel Collect reservations only. Type: Float
`type`	Not nullable. Amount type. These values may be returned for nightly amounts: ACCELERATOR - Compensation subject to adjustment, if your property is opted into this service, your property's ranking is boosted in our search results AUTO_RATE_MATCH - How the rate was adjusted to match your listings on other sites, if property is opted into service BASE - Total nightly or per-stay rate for the guest's stay; does not include taxes, fees, compensation, or promotions COMMISSION_BASE - Compensation on the nightly rate (Hotel Collect reservations only) COMMISSION_ON_FEE - Compensation on fee (Hotel Collect reservations only) COMMISSION_ON_TAX_OR_FEE - Compensation on taxes or fees (Hotel Collect reservations only) COMMISSION_TOTAL - Expedia Group's total compensation rate, which is a percentage determined by your contract (Updated Expedia Collect only) DISCOUNT - Promotional discount your property applied to this room type's rate plan EXPEDIA_GROUP_INVOICE - Total amount that Expedia Group will invoice partner for this reservation (Expedia Collect reservations only) EXTRA_PERSON_CHARGE - Fee charged for every extra guest beyond the allowed number of guests for the room FEE - Fee included in the price that travelers see when booking and are paid in advance or upon arrival GUEST_PAYMENT - Total reservation amount paid by guest (Hotel Collect and Updated Expedia Collect reservations only) PAYOUT- Partner earnings (total reservation amount minus compensation) SUBTOTAL - Amount after any amounts retained by EG and promotions have been subtracted, before taxes and fees are applied. (Expedia Collect only) TAX - Tax amount on BASE, unless otherwise stated in description TAX_ON_COMPENSATION - Taxes on compensation Type: String

ReservationNightlyPayments

Object

Detailed (per-day) list of the reservation amounts.

Field	Description
`cancellationAmounts`	Not nullable. Penalties and compensations related to reservation cancellation. Type: Array of non nullable ReservationPerStayAmount
`dailyAmounts`	Not nullable. Reservation amounts for a specific stay date. Type: Array of non nullable ReservationDailyAmount
`perStayAmounts`	Not nullable. Reservation amounts that are calculated for the entire stay. Type: Array of non nullable ReservationPerStayAmount

ReservationPaymentStatus

Enum

Reservation payment status.

Name	Description
`UNPAID`
`PARTIAL_PAID`
`OVERPAID`
`PAID`
`EXTERNAL_SOR`

ReservationPerStayAmount

Object

Reservation amounts that are calculated for the entire stay.

Field	Description
`amount`	Not nullable. Amount value and currency code. Type: Money
`description`	User-friendly name associated with the amount. Type: String
`percent`	Percentage of the commissionable amount. Note that a value is reported for this field in the `summary` object as follows: COMMISSION_TOTAL type for Expedia and Hotel Collect reservations ACCELERATOR type for Hotel Collect reservations only Type: Float
`type`	Not nullable. Amount type. For summary amounts, these values may be returned: ACCELERATOR - Compensation subject to adjustment, if your property is opted into this service, your property's ranking is boosted in our search results AUTO_RATE_MATCH - How the rate was adjusted to match your listings on other sites, if property is opted into service BASE - Total nightly or per-stay rate for the guest's stay; does not include taxes, fees, or promotions CANCELLATION_PENALTY - Cancellation penalty amount CANCELLATION_WAIVER - Cancellation waiver amount (Hotel Collect reservations only) COLLECT_AMOUNT - Total Amount to charge or collect: For an HC reservation, this is the total guest payment and indicates the amount to charge the guest For an EC reservation, this is the partner's total payout and indicates the amount to charge Expedia Group For an Updated Expedia Collect reservation: For NET remittance type, this is the partner's total payout and indicates the amount to charge Expedia Group For GROSS remittance type, this is the total guest payment and indicates the amount to charge Expedia Group COMMISSION_ON_COST_ADJUSTMENT_TOOL - Adjustment to commission caused by cost adjustment tool (an error correction amount) COMMISSION_ON_HOTEL_WAIVED - Adjustment to commission as a result of HOTEL_WAIVED (Expedia Collect reservations only) COMMISSION_TOTAL - Expedia Group's total compensation rate, which is a percentage determined by your contract DISCOUNT - Promotional discount your property applied to this room type's rate plan EXPEDIA_GROUP_INVOICE - Total amount that Expedia Group will invoice partner for this reservation EXTRA_PERSON_CHARGE - Fee charged for every extra guest beyond the allowed number of guests for the room FEE - Fee included in the price that travelers see when booking and are paid in advance or upon arrival GUEST_PAYMENT - Total reservation amount paid by guest (Hotel Collect and Updated Expedia Collect reservations only) HOTEL_WAIVED - Amount that the property refunded to the traveler (Expedia Collect and Updated Expedia Collect reservations only) PAYOUT- Partner earnings (total reservation amount minus compensation) PER_STAY_FEE - Per-stay fee amount PER_STAY_TAX - Per -stay tax amount PER_STAY_TAX_AND_FEE_SUBTOTAL - Per-stay fees and taxes SUBTOTAL - Amount after any amounts retained by EG and promotions have been subtracted, before taxes and fees are applied. (Expedia Collect only) TAX - Tax amount on BASE, unless otherwise stated in description TAX_ON_COMPENSATION - Taxes on compensation (Updated Expedia Collect reservations only) For per-stay amounts, these values may be returned: CANCELLATION_PENALTY - Cancellation penalty amount (Expedia Collect and Updated Expedia Collect reservations only) COMMISSION_ON_CANCELLATION - Expedia Group's compensation on the cancellation fee (Expedia Collect and Updated Expedia Collect reservations only) COMMISSION_ON_COST_ADJUSTMENT_TOOL - Adjustment to commission caused by cost adjustment tool (an error correction amount) COMMISSION_TOTAL - Expedia Group's total compensation rate, which is a percentage determined by your contract (Hotel Collect reservations only) GUEST_PAYMENT - Total reservation amount paid by guest (Hotel Collect and Updated Expedia Collect reservations only) PAYOUT- Partner earnings (total reservation amount minus compensation) PER_STAY_FEE - Per-stay fee amount PER_STAY_TAX - Per -stay tax amount For cancellation amounts, these values may be returned: COMMISSION_ON_CANCELLATION - Expedia Group's compensation on the cancellation fee (Hotel Collect reservations only) CANCELLATION_PENALTY - Cancellation penalty amount CANCELLATION_WAIVER - Cancellation waiver amount (Hotel Collect reservations only) GUEST_PAYMENT - Total reservation amount paid by guest (Hotel Collect and Updated Expedia Collect reservations only) PAYOUT- Partner earnings (total reservation amount minus compensation) Type: String

ReservationPreStayCancellationReason

Enum

Reason the reservation was cancelled.

Name	Description
`GUEST_REQUESTED_CANCEL`
`INVALID_PAYMENT_METHOD`	Supported for Hotel Collect reservations only.

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.

SupplierLoyaltyPlanInfo

Object

Details about the frequent traveler reward program. This field identifies if the traveler is a member of the supplier's loyalty program to ensure the supplier is able to greet the guest accordingly and award loyalty points as needed.

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

SupplierOperatingModel

Enum

Operation model of the supplier.

Name	Description
`MERCHANT`	Expedia Group collects payment from travelers at the time of booking. This model is sometimes referred to as "Pay Now" or "Expedia Collect (EC)" depending on context.
`AGENCY`	Property collects payment from the traveler. This method is also known as "Pay Later" and is sometimes referred to as "Hotel Collect" or "Property Collect" depending on the context.

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

Developer Tools

Reservation management

cancelReservation mutation

Syntax

Example

Arguments

Types

Availability and rates APIs

Booking APIs

Property mgmt APIs

Developer Tools

Reservation management

cancelReservation mutationCopy link

Syntax

Example

Arguments

Types

cancelReservation mutation