The GraphQL explorer is provided for the example below. Use this interactive explorer to get comfortable with the sample query.
A test property ID is passed into the explorer for use by the query; 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.
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.
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.
IdSource
Enum
Source of a given ID.
Name
Description
EXPEDIA
Expedia is the source of the ID.
SUPPLIER
Connectivity provider or lodging partner is the source of the ID. This value is not supported for use in promotions.
VRBO
Unsupported.
Int
Int
The Int scalar type represents non-fractional signed whole numeric values. Int can represent values between -(2^31) and 2^31 - 1.
LocalDate
LocalDate
A type representing a date in ISO 8601 format: YYYY-MM-DD (such as 2007-12-03).
MessageReviewStatus
Enum
Status values of a message as it goes through moderation.
Name
Description
IN_REVIEW
ACCEPTED
BLOCKED
MessageThread
Object
Message thread details, including IDs, creation time, messages, and reservation information.
Field
Description
bookingInquiry
Booking inquiry associated with the message thread. null is returned for non-Vrbo properties.
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.
orderBy (type: MessageThreadMessagesOrderByInput), which provides the sort
order of results. If not specified, messages are sorted in ascending order
(from oldest to newest) based on the creation date.
For properties onboarded onto Expedia, this is the Expedia reservation ID. For
properties onboarded onto Vrbo, this is the Vrbo internal reservation UUID.
Representation of a physical property, including its units, reservations, and promotions.
Field
Description
messageThreads
Not 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.
orderBy (type: ReviewsOrderBy), which provides the sort order of results.
If not specified, message threads are sorted in ascending order (from oldest
to newest) based on the creation date.
"Values that indicate whether the specified dates are inclusive or exclusive.
Name
Description
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.
ReservationAlternativeIds
Object
Partner's (supplier) IDs for the reservation.
Field
Description
supplierId
Not 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.
Sort results in ascending order (oldest to newest).
DESC
Sort results in descending order (newest to oldest).
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.
Url
Url
Scalar type whose value conforms to the standard URL format as specified in RFC3986 specification.