Creates a reservation in the sandbox environment. The mutation accepts arguments such as property ID, check-in and check-out dates, adult and child counts, and more, and it supports sending a webhook notification when the reservation is created. You can also create past, present, and future reservations. If not specified, reservation details are populated with logical test data, including the following:
Static, randomly generated guest names
Random guest credit card details
Unit and room type IDs are the same as the property ID
Rate and rate plan IDs are set to 202323288
To create reservations that align with the business models, be mindful of the following field values:
Lines that describe the physical street address. Two address lines are
supported, and 2-80 characters are allowed in the first address line. If a
second address line is provided 1-80 characters are allowed.
List of enumerated categories to restrict the authorized incidentals. This is
only used when authorizedExpense is provided with total_plus_incidentals
and restrictions on incidentals are desired.
For example, to allow any incidental expenses, specify authorized_expenses
equal to totalChargesAllowed and omit specifiedIncidentalExpenses.
T VCC is for pre-stay charges only (such as deposits, cancellation fees,
no-show fees). A physical card must be presented at check-in for any remaining
balance, as well as incidentals.
TOTAL_BOOKING_AMOUNT
Both pre-stay charges and the total booking amount are authorized, but
incidentals are not authorized. A physical card must be presented at check-in
for any incidentals.
TOTAL_PLUS_INCIDENTALS
Pre-stay, total booking, and incidental expenses are authorized. See
specifiedIncidentalExpenses. A physical card may be required for additional
incidental expenses.
SEE_AUTHORIZATION_FORM
"Property should refer to the authorization form that will be sent either by the card provider or the authorizing company.
Accessibility requests made by the guest for the reservation. Defaults to a
single accessibility text with value \"In-room accessibility (in select rooms)\".
Point of sale (POS) where the reservation was made; identities the affiliate
partner who sold the reservation to the traveler. If a traveler booked through
an Expedia site, or if the value was not provided by the partner, this field is null.
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.
Source of the reservation, such as Hotels.com, Egencia, Orbitz. Here
is a list of sources (values in the Expedia Collect column), though this list
is not exhaustive. Defaults to EXPEDIA
Text that is displayed to guests if there is a special request associated with
the reservation. Defaults to \"Expedia test reservation. This is a free-text
comment from the traveler.\".
Response payload to the `createReservation mutation.
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.
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.
Name of the issuer associated with the card. Sandbox value is \"VISA\" for
HOTEL_COLLECT reservations and \"MasterCard\" for EXPEDIA_COLLECT reservations.
Type of payment instrument. Sandbox value is \"GUEST_CREDIT_CARD\" for
HOTEL_COLLECT reservations and \"EXPEDIA_VIRTUAL_CARD\" for EXPEDIA_COLLECT reservations.
Expedia collects payment via bank transfer. This is for use for Expedia Collect properties only.
CASH
Partner collects cash payment. This is for use for Hotel Collect properties only.
EXPEDIA_VIRTUAL_CARD
Expedia collects payment by Expedia Virtual Card. This is for use for Expedia
Collect properties only. You can retrieve payment information using the Payments API.
GUEST_CREDIT_CARD
Property collects payment by guest credit card. This is for use for Hotel
Collect properties only, and you can retrieve payment information using the Payments API.
NONE
No payment instrument.
ReconciliationType
Enum
Type of reconciliation that has been performed on the reservation.
Name
Description
CANCEL
Reservation was cancelled.
MODIFY
Reservation was modified.
NO_SHOW
Reservation was marked as a no-show.
REFUND
Reservation was refunded.
ReconciliationTypeInput
Enum
Reconciliation type for the reservation.
Name
Description
CANCEL
Reservation was cancelled.
MODIFY
Reservation was modified.
NO_SHOW
Reservation was marked as a no-show.
REFUND
Reservation was refunded.
RemittanceType
Enum
Remittance type of the reservation.
Name
Description
GROSS
Gross remittance type.
NET
Net remittance type.
RemittanceTypeInput
Enum
Remittance type of the reservation.
Name
Description
GROSS
Gross remittance type.
NET
Net remittance type.
Reservation
Object
Reservation details.
Field
Description
accessibilityText
Not nullable.
Accessibility requests made by the guest for the reservation.
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.
createReservation mutation