ReferenceProperty status

property query

Root query that retrieves information about a single property, including its name, IDs, status, location, unit information, listing URLs, reservations, and promotions. This is the schema's entry point for all property-related queries.

Note: This query provides access to various capabilities, such as promotions and reservations. However, you must be granted access to each capability before you can code to it. Contact your Technical Relationship Manager if you are interested in more than property status.

Syntax

1query {
2 property(
3 id: String!,
4 idSource: IdSource
6}

Examples

Use the interactive GraphQL explorer in the following sections to run a sample query. A test property ID is passed into the explorer; its test data is returned. The GraphQL explorer will help you get comfortable with the GraphQL:

  • For each query, a test property ID is passed into the explorer; its test data is returned.
  • Click Run Query to execute the query in the explorer on the page. You can modify the query to retrieve the desired fields, and the explorer provides a list of fields when you start typing.
  • Click API Explorer to launch the full explorer in another tab/window, which provides syntax highlighting, schema introspection, real-time error highlighting, and auto-completion, among other things.

Additional examples are available on the Intro page.

Status and IDs

This query retrieves a property's status and IDs.

Response

Property address, location, and listing URLs

This query retrieves a property's address, geolocation, and listing URLs on Expedia and Vrbo.

Response

Arguments

NameDescription

id

Required.

Expedia ID (EID) or supplier ID (external ID in the partner's system) of the property.

If specifying the supplier ID for a Vrbo property, specify the ID in this format: systemId/advertiserId/listingExternalId.

  • For direct PM integrations, the value of systemId is “PM”.
  • For PMS integrations, this value represents the PMS originating the request.

If you are unsure of your system ID, contact your Engagement Manager or Technical Relationship Manager.

Type: String

idSource

Source system of the ID. EXPEDIA is the default value.

Type: IdSource

Types


Name
Type
AcknowledgementRecord
Object

Acknowledgement record for a bookable unit.

FieldDescription
acknowledgementType

Type of acknowledgement record.

Type: AcknowledgementType
id

ID of the acknowledgement record.

Type: String
lastUpdated

Date when the acknowledgment record was last updated.

Type: String
AcknowledgementType
Enum

Acknowledgement type values.

NameDescription
PLATFORM
LTR_POLICY
PLATFORM_ACK
PLATFORM_ACK_STATEMENT
PLATFORM_ATTESTATION
PLATFORM_ATTESTATION_LEGAL
PLATFORM_ATTESTATION_LINK
PLATFORM_ATTESTATION_NEVADA
PLATFORM_ATTESTATION_VER
PLATFORM_CERTIFY
PLATFORM_COMPLY
PLATFORM_JAPAN
PLATFORM_LEGAL
PLATFORM_READ
ActiveStatus
Object

Status of the property, including its checkpoints.

FieldDescription
activeNot nullable.

Whether the property is live on Expedia sites.

  • An Expedia property is inactive if one of these conditions is true:

    • Payment issues or overdue invoices
    • Compliance issues due to regulatory or tax mandates
    • Recontracting or change of ownership
    • Incomplete onboarding
    • Renovations
  • A Vrbo property (listing) is inactive if one of these conditions is true:

    • Property manager removed it from distribution
    • Marketplace violation occurred
    • Account is overdue
    • Minimum content is missing
Type: Boolean
statusCheckpointNot nullable.

Top-level property status derived from supporting checkpoints. Use this to determine if the property is inactive for reasons that are not content related.

Type: StatusCheckpoint
AdditionalDataRequirement
Object

Additional parameters to meet onboarding requirements.

FieldDescription
group

Grouping to which the field belongs, for UI layout purposes.

Type: String
groupLocalized

Description of the group, to be localized.

Type: String
isOptional

Whether the data is optional.

Type: String
keyNot nullable.

Field name for the information to be captured.

Type: String
keyLocalized

Description of the key, to be localized.

Type: String
subtype

Subtype of data.

Type: String
subtypeLocalized

Description of the subtype, to be localized.

Type: String
type

Type of data.

Type: String
typeLocalized

Description of the type, to be localized.

Type: String
Address
Object

Property address information.

FieldDescription
addressLinesNot nullable.

Lines that describe the physical street address.

Type: Array of non nullable String
administrativeArea

State or province of the property.

Type: String
countryCodeNot nullable.

Two-character ISO country code.

Type: CountryCode
localityNot nullable.

City or locality where the property is located.

Type: String
postalCodeNot nullable.

Postal code of the address.

Type: String
AggregatedReviewBrandScore
Object

Rating details by brand (website) where the reviews were collected.

FieldDescription
brandNameNot nullable.

Brand to which the aggregated score belongs.

Type: ReviewBrand
categoriesWithScoreNot nullable.

Aggregated (average) rating for each category of the review.

Type: Array of non nullable ReviewCategoryScore
totalReviewsCountNot nullable.

Total number of reviews collected.

Type: Int
AggregatedReviewsFiltersInput
InputObject

Parameters to filter aggregated ratings.

FieldDescription
brandNamesNot nullable.

Brands (websites) where the reviews were collected.

Type: Array of non nullable ReviewBrand
AggregatedReviewsResponse
Object

Details about the aggregated ratings.

FieldDescription
brandsWithScoresNot nullable.

Details by brand (website) where the reviews were collected.

Type: Array of non nullable AggregatedReviewBrandScore
ApplicableRegulations
Object

Additional registration information required by some districts.

FieldDescription
key

Identifier for additional information required by the district.

Type: ApplicableRegulationsKey
value

Value of the key required by the district.

Type: String
ApplicableRegulationsKey
Enum

Regulation key values.

NameDescription
LICENSE_DEPARTMENT_NAME

Name of the department in the issuing government body that approved the attribute (registration number).

LICENSE_GOVERNMENT_NAME

Name of the government body that issued the attribute.

LICENSE_HOLDER_NAME

Name of the person (holder) who holds the license, which may be different from the lodging partner.

LICENSE_HOLDER_STREET_ADDRESS_1

Street address of the person (holder) who holds the license, which may be different from the lodging partner.

LICENSE_HOLDER_STREET_ADDRESS_2

Secondary street address of the person (holder) who holds the license, which may be different from the lodging partner.

LICENSE_HOLDER_CITY

City of the person (holder) who holds the license, which may be different from the lodging partner.

LICENSE_HOLDER_PREFECTURE

Prefecture of the person (holder) who holds the license, which may be different from the lodging partner.

LICENSE_HOLDER_COUNTRY

County of the person (holder) who holds the license, which may be different from the lodging partner.

LICENSE_HOLDER_POSTAL

Postal code of the person (holder) who holds the license, which may be different from the lodging partner.

IS_VACATION_RENTAL
REGISTRATION_NUMBER
REGISTRATION_NUMBER_TYPE
AttachmentType
Enum

Exemption category types.

NameDescription
DRIVERS_LICENSE
AttachmentUrl
Object

Registration document information.

FieldDescription
key

Type of document referenced.

Type: AttachmentType
value

URL of the registration document file.

Type: String
BlackoutDateRange
Object
FieldDescription
travelDateFromNot nullable.

Travel start date for the exception (blackout) window in the YYYY-MM-DD format.

Type: LocalDate
travelDateToNot nullable.

Travel end date for the exception (blackout) window in the YYYY-MM-DD format.

Type: LocalDate
BookingLocalDateTimeInput
InputObject

Information about the booking date and time.

FieldDescription
from

Beginning date of the booking window (in the YYYY:MM:DDThhh:mm:ss format, in the property’s local time zone).

Type: LocalDateTime
to

End date of the booking window (in the YYYY:MM:DDThhh:mm:ss format, in the property’s local time zone).

Type: LocalDateTime
Boolean
Boolean

The Boolean scalar type represents true or false.

BusinessModel
Enum

Entity that collects payment.

NameDescription
EXPEDIA_COLLECT

Expedia collects payment.

HOTEL_COLLECT

Property collects payment.

CheckOutDateFilter
InputObject

Checkout date window for which to filter reservations. You can query for reservations up to 465 days in the past and up to 500 days in the future.

FieldDescription
fromNot nullable.

Date that defines the start of the checkout date window (format: YYYY-MM-DD).

Type: LocalDate
toNot nullable.

Date that defines the end of the checkout date window (format: YYYY-MM-DD).

Type: LocalDate
CheckpointFilterInput
InputObject

Parameters to filter checkpoints.

FieldDescription
result

Fulfillment status.

Type: Array of non nullable ResultFilter
Compliant
Object

Compliance status according to the local jurisdiction's regulatory requirements.

This object returns a non-compliant status for mandatory requirements only. If invalid information is provided for an optional regulatory requirement, or if regulatory information is set in a jurisdiction that does not require regulatory information, status: COMPLIANT will be returned. However, for optional requirements, a warning is returned in the warningStatus field when the data is set (using the updateUnitRegistration mutation).

FieldDescription
reasonNot nullable.

Reason why the unit is in or out of compliance. The label used for the registration number in this string comes from the numberTypeLabel field on the RegistrationNumberRequirement type.

Type: String
statusNot nullable.

Whether the unit is compliant or not.

Type: RegulatoryStatus
Coordinates
Object

Geographical location coordinates.

FieldDescription
latitudeNot nullable.

Latitudinal coordinates of property.

Type: Float
longitudeNot nullable.

Longitudinal coordinates of property.

Type: Float
CountryCode
CountryCode

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

CursorBasedPageInfo
Object

Information about the current page of results.

FieldDescription
endCursor

Value of the cursor of the last promotion in the current page.

Type: String
hasNextPageNot nullable.

Whether there are additional pages to retrieve.

Type: Boolean
DateInput
InputObject

Date range used to filter reviews.

FieldDescription
fromNot nullable.

Beginning date in this format: YYYY-MM-DD

Type: LocalDate
toNot nullable.

End date in this format: YYYY-MM-DD

Type: LocalDate
DateTime
DateTime

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.

DateTimeRangeFilterInput
InputObject

Date and time range.

FieldDescription
fromNot nullable.

Beginning date of the date range.

Type: DateTime
operator

Whether the dates are inclusive or exclusive of the to/from dates.

Type: RangeOperator
toNot nullable.

Ending date of the date range.

Type: DateTime
DayOfWeekDiscount
Object

Day-of-week discounts enable partners to set discount percentages for specific days of the week. The day fields specify the discount for that day of the week for the travel dates (such as Mondays at 15%, Tuesdays at 10% discount).

FieldDescription
fridayNot nullable.
Type: Float
mondayNot nullable.
Type: Float
saturdayNot nullable.
Type: Float
sundayNot nullable.
Type: Float
thursdayNot nullable.
Type: Float
tuesdayNot nullable.
Type: Float
typeNot nullable.

Type of discount.

Type: DiscountType
unitNot nullable.

Unit of the discount. Currently, PERCENT is supported when creating or updating a discount. AMOUNT is supported for queries only.

Type: DiscountUnit
wednesdayNot nullable.
Type: Float
Discount
Interface

Implemented by

FieldDescription
typeNot nullable.

Type of the discount.

Type: DiscountType
unitNot nullable.

Unit of the discount.

Type: DiscountUnit
DiscountPromotion
Object
FieldDescription
blackoutDates

Exception (blackout) dates for which the promotion should NOT apply. This field is only returned when querying for a single promotion (by specifying the promotion ID).

Type: Array of non nullable BlackoutDateRange
categoryNot nullable.

Category of the promotion. Currently, only DISCOUNT_PROMOTION is supported (such as Priced Promotions).

Type: PromotionCategory
codeNot nullable.

Promotion code that travelers will use to apply the promotion. This field is returned in our booking APIs if a reservation is created for a product that has an active promotion. It is returned in PromotionCode for the Booking Notification API and in promoName for Booking Retrieval API. Note that only these characters are supported: ​​a-z, A-Z, 0-9, ., ,, ', :, !, ?, $, %, (, ), /, -, and space.

Type: String
discount

Detail of the discount being applied on the promotion.

Type: Discount
eligibleRatePlansNot nullable.

Rate plans for which this promotion is applicable.

Type: Array of non nullable EligibleRatePlan
idNot nullable.

ID of the promotion stored in the Expedia platform.

Type: ID
isContractedPromotion

Whether the promotion is negotiated. (Negotiated promotions cannot be updated.)

Type: Boolean
nameNot nullable.

Name of the promotion.

Type: PromotionName
restrictions

List of restrictions that can be applied to these promotions.

Type: Restrictions
sellStatus

Whether the promotion is currently bookable based on the its reservation date/time range. This field is supported in queries only. All dates and times are relative to the property’s time zone. The promotion may still be unavailable due to other restrictions. At the time of querying, if the promotion's bookingLocalDateTimeFrom and bookingLocalDateTimeTo values are in the past but the travelDateFrom and travelDateTo values are in the future, the promotion is considered expired because the promotion can no longer be made available.

Type: PromotionSellStatus
statusNot nullable.

Status of the promotion.

Type: PromotionStatus
DiscountType
Enum

Discount type values.

NameDescription
DAY_OF_WEEK_DISCOUNT

Discount that is applicable for specific days of the week within the travel window.

MULTI_NIGHT_DISCOUNT

Discount that is applied to multi-night stays.

SINGLE_DISCOUNT

A single discount.

DiscountUnit
Enum
NameDescription
PERCENT

Percentage discount for the promotion.

AMOUNT

Amount-based discount for the promotion.

District
Object

District regulatory information.

FieldDescription
description

Description of the district regulation.

Type: String
idNot nullable.

District ID (such as Miami Beach).

Type: String
legalPropertyTypesNot nullable.

List of legal property types.

Type: Array of LegalPropertyType
localizedName

Localized district name that can be used for display.

Type: String
nativeLocale

Four-character locale code (language and country codes) of property's local district (such as fr_FR for a property in France).

Type: String
referenceUrls

URL to jurisdiction regulation information.

Type: Array of String
registrationRequiredNot nullable.

Whether registration is required by the jurisdiction. This is based on the geo code of the property’s address, not the property type (for example, registration may be required for a hotel but not a vacation rental in a specific area).

Type: Boolean
requirements

Jurisdiction regulations that the partner needs to meet to comply with onboarding.

Type: Array of JurisdictionRequirement
EligibleRatePlan
Object
FieldDescription
idNot nullable.

ID of the rate plan stored in the Expedia platform.

Type: ID
EmailAddress
EmailAddress

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

Exemption
Object

Exemption to jurisdiction requirements.

FieldDescription
category

Exemption type.

Type: ExemptionCategory
description

Description of the exemption.

Type: String
ExemptionCategory
Enum

Exemption types.

NameDescription
MAX_NIGHT_CAP
ExpediaSupplierAmount
Object
FieldDescription
currencyCodeNot nullable.

Currency in which the amount is shown.

Type: String
ratesNot nullable.

Nightly rates for the reservation.

Type: Array of non nullable SupplierRate
rateTypeNot nullable.

Rate type: NET for Expedia Collect or SELL for Hotel Collect.

Type: RateType
totalNot nullable.

Total rates for the reservation.

Type: SupplierTotal
FiltersInput
InputObject

Parameters used to filter results of the promotions query. Note that if you filter results by promotion ID, you cannot specify addition filters.

FieldDescription
bookingLocalDateTime

Reservation date and time being queries for. Format is YYYY-MM-DDThh:mm:ss, in the property’s local time zone.

Type: BookingLocalDateTimeInput
discountTypes

Type of the discount. Currently, only single discounts are supported (flat discount percentage, such as 15% off).

Type: Array of non nullable DiscountType
id

ID of the promotion stored in the Expedia platform.

Type: String
status

Status of the promotions.

Type: PromotionStatus
travelDate

Travel date window being queried for.

Type: TravelDateInput
Float
Float

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

Guest
Object
FieldDescription
emailAddress

Guest's email address.

Type: EmailAddress
firstNameNot nullable.

Guest's first (given) name.

Type: String
lastNameNot 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.

FieldDescription
areaCodeNot nullable.

Area code (three digits).

Type: String
countryCodeNot nullable.

Country code (two digits).

Type: String
numberNot nullable.

Phone number (seven digits, no hyphen).

Type: String
ID
ID

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.

FieldDescription
id

ID in the source system.

Type: ID
idSourceNot nullable.

Source of the ID.

Type: IdSource
IdNodeInput
InputObject

Reservation ID and its source.

FieldDescription
idNot nullable.

ID in the source system.

Type: ID
idSourceNot nullable.

Source of the ID.

Type: ReservationIdSource
IdSource
Enum

Source of a given ID.

NameDescription
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
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.

FieldDescription
reasonNot nullable.

Description of why the reservation is ineligible for reconciliation.

Type: String
scenarioNot 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
JurisdictionRequirement
Object

Jurisdiction regulations that the partner needs to meet to comply with onboarding.

FieldDescription
additionalDataRequirements

Additional required regulation data by jurisdiction, such as license holder name or property address.

Type: Array of AdditionalDataRequirement
exemptions

Exemptions of a requirement under certain conditions.

Type: Array of Exemption
isVacationRental

Whether this regulatory category is a vacation rental.

Type: Boolean
maxNightCap

Maximum number of nights allowed by the jurisdiction. null means no requirement.

Type: MaxNightCap
minStayNightsNot nullable.

Minimum number of stay nights for this category (default is 1).

Type: Int
qualifiedPropertyTypes

Regulation requirement that Expedia and Vrbo support.

Type: Array of LegalPropertyType
registrationNumberRequirements

List of registration number requirements.

Type: Array of non nullable RegistrationNumberRequirement
regulatoryCategory

Property regulatory category where the registration number requirements apply.

Type: RegulatoryCategory
regulatoryCategoryLabel

Localized string of the regulatory category.

Type: String
LastUpdatedDateTimeFilter
InputObject

Date and time window when a reservation was last updated.

FieldDescription
fromNot nullable.

Starting date and time when the reservation was last updated (format: YYYY-MM-DDTHH:mm:ssTZD, TZD is a time zone designator in the form +/-hh:mm).

Type: ZoneDateTime
toNot nullable.

Ending date and time when the reservation was last updated (format: YYYY-MM-DDTHH:mm:ssTZD, TZD is a time zone designator in the form +/-hh:mm).

Type: ZoneDateTime
LegalPropertyType
Object

Property type for the district. This type provides what’s possible for the district. Then, qualifiedPropertyTypes indicates the type and subtype at the unit level. If subtype is set for the property, you should use both type and subtype.

FieldDescription
subtype

Legal property subtype, applicable for residences, such as primary home or secondary home. (This field provides the value that is specified in the registration:details:regulatorySubType field of the updateUnitRegistration mutation.)

Type: String
type

Legal property type, such as hotel, bed and breakfast, residence, etc. (This field provides the value that is specified in the registration:details:regulatoryType field of the updateUnitRegistration mutation.)

Type: String
LocalDate
LocalDate

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

LocalDateTime
LocalDateTime

A type representing a date and time (such as 2007-12-03T10:15:30).

Locale
Locale

A type that represents a string that conforms to the BCP-47 (RFC 5646) standard. Example: en-GB.

LocalizedString
Object

Localized text and its locale code.

FieldDescription
localeNot nullable.

Locale code used to localize the text, which conforms to the BCP-47 (RFC 5646) standard, such as fr-FR.

Type: Locale
valueNot nullable.

Localized text.

Type: String
LocalTime
LocalTime

A type representing a time in this format: HH:mm:ss or HH:mm (such as 10:15:30 or 10:15).

MaxNightCap
Object

Maximum night cap parameters for the jurisdiction.

FieldDescription
annualLimit

Annual night cap.

Type: Int
isEnforced

Whether the cap is enforced (or just informational).

Type: Boolean
MessageThread
Object

Message thread details, including IDs, creation time, messages, and reservation information.

FieldDescription
bookingInquiry

Booking inquiry associated with the message thread. null is returned for non-Vrbo properties.

Type: MessageThreadBookingInquiry
creationDateTimeUtc

Message creation date time in ISO format (yyyy-MM-dd'T'HH:mm:ss.SSSZ) and UTC timezone.

Type: DateTime
idNot nullable.

Message thread ID.

Type: ID
messagesNot nullable.

List of messages in the message thread. You can specify these arguments:

  • limit (type: Int), which enables you to limit the number of messages retrieved (up to 50).
  • cursor (type: String), which is the cursor value for this edge.
Type: MessageThreadMessagesResponse
primaryTraveler

Primary guest's name.

Type: MessageThreadTraveler
propertyNot nullable.

Representation of a physical property, including its message threads and messages.

Type: Property
reservationSummary

Information about the reservation after it is made. This will be null until the reservation is made.

Type: MessageThreadReservationSummary
MessageThreadAttachment
Object

Attachment details.

FieldDescription
idNot nullable.

Attachment ID.

Type: ID
nameNot nullable.

Attachment file name.

Type: String
uploadDateTimeUtcNot nullable.

Date and time when the file was uploaded in ISO format (yyyy-MM-dd'T'HH:mm:ss.SSSZ) and UTC timezone.

Type: DateTime
urlNot nullable.

Attachment location.

Type: Url
MessageThreadBookingInquiry
Object

Booking inquiry information. These details are not available for non-Vrbo properties.

FieldDescription
adultCountNot nullable.

Number of adults included in the reservation.

Type: Int
checkInDate

Requested check-in date in the booking inquiry.

Type: LocalDate
checkOutDate

Requested checkout date in the booking inquiry.

Type: LocalDate
childCountNot nullable.

Number of children included in the reservation.

Type: Int
hasPetsNot nullable.

Whether pets are included in the reservation.

Type: Boolean
idNot nullable.

Booking inquiry ID. We recommend that you store this ID to reconcile the message thread with the inquiry ID provided in the booking request.

Type: ID
MessageThreadLocalizedString
Object

Localized message text.

FieldDescription
valueNot nullable.

Localized message text.

Type: String
MessageThreadMessage
Object

Message details.

FieldDescription
attachmentsNot nullable.

List of attachments associated with this message

Type: Array of non nullable MessageThreadAttachment
body

Localized message body.

Type: MessageThreadLocalizedString
creationDateTimeUtc

Date and time when the message was created in ISO format (yyyy-MM-dd'T'HH:mm:ss.SSSZ) and UTC timezone.

Type: DateTime
fromRole

Role of the participant who has inserted the message.

Type: MessageThreadParticipantRole
idNot nullable.

Message ID in our system.

Type: ID
messageThreadNot nullable.

Associated message thread for the message.

Type: MessageThread
type

Message type. The following values are returned, which indicate various actions:

  • FREE_TEXT - Text response was sent from the traveler or lodging partner.
  • BOOKING - Traveler reserves a property.
  • SUPPLIER_CONFIRMED_BOOKING - Lodging partner confirms the reservation.
  • TRAVELER_CANCELLED_BOOKING - Traveler cancels a reservation.
  • SUPPLIER_CANCELLED_BOOKING - Lodging partner cancels a reservation.
  • SUPPLIER_CANCEL_CONFIRMED - Lodging partner confirms the cancellation.
  • TRAVELER_REQUESTED_BOOKING_EDIT - Traveler requests a change to a reservation.
  • SUPPLIER_EDITED_BOOKING - Lodging partner modified a reservation.
  • FILE - An attachment was sent, typically without sending a message.
Type: String
MessageThreadMessagesResponse
Object

Messages and metadata about messages in the message thread.

FieldDescription
cursor

Next page cursor in the list; empty if no more pages are available.

Type: String
elementsNot nullable.

List of messages.

Type: Array of non nullable MessageThreadMessage
totalCountNot nullable.

Total number of messages returned that meet the filter criteria.

Type: Int
MessageThreadParticipantRole
Enum

Role of the participant who has inserted the message.

NameDescription
TRAVELER
SUPPLIER
MessageThreadReservationSummary
Object

Information about the reservation associated with the message. These details are not available until the reservation is made.

FieldDescription
adultCountNot nullable.

Number of adults included in the reservation.

Type: Int
alternativeIdsNot nullable.

Partner's (supplier) ID for the reservation.

Type: ReservationAlternativeIds
checkInDateNot nullable.

Reservation check-in date.

Type: LocalDate
checkOutDateNot nullable.

Reservation checkout date.

Type: LocalDate
childCountNot nullable.

Number of children included in the reservation.

Type: Int
idNot nullable.

For properties onboarded onto Expedia, this is the Expedia reservation ID. For properties onboarded onto Vrbo, this is the Vrbo internal reservation UUID.

Type: ID
petCountNot nullable.

Number of pets included in the reservation. This is supported for Vrbo properties only.

Type: Int
MessageThreadsResponse
Object

Message threads retrieved for a property.

FieldDescription
cursor

Next page cursor in the list; empty if no more pages are available.

Type: String
elementsNot nullable.

List of message threads.

Type: Array of non nullable MessageThread
totalCountNot nullable.

Total number of message threads returned that meet the filter criteria.

Type: Int
MessageThreadTraveler
Object

Primary guest's name.

FieldDescription
firstName

Guest's first (given) name.

Type: String
lastName

Guest's last name (surname).

Type: String
MultiNightDiscount
Object

Multi-night discounts offer percentage-based discounts for applicable nights (such as 15% off a third night).

FieldDescription
applicableNightNot nullable.

Value of the applicable night to which the discount is applied. Permitted values are 2 to 28.

Type: Int
isRecurring

Whether the discount applied on the applicable night is recurring. For example, if applicableNight is set to 3 and isRecurring is set to true, the discount will be applied to the third, sixth, ninth nights (and so on).

Type: Boolean
memberOnlyAdditionalValue

Additional discount that is added to value for members only. For example, if value is 10, unit is PERCENT, and memberOnlyAdditionalValue is 5, members are offered 15 percent off.

Type: Float
typeNot nullable.

Type of discount.

Type: DiscountType
unitNot nullable.

Unit of the discount. Currently, PERCENT is supported when creating or updating a discount. AMOUNT is supported for queries only.

Type: DiscountUnit
valueNot nullable.

Value of the discount applied.

Type: Float
OwnerResponse
Object

Review response submitted by the partner.

FieldDescription
bodyNot nullable.

Localized response text.

Type: LocalizedString
createdDateTimeNot nullable.

Date and time (in UTC, format: YYYY-MM-DDThh:mm:ssTZD) when this response was created.

Type: String
lastUpdatedDateTimeNot nullable.

Date and time (in UTC, format: YYYY-MM-DDThh:mm:ssTZD) when this response was updated.

Type: String
statusNot nullable.

Status of the response. The following values may be returned: APPROVED, BEFORE_SUBMITTED_FOR_MODERATION, QUEUED_FOR_LANG_DETECT, REJECTED, BEFORE_SUBMITTED_TO_ES, SUBMITTED, and REMOVEDBYCLIENT.

Be aware that reviews may be pending for up to 14 days depending on lodging partner actions and review content.

Type: String
PageInfo
Object

Information about the current page of results.

FieldDescription
endCursor

Value of the cursor of the last result on the current page.

Type: String
hasNextPageNot nullable.

Whether additional pages can be retrieved.

Type: Boolean
Payment
Object

Payment details.

FieldDescription
instructionsNot nullable.

Text that is displayed to travelers if a payment type is associated with the reservation.

Type: String
Promotion
Interface

Implemented by

FieldDescription
categoryNot nullable.

Category of the promotion. Currently, only DISCOUNT_PROMOTION is supported (such as Priced Promotions).

Type: PromotionCategory
idNot nullable.

ID of the promotion stored in the Expedia platform.

Type: ID
isContractedPromotion

Whether the promotion is negotiated. (Negotiated promotions cannot be updated.)

Type: Boolean
nameNot nullable.

Name of the promotion.

Type: PromotionName
sellStatus

Whether the promotion is currently bookable based on the its reservation date/time range. This field is supported in queries only. All dates and times are relative to the property’s time zone. The promotion may still be unavailable due to other restrictions. At the time of querying, if the promotion's bookingLocalDateTimeFrom and bookingLocalDateTimeTo values are in the past but the travelDateFrom and travelDateTo values are in the future, the promotion is considered expired because the promotion can no longer be made available.

Type: PromotionSellStatus
statusNot nullable.

Status of the promotion.

Type: PromotionStatus
PromotionCategory
Enum
NameDescription
DISCOUNT_PROMOTION

Priced (discount) promotion. That is, the traveler benefit here is monetary savings via promotions.

PromotionName
Enum
NameDescription
BASIC_PROMOTION

Flexible offer with restrictions defined by the connectivity or lodging partner. You can specify this value when creating or updating single and day-of-week discounts.

EARLY_BOOKING_PROMOTION

Discount offered to travelers who want to book early. You can specify this value when creating or updating single and day-of-week discounts only.

MULTI_NIGHT_PROMOTION

Multi-night discount that offers a percentage-based discount for applicable nights. You can specify this value when creating or updating multi-night discounts only.

SAME_DAY_PROMOTION

Discount offered to attract last-minute travelers by setting up a recurring deal when the travel date is the same as the booking date. You can specify this value when creating or updating single discounts only.

PromotionNode
Object
FieldDescription
cursorNot nullable.

Cursor value for this edge.

Type: String
nodeNot nullable.

Node that references the promotion data.

Type: Promotion
Promotions
Object
FieldDescription
edgesNot nullable.

Edges in the connection to traverse, each containing a cursor and node.

Type: Array of non nullable PromotionNode
pageInfoNot nullable.

Information about the current page of results.

Type: CursorBasedPageInfo
totalCountNot nullable.

Total number of promotions returned that meet the search criteria.

Type: Int
PromotionSellStatus
Enum

Values to indicate whether a promotion is currently bookable based on the its reservation date/time range.

NameDescription
EXPIRED

Promotion cannot be booked because today’s date is after the promotion's bookingLocalDateTimeTo.

CURRENT

Promotion can be booked because today’s date is between the promotion's bookingLocalDateTimeFrom and .bookingLocalDateTimeTo.

FUTURE

Promotion cannot be booked yet because today's date is before the promotion's bookingLocalDateTimeFrom. However, this promotion will become available to book in the future.

PromotionStatus
Enum
NameDescription
ACTIVE
INACTIVE
Property
Object

Representation of a physical property, including its units, reservations, and promotions.

FieldDescription
activeStatus

Status of the property on all platforms and property content. It indicates whether the property is live or not.

Type: ActiveStatus
address

Physical street address of the property.

Type: Address
aggregatedReviews

Aggregated (average) ratings for the property. You can filter the results by brand name (website) using the filters argument (AggregatedReviewsFiltersInput input type).

Type: AggregatedReviewsResponse
coordinatesNot nullable.

Geographical location of the property.

Type: Coordinates
district

Regulatory requirements and parameters that apply to the property. You can specify the locale argument to retrieve the results in a specific language; specify the four-letter ISO code for language. Use a four-character code that indicates language and region, such as fr_FR for French in France.

Type: District
idNot nullable.

Expedia ID of the property.

Type: ID
ids

Known IDs for the property 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 IdNode
listingsNot nullable.

Traveler-facing listing URLs of the property on the requested domains. Specify the domains argument (type: String!) and provide one or both of these values: expedia.com, vrbo.com. If you specify expedia.com, the API returns a listing URL if the property exists an Expedia site. If you specify vrbo.com, a listing URL is returned if the property exists on a Vrbo site.

Type: Array of non nullable PropertyListing
messages

List of messages in a message thread. You can specify these arguments:

  • limit (type: Int), which specifies the number of messages to retrieve (up to 10).
  • cursor (type: String), which is the cursor value for the page of results to retrieve.
  • filters (type: PropertyMessagesFiltersInput!), which specifies the creation date range to use to filter results.
Type: MessageThreadMessagesResponse
messageThreadsNot nullable.

List of message threads for a property. You can specify these arguments:

  • limit (type: Int), which specifies the number of message threads to retrieve (up to 10).
  • cursor (type: String), which is the cursor value for the page of results to retrieve.
  • filters (type: PropertyMessageThreadsFiltersInput!), which specifies the creation date range to use to filter results.
Type: MessageThreadsResponse
name

Human-readable name of the property.

Type: String
promotions

List of promotions that matches the specified arguments. You can specify these arguments:

  • filter (type: FiltersInput), which enables you to refine the promotions to retrieve. Note that if you filter results by promotion ID, you cannot specify addition filters.
  • pageSize (type: Int!), which is required and specifies the maximum number of promotions on each page (up to 25) returned by the response. For example, if there are 40 promotions on a property, you can retrieve two pages if this argument is set to 25 (page 1 includes 25 promotions, page 2 includes 15 promotions).
  • after (type: String), which is the cursor from the previous query response that marked the end of the previous page of results.
Type: Promotions
reservations

List of the property's reservations that match the specified arguments:

  • filter (type: ReservationFilterInput), which enables you to refine the reservations to retrieve. If this argument is not specified, the query returns all reservations for the property.
  • pageSize (type: Int!), which is required and specifies the maximum number of reservations on each page (up to 25) returned by the response. For example, if there are 40 reservations on a property, you can retrieve two pages if this argument is set to 25 (page 1 includes 25 reservations, page 2 includes 15 reservations).
  • after (type: String), which is the cursor from the previous query response that marked the end of the previous page of results.
Type: ReservationsConnection
reviewsNot nullable.

Reviews provided by travelers for the property that match the specified arguments. You can specify these arguments:

  • filter (type: ReviewFilter), which provides additional arguments to filter the reviews that are returned by the query.
  • pageSize (type: Int!), which is required and specifies the maximum number of reviews on each page (up to 10) returned by the response. For example, if there are 15 reviews on a property, you can retrieve two pages if this argument is set to 10 (page 1 includes 10 reviews, page 2 includes 5 reviews).
  • after (type: String), which is the cursor from the previous query response that marked the end of the previous page of results.
  • orderBy (type: ReviewsOrderBy), which provides the sort order of results; only one field should be specified. If not specified, reviews are sorted by review creation dateTime.
Type: ReviewResponse
units

Collection of unit configurations available for the property.

Type: Array of Unit
PropertyListing
Object

Locale and URL of the listing on the specified domain(s).

FieldDescription
locale

Locale for the property listing on the requested domain.

Type: String
url

URL if the property is enabled on the requested domain.

Type: String
PropertyMessagesFiltersInput
InputObject

Creation date range to use to filter results.

FieldDescription
creationDateTimeNot nullable.

Date range to use when filter results.

Type: DateTimeRangeFilterInput
PropertyMessageThreadsFiltersInput
InputObject

Creation date range to use to filter results.

FieldDescription
creationDateTimeNot nullable.

Date range to use when filter results.

Type: DateTimeRangeFilterInput
Purpose
Enum

Purpose of the requirement.

NameDescription
DATA_SHARING
RangeOperator
Enum

"Values that indicate whether the specified dates are inclusive or exclusive.

NameDescription
INCLUSIVE

Includes messages or message threads that occurred on the specified dates in the results.

EXCLUSIVE

Excludes messages or message threads that occurred on the specified dates in the results.

RateTimeUnit
Enum

Time frame to which the rate is applied.

NameDescription
PER_DAY

Rate is applied per day.

PER_WEEK

Unsupported at this time.

PER_STAY

Unsupported at this time.

RateType
Enum
NameDescription
NET

Net amount (excludes compensation and taxes).

SELL

Gross amount (includes compensation and taxes).

Rating
Object

Star rating of the specified category as submitted by the traveler.

FieldDescription
categoryNot nullable.

Category to which the rating applies:

  • checkIn
  • overall
  • location
  • communication
  • house_rules
  • onlineListing
  • cleanliness
  • roomCleanliness
Type: String
valueNot nullable.

Value of the rating, from 1 (terrible) to 5 (excellent).

Type: String
ReconEligibility
Object

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

FieldDescription
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
Registration
Object

Government registration information for the unit or room type.

FieldDescription
applicableRegulations

Additional registration information required by certain districts.

Type: Array of non nullable ApplicableRegulations
completeNot nullable.

Checks the consistency of the information in our systems at the property level to determine whether the registration information is sufficient to fulfill the requirements of the property's district. We do not recommend including this field in the query because it does not provide the true value for some properties.

If false is returned for a unit, you can use the Product API to identify active units, though false may be returned for inactive units that have incorrect regulatory information.

Type: Boolean
detailNot nullable.

Detailed registration information for the unit or room type.

Type: RegistrationDetail
district

Geographical jurisdiction identifier. For non-configured districts, this is null.

Type: String
RegistrationDetail
Object

Registration information for the unit or room type.

FieldDescription
acknowledgementRecordsNot nullable.

Acknowledgement records for the bookable unit. These are displayed to the traveler to confirm that they understand the regulatory requirements.

Type: Array of non nullable AcknowledgementRecord
applicableRegulationsNot nullable.

Additional information about the bookable unit required by certain districts.

Type: Array of non nullable ApplicableRegulations
attachmentUrls

Links for registration documentation files (if required).

Type: Array of non nullable AttachmentUrl
compliant

Compliance status according to the local jurisdiction's regulatory requirements.

This object returns a non-compliant status for mandatory requirements only. If invalid information is provided for an optional regulatory requirement, or if regulatory information is set in a jurisdiction that does not require regulatory information, status: COMPLIANT will be returned. However, for optional requirements, a warning is returned in the warningStatus field when the data is set (using the updateUnitRegistration mutation).

Type: Compliant
displayRegistrationNumber

Registration number displayed to the traveler.

Type: String
exemptionCategories

List of exemptions for the property, such as maximum night cap.

Type: Array of non nullable ExemptionCategory
numberOfPhysicalRooms

Number of rooms in the bookable unit.

Type: Int
registrationRecordsNot nullable.

Registration records for the bookable unit filed with the governing jurisdiction.

Type: Array of non nullable RegistrationRecord
regulatoryCategoryNot nullable.

Property classification category as maintained by the governing jurisdiction.

Type: RegulatoryCategory
regulatoryCategoryLabelNot nullable.

Regulatory category in the specified locale.

Type: String
regulatorySubType

Property subtype, such as primary or secondary, or null if not applicable.

Type: String
regulatoryType

Property type, such as residence, condo, boat, etc.

Type: String
unitIdNot nullable.

Expedia ID of the unit or room type.

Note: We strongly recommend that you include this field in your implementation even though it is nullable. This field provides an audit trail for reporting purposes.

Type: ID
RegistrationNumberRequirement
Object

Registration requirement.

FieldDescription
allowPendingRegistrationsNot nullable.

Whether properties with pending registration applications are allowed to list.

Type: Boolean
format

Example(s) of the registration requirement's value.

Type: String
isExpirationDateRequiredNot nullable.

Whether an expiration date must be set for the registration requirement.

Type: Boolean
isOptionalNot nullable.

Whether the registration requirement is optional.

Type: Boolean
localName

Localized display name of the registration requirement as shown in the Vrbo dashboard or Expedia Partner Central (such as みんぱく for Japan Minpaku).

Type: String
numberType

Registration requirement type. (This field provides the value that must be specified in the registration:details:registrationRecords:registrationNumberType field of the updateUnitRegistration mutation.)

Type: RegistrationNumberType
numberTypeLabel

Label used to describe the registration requirement in the Vrbo dashboard and Expedia Partner Central.

Type: String
purpose

Purpose of this requirement, if other than common regulatory validations.

Type: Purpose
regex

Regular expression used to validate the syntax of the registration requirement's value.

Type: String
thirdPartyValidation

Information about external validation parameters, if required for the registration requirement.

Type: ThirdPartyValidation
url

URL of a page that provides information about the registration requirement.

Type: String
RegistrationNumberType
Enum

Types of registration numbers (licenses).

NameDescription
LICENSE_NUMBER
LICENSE_ID
PARTIAL_TAX_ID
REGISTRATION_NUMBER
BUSINESS_LICENSE_NUMBER
OPERATOR_LICENCE_ID
OPERATOR_LICENSE_ID
BUSINESS_TAX_ID
RESORT_TAX_ID
SHORT_TERM_RENTAL_LICENSE
PERMIT_NUMBER
PLANNING_NUMBER
HOTEL_LICENSE
IS_IN_ZONING_PLAN
IS_PROFESSIONAL_HOST
TOURIST_DEVELOPMENT_TAX_ACCOUNT_NUMBER
HOME_SHARING_NUMBER
HOME_SHARING_PERMIT_NUMBER
CERTIFICATE_OF_USE_NUMBER
GENERAL_EXCISE_TAX_ID
TRANSIENT_ACCOMMODATIONS_TAX_ID
REGISTRATION_CERTIFICATE_NUMBER
PROPERTY_REGISTRY_NUMBER
SPECIAL_OPERATION_SIGN
TRANSIENT_REGISTRATION_NUMBER
PROVINCIAL_TOURIST_IDENTIFICATION_CODE
PARCEL_NUMBER_TAX_MAP_KEY
BUSINESS_TAX_RECEIPT_NUMBER
OPERATOR_LICENSE_NUMBER
OPERATOR_PERMIT
OWNER_PERMIT
TAX_IDENTIFICATION_NUMBER
MA_REGISTRATION_CERTIFICATE_NUMBER
BOSTON_REGISTRATION_NUMBER
OWNER_NAME
CADASTRAL_REFERENCE
OWNER_IS_CITIZEN
OWNER_ID
ZIPCODE
HOUSE_NUMBER
IS_CONDITION
ENTITY_TYPE
IS_TRADED
IS_GOVERNMENT_ENTITY
IS_ADDRESS_IN_EU
IS_RESIDENCE_IN_EU
LEGAL_ADDRESS
ISSUED_TAX_ID
PERMANENT_ESTABLISHMENT_COUNTRY
BUSINESS_REGISTRATION_NUMBER
LAND_REGISTRATION_NUMBER
BIRTH_DATE
IS_VAT_REGISTERED
VAT_ID
DATE
CITIZEN_ID
FOREIGN_ID
NEIGHBORHOOD_NAME
NATIONAL_ADDRESS_NUMBER
FLOOR_SYSTEM_NUMBER
JOURNAL_NUMBER
IS_ZONING_LAW_APPLIED
APPLICATION_NUMBER
ISSUANCE_DATE
RegistrationRecord
Object

Registration record for the bookable unit that has been filed with the jurisdiction.

FieldDescription
expiry

Registration record expiration date in this format: yyyy-mm-dd

Type: String
registrationNumberNot nullable.

Registration record ID.

Type: String
registrationNumberType

Type of registration/license.

Type: RegistrationNumberType
registrationNumberTypeLabel

Localized registration number type.

Type: String
RegulatoryCategory
Enum

Category values for regulatory categories. Most of jurisdiction districts only allow for two categories, HOTEL and VACATION_RENTAL, though more values GRAPHQL_VALIDATION_FAILED are provided to satisfy local government requirements.

NameDescription
HOTEL
BED_AND_BREAKFAST
HOTEL_OR_BNB
PRIMARY_HOME
PRIMARY_HOME_WITH_EXCEPTION
SECONDARY_HOME
VACATION_RENTAL
LONG_TERM_ONLY
SHORT_TERM_RENTAL
MINPAKU
SIMPLE_LODGING
EVENT
SPECIAL
NO_LICENSE
HOTEL_RYOKAN
RYOKAN
PRIMARY_OR_SECONDARY
TRANSIENT_OCCUPANCY_RESIDENTIAL_STRUCTURE
MOTEL
HOME_SHARING_NUMBER
VACATION_RENTAL_OTHER
HOSTEL
CAMPING_SITES
RURAL_LODGING
APARTMENT_HOTEL
RegulatoryStatus
Enum

Values for regulatory status.

NameDescription
COMPLIANT

Unit meets all regulatory requirements.

COMPLIANT_ACTION_NEEDED

Unit meets requirements to remain listed but will need to provide additional information (or other action) in order to not be delisted.

NOT_COMPLIANT

Unit does not meet all regulatory requirements and cannot be shown.

NOT_COMPLIANT_ACTION_NEEDED

Unit is not compliant, but enforcement hasn't started yet. Action should be taken for the listing to be compliant after enforcement date.

NOT_ALLOWED

Platform does not allow units in this jurisdiction; no actions from partner can affect status.

NONE

Unit's status cannot be determined.

Reservation
Object

Reservation details.

FieldDescription
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
adultCountNot nullable.

Count for all adult guests associated with the reservation.

Type: Int
bedTypes

Bed type of the reservation.

Type: String
businessModelNot nullable.

Entity that collects payment for the reservation.

Type: BusinessModel
checkInDateNot nullable.

Check-in date (format: YYYY-MM-DD) of the reservation.

Type: LocalDate
checkOutDateNot nullable.

Checkout date (format: YYYY-MM-DD) of the reservation.

Type: LocalDate
childAges

Ages of children associated with the reservation.

Type: Array of Int
childCountNot nullable.

Count for all child guests associated with the reservation.

Type: Int
creationDateTimeNot 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
lastUpdatedDateTimeNot 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
paymentNot nullable.

Text that is displayed to travelers if a payment type is associated with the reservation.

Type: Payment
paymentInstructionsNot nullable.

Instructions that describe how to retrieve payment for the reservation.

Type: String
primaryGuestNot nullable.

Guest who made the reservation.

Type: Guest
rateIdsNot 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
reservationIdsNot nullable.

IDs associated with the reservation and the source of the IDs.

Type: Array of non nullable IdNode
smokingTypeNot nullable.

Whether smoking is allowed for the reservation.

Type: String
sourceNot nullable.

Source of the reservation.

Type: String
specialRequest

Text that is displayed to guests if there is a special request associated with the reservation.

Type: String
statusNot 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
totalGuestCountNot nullable.

Total number of guests associated with the reservation.

Type: Int
unitIdsNot 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
valueAddedPromotionsNot 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
ReservationAlternativeIds
Object

Partner's (supplier) IDs for the reservation.

FieldDescription
supplierIdNot nullable.

For properties onboarded onto Expedia, this is the partner’s confirmation ID for the booking.

For properties onboarded onto Vrbo, this is the partner’s supplier ID. This ID may be prefixed with “HA-” to indicate a platform reservation. Two scenarios account for this:

  • If the lodging partner was a former platform PM and has upcoming reservations that were made prior to their conversion to integrated lodging partner.
  • The lodging partner uses using a third-party calendar sync application, such as Hospitable, which may create platform bookings. To resolve this, the partner must disable the third-party application.
Type: ID
ReservationEdge
Object
FieldDescription
cursorNot nullable.

Cursor value for this edge.

Type: String
nodeNot nullable.

Node that references the reservation data.

Type: Reservation
ReservationFilterInput
InputObject

Parameters used to filter reservations. If more than one filter is specified, the intersection of the filters is returned.

FieldDescription
checkOutDate

Checkout date window for which to filter reservations. Example:

checkOutDate: { from: "2021-08-05", to: "2021-08-07" }
Type: CheckOutDateFilter
lastUpdatedDateTime

Date and time when the reservation was last updated. Compare this value to that of creationDateTime to determine if a reservation has been modified.Example:

 lastUpdatedDateTime: {
    "from": "2022-03-02T10:23:17Z",
    "to": "2022-06-08T12:00:00Z"
  }
Type: LastUpdatedDateTimeFilter
reservationIds

IDs of the reservations to retrieve. Example to retrieve two reservations based on their IDs:

reservationIds: [
  {
    "id": "123HotelCode",
    "idSource": "SUPPLIER"
  },
  {
    "id": "456HotelCode",
    "idSource": "SUPPLIER"
  }
]
Type: Array of non nullable IdNodeInput
ReservationIdSource
Enum

Source system of the reservation ID.

NameDescription
EXPEDIA
VRBO
SUPPLIER
ReservationsConnection
Object

Logical connection to reservations data.

FieldDescription
edgesNot nullable.

Edges in the connection to traverse, each containing a cursor and node.

Type: Array of ReservationEdge
pageInfo

Information about the current page of results.

Type: PageInfo
totalCount

Total number of reservations.

Type: Int
ReservationStatus
Enum

Status of the reservation.

NameDescription
BOOKED
CANCELLED
COMPLETE
CREATED
DECLINED
IN_PROGRESS
INVALID
RESERVED
ReservationValueAddedPromotion
Object

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

FieldDescription
descriptionNot nullable.

Description of the promotion.

Type: String
idNot nullable.

ID of the promotion.

Type: String
ResolutionStatus
Enum

Resolution status values, which indicate the API's ability to determine if a checkpoint is fulfilled.

NameDescription
RESOLVED

Checkpoint was successfully evaluated.

UNRESOLVED_PROPERTY_NOT_PROVISIONED

API could not determine a fulfilled value because the property is missing from our internal system. Retry the operation; this is typically caused by a transient internal error. If the error persists, contact your Technical Relationship Manager.

UNRESOLVED_CHECKPOINT_SYSTEM_UNAVAILABLE

API could not determine a fulfilled value because of an internal problem. Retry the operation; this is typically caused by a transient internal error. If the error persists, contact your Technical Relationship Manager.

Restrictions
Object
FieldDescription
bookingLocalDateTimeFrom

Beginning of the date range (inclusive) when the reservation can be made in order for this promotion to be applicable. Format is YYYY-MM-DDThh:mm:ss, in the property’s local time zone.

Type: LocalDateTime
bookingLocalDateTimeTo

End of the date range (inclusive) when the reservation can be made in order for this promotion to be applicable. Format is YYYY-MM-DDThh:mm:ss, in the property’s local time zone.

Type: LocalDateTime
isMemberOnly

Whether a promotion is applicable only to members shopping on Expedia. The default value for this field is false.

Note that member-only badging is not applied to member-only deals that are less than 10%.

Type: Boolean
isMobileUserOnly

Whether this promotion is applicable only to travelers booking on the mobile device. This field is returned when querying for a single promotion only (by specifying the promotion ID).

Type: Boolean
maxAdvanceBookingDays

Maximum number of days in advance of the reservation date for the promotion to be applicable.

Type: Int
maxLengthOfStay

Maximum duration of stay for which the promotion can be applicable. Maximum value is 28.

Type: Int
minAdvanceBookingDays

Minimum number of days in advance of the reservation date for the promotion to be applicable. The default value for this field is 0.

Type: Int
minLengthOfStay

Minimum duration of stay for which the promotion can be applicable.

Type: Int
sameDayBookingStartTime

Start time for the same day for which the promotion is applicable (in the property’s local time zone). Applicable only for SAME_DAY_PROMOTION.

Type: LocalTime
travelDateFrom

Beginning travel date for which this promotion is applicable in YYYY-MM-DD format.

Type: LocalDate
travelDateTo

End travel date for which this promotion is applicable in YYYY-MM-DD format.

Type: LocalDate
ResultFilter
Enum

Fulfillment status values.

NameDescription
PASSED

Checkpoint is fulfilled (fulfilled equal to true).

FAILED

Checkpoint is not fulfilled (fulfilled equal to false). This means the content requirement has not been met. Verify that content is included in the Listings integration file for processing.

UNRESOLVED

API could not determine the checkpoint's fulfilled value (resolutionStatus equal to UNRESOLVED_*). Retry the operation; this is typically caused by a transient internal error. If the error persists, contact your Technical Relationship Manager.

Review
Object

Review content, including its source, localized text, and reservation information to which it pertains.

FieldDescription
bodyNot nullable.

Localized review text.

Type: LocalizedString
brandName

Brand to which the review belongs. Values include Aago, BedandBreakfast, CheapTickets, Ebookers, Expedia, HomeAway, Hotels, Lastminute, MrJet, Orbitz, Travelocity, Venere, VSC, and Wotif.

Type: String
createdDateTimeNot nullable.

Date and time (in UTC, format: YYYY-MM-DDThh:mm:ssTZD) when this review was created.

Type: String
idNot nullable.

Review ID.

Type: ID
isEligibleForResponse

Whether the partner can respond to the review. Reasons why a review is ineligible include:

  • The review was imported and cannot be responded to
  • The window within which a partner can respond has expired
  • A response has been submitted and approved (moderated) and the partner is no longer allowed to submit a response
Type: Boolean
lastUpdatedDateTimeNot nullable.

Date and time (in UTC, format: YYYY-MM-DDThh:mm:ssTZD) when this review was last updated.

Type: String
media

Unsupported at this time. Media URLs and caption uploaded with the review, if any.

Type: ReviewMedia
propertyId

Property IDs.

Type: Array of IdNode
reservationType: ReviewReservation
response

Review response submitted by the partner (using the setReviewResponse mutation).

Type: OwnerResponse
source

Source of the review; values include PLATFORM and IMPORTED.

Type: String
starRatingsNot nullable.

Overall rating for this review, typically on a 1-5 point scale.

Type: Array of Rating
statusNot nullable.

Status of the review.

Type: String
title

Localized review title (headline).

Type: LocalizedString
ReviewAggregatedScore
Object

Aggregated score (rating) and the number of reviews used to compute the score.

FieldDescription
reviewsCountNot nullable.

Number of reviews that were averaged to create the aggregated rating.

Type: Int
scoreNot nullable.

Aggregated (average) rating.

Type: Float
ReviewBrand
Enum

Brand names (sites) where reviews are collected.

NameDescription
EXPEDIA
HOTELS
TRAVELOCITY
ORBITZ
CHEAP_TICKETS
WOTIF
EBOOKERS
MR_JET
LASTMINUTE
VRBO
HOTWIRE
ReviewCategoryScore
Object

Category and aggregated rating.

FieldDescription
categoryNot nullable.

Category for which a rating is given. Values include

  • For vacation rentals:

    • checkIn
    • overall
    • location
    • communication
    • onlineListing
    • cleanliness
  • For reviews collected on conventional lodging sites:

    • ecoFriendliness
    • roomComfort
    • roomCleanliness
    • service
    • overall
    • hotelCondition
    • roomAmenitiesScore
    • areaAroundHotel
Type: String
valueNot nullable.

Value of the aggregated (average) rating.

Type: ReviewAggregatedScore
ReviewFilter
InputObject

Additional arguments to filter the reviews that are returned by the query.

FieldDescription
createdDate

Date range when reviews were created.

Type: DateInput
hasOwnerResponse

Whether an owner or property manager response exists for the review.

Type: Boolean
reservation

Reservation details.

Type: ReviewReservationFilterInput
reviewId

Expedia or Vrbo ID of the review.

Type: String
source

Source of the review ID. To retrieve native reviews, specify PLATFORM. To retrieve imported reviews, specify IMPORTED.

Type: String
updatedDate

Date range when reviews were updated.

Type: DateInput
ReviewGuest
Object

Information about the traveler who left the review. If no name is provided for the review, Anonymous is listed as the review's name.

FieldDescription
firstNameNot nullable.

First name of the traveler.

Type: String
lastNameNot nullable.

Last name (surname) of the traveler.

Type: String
ReviewMedia
Object

Unsupported at this time. Media URLs and caption uploaded with the review, if any.

FieldDescription
caption

Image caption.

Type: LocalizedString
highResolutionUrl

URL of the full image.

Type: String
thumbnailUrl

URL of the image's thumbnail.

Type: String
ReviewReservation
Object

Reservation details associated with the review.

FieldDescription
checkInDate

Reservation check-in date.

Type: LocalDate
checkOutDate

Reservation checkout date.

Type: LocalDate
primaryGuest

Guest information.

Type: ReviewGuest
reservationIdsNot nullable.

IDs of the reservation.

Type: Array of non nullable IdNode
status

Status of the reservation.

Type: String
ReviewReservationFilterInput
InputObject

Reservation details that are used to filter results.

FieldDescription
reservationIds

Review IDs and their sources.

Type: Array of non nullable ReviewReservationIdNodeInput
ReviewReservationIdNodeInput
InputObject

Reservation ID and its source.

FieldDescription
idNot nullable.

Reservation ID.

Type: ID
idSourceNot nullable.

Source of the ID.

Type: IdSource
ReviewResponse
Object

Reviews retrieved by the query.

FieldDescription
cursor

Next page cursor for the next page of results (null if no more pages are available).

Type: String
reviewsNot nullable.

Review content, including each review's source, localized text, and reservation information to which it pertains.

Type: Array of Review
totalCountNot nullable.

Total number of reviews returned that meet the search criteria.

Type: Int
ReviewsOrderBy
InputObject

How reviews are sorted; only one field should be specified. If not specified, reviews are sorted by review creation dateTime.

FieldDescription
createdDateTime

SSort order based on review creation dateTime in ascending or descending order.

Type: SortOrder
lastUpdatedDateTime

Sort order based on review updated dateTime in ascending or descending order.

Type: SortOrder
ownerResponseCreatedDateTime

Sort order based on dateTime of when the owner response was created in ascending or descending order.

Type: SortOrder
ownerResponseLastUpdatedDateTime

Sort order based on dateTime when the owner response was updated in ascending or descending order.

Type: SortOrder
reservationCheckInDate

Sort order based on reservation check-in date in ascending or descending order.

Type: SortOrder
reservationCheckOutDate

Sort order based on reservation checkout date in ascending or descending order.

Type: SortOrder
SingleDiscount
Object

Discount that offers a percentage off a rate (such as 15% off).

FieldDescription
memberOnlyAdditionalValue

Value of member-only discount applied. For example, if the regular discount is 10% and memberOnlyAdditionalValue is set to 5, a member will receive a 15% discount and a non-member will receive a 10% discount.

Type: Float
typeNot nullable.

Type of discount.

Type: DiscountType
unitNot nullable.

Unit of the discount. Currently, PERCENT is supported when creating or updating a discount. AMOUNT is supported for queries only.

Type: DiscountUnit
valueNot nullable.

Value of the discount applied.

Type: Float
SortOrder
Enum

How to sort results.

NameDescription
ASC

Sort results in ascending order (oldest to newest).

DESC

Sort results in descending order (newest to oldest).

StatusCheckpoint
Object

Information about a property's or unit's content requirements (checkpoints).

FieldDescription
checkpointByName

Checkpoint specified by name. This field requires an argument: checkpointByName(name: String!). Refer to the name field below for the list of values that can be used.

Type: StatusCheckpoint
checkpoints

Content requirement (checkpoint) that determines overall status. This field provides an optional argument, checkpoints(filter: CheckpointFilterInput), which enables you to filter the returned checkpoints by result. Refer to the CheckpointFilterInput type for details.

Type: Array of non nullable StatusCheckpoint
foundCount

Number of checkpoint items associated with the property or unit, if quantifiable.

Type: Int
fulfilledNot nullable.

Whether the checkpoint conditions were satisfied. If false, the content requirement has not been met; verify that content is included in the Listings integration file for processing.

Type: Boolean
lastEvaluatedNot nullable.

UTC time when we last evaluated the checkpoint. This can help identify whether the data is stale if you see an unexpected status.

Type: String
maxCount

Maximum threshold allowed for the checkpoint to be satisfied, if applicable.

Type: Int
minCount

Minimum threshold required for the checkpoint to be satisfied, if applicable.

Type: Int
nameNot nullable.

Checkpoint name. For the list of checkpoints that may be returned and those that fulfill minimum content requirements, see Intro to property status.

Type: String
pathNot nullable.

Ordered list of parent checkpoint nodes in the status calculation tree. If you need to reconstruct the tree, discover added context about a checkpoint, or make use of the checkpointByName field, then this information may be useful.

Type: Array of non nullable String
resolutionStatusNot nullable.

Status of the checkpoint retrieval.

Type: ResolutionStatus
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

FieldDescription
currencyCodeNot nullable.

Currency in which the amount is shown.

Type: String
rateTypeNot nullable.

Rate type.

Type: RateType
SupplierAmountCompensation
Object

Compensation information associated with the reservation for this date range.

FieldDescription
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.

NameDescription
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.

FieldDescription
membershipNumber

Traveler's membership number.

Type: Int
planCode

Reward program code.

Type: String
SupplierRate
Object
FieldDescription
fromDateNot nullable.

Date when the rate becomes effective (format: YYYY-MM-DD).

Type: LocalDate
rateItemsNot nullable.

Itemized list of fees.

Type: Array of non nullable SupplierRateItem
rateTimeUnitNot nullable.

Time unit of the rate.

Type: RateTimeUnit
toDateNot nullable.

Date when the rate expires (format: YYYY-MM-DD).

Type: LocalDate
SupplierRateItem
Object
FieldDescription
amountNot nullable.

Amount of the fee.

Type: Float
feeTypeNot nullable.

Type of fee for this itemized rate.

Type: SupplierFeeType
SupplierTotal
Object
FieldDescription
amountAfterTaxNot nullable.

Total amount of the fee after tax is applied.

Type: Float
amountBeforeTaxNot nullable.

Total amount of the fee before tax is applied.

Type: Float
compensationNot nullable.

Compensation information associated with the reservation.

Type: SupplierAmountCompensation
ThirdPartyValidation
Object

Third-party validation information.

FieldDescription
attributes

Attributes used to validate the registration number as provided by the third-party.

Type: Array of String
requiredNot nullable.

Whether third-party validation is required.

Type: Boolean
TravelDateInput
InputObject
FieldDescription
from

Start date of the travel window (format: YYYY-MM-DD).

Type: LocalDate
to

End date of the travel window (format: YYYY-MM-DD).

Type: LocalDate
TravelPurpose
Enum

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

NameDescription
NONE
KNOWN_BUSINESS_VISIT
SUSPECTED_BUSINESS_VISIT
KNOWN_PERSONAL_VISIT
SUSPECTED_PERSONAL_VISIT
Unit
Object

Unit configuration.

FieldDescription
activeStatus

Status of the unit for Vrbo properties only (indicates whether the unit is live or not). To check the status of Expedia properties (rooms), use the Product API as shown in this example.

Type: ActiveStatus
count

Cardinality of this unit configuration on the property, for Vrbo properties only.

Type: Int
idNot nullable.

Expedia ID of the unit.

Type: ID
ids

Known IDs for the property in the source system(s).

Type: Array of IdNode
registration

Registration information for the unit or room type. You can specify the locale argument to retrieve the results in a specific language; specify the four-letter ISO code for language. Use a four-character code that indicates language and region, such as fr_FR for French in France.

Type: Registration
Url
Url

Scalar type whose value conforms to the standard URL format as specified in RFC3986 specification.

ZoneDateTime
ZoneDateTime

A type representing a date and time with a time zone in the format YYYY-MM-DDTHH:mm:ssTZD, where TZD is a time zone designator in the form +/-hh:mm).