ReferencePromotions

property query

Retrieves information about a single property, including promotions. You can retrieve all active promotions for a property, or you can retrieve a single promotion. Promotions include single, day-of-week, and multi-night discounts. Each promotion has an assigned promotion ID that can be used for subsequent management.

Note: Information is returned at the property level, not the unit level.

Syntax

1query {
2 property(
3 id: String!,
4 idSource: IdSource!
5 )
6 {
7 promotions(
8 pageSize: Int!,
9 after: String,
10 filter: FiltersInput
11 ): Promotions
12 }
13}

Examples

Retrieving all promotions

1 query {
2 property(id: "12345", idSource: EXPEDIA){
3 promotions(pageSize: 10) {
4 totalCount
5 pageInfo {
6 hasNextPage
7 endCursor
8 }
9 edges {
10 cursor
11 node {
12 __typename
13 id
14 name
15 status
16 category
17 ... on DiscountPromotion {
18 code
19 restrictions {
20 isMemberOnly
21 isMobileUserOnly
22 minLengthOfStay
23 maxLengthOfStay
24 minAdvanceBookingDays
25 maxAdvanceBookingDays
26 bookingLocalDateTimeFrom
27 bookingLocalDateTimeTo
28 travelDateFrom
29 travelDateTo
30 sameDayBookingStartTime
31 }
32 eligibleRatePlans {
33 id
34 }
35 blackoutDates {
36 travelDateFrom
37 travelDateTo
38 }
39 discount {
40 __typename
41 type
42 unit
43 ... on SingleDiscount {
44 value
45 memberOnlyAdditionalValue
46 }
47 ... on DayOfWeekDiscount {
48 monday
49 tuesday
50 wednesday
51 thursday
52 friday
53 saturday
54 sunday
55 }
56 ... on MultiNightDiscount {
57 value
58 applicableNight
59 isRecurring
60 memberOnlyAdditionalValue
61 }
62 }
63 }
64 }
65 }
66 }
67 }
68 }

Retrieving a single promotion

1 query {
2 property(id: "12345", idSource: EXPEDIA) {
3 promotions(
4 pageSize: 10,
5 filter: {
6 id:"226650241"
7 }
8 ) {
9 totalCount
10 pageInfo {
11 hasNextPage
12 endCursor
13 }
14 edges {
15 cursor
16 node {
17 __typename
18 id
19 name
20 category
21 status
22 ... on DiscountPromotion {
23 code
24 restrictions {
25 isMobileUserOnly
26 minLengthOfStay
27 maxLengthOfStay
28 minAdvanceBookingDays
29 maxAdvanceBookingDays
30 bookingLocalDateTimeFrom
31 bookingLocalDateTimeTo
32 travelDateFrom
33 travelDateTo
34 sameDayBookingStartTime
35 }
36 eligibleRatePlans {
37 id
38 }
39 blackoutDates {
40 travelDateFrom
41 travelDateTo
42 }
43 discount {
44 __typename
45 type
46 unit
47 ... on SingleDiscount {
48 value
49 }
50 }
51 }
52 }
53 }
54 }
55 }
56 }

GraphQL explorer

This is a graphical, interactive GraphQL IDE that lets you run queries offered by the Lodging Supply GraphQL API. A test property ID is passed into the explorer. Click Run Query to execute the query shown here. Or, 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.

Response

Schema

Arguments

NameDescription

id

Required.

For an Expedia property, specify the Expedia ID of the property.

For a Vrbo property, specify the ID in this format: systemId/advertiserId/listingExternalId. For direct PM integrations, the value of systemId is often “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

Required.

Source system. For an Expedia property, specify EXPEDIA. For a Vrbo property, specify SUPPLIER; do not specify VRBO because the specified ID is the external ID in the supplier's system.

Type: IdSource

Types


Name
Type
AcknowledgementRecordObject

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
AcknowledgementTypeEnum

Acknowledgement type values.

NameDescription
PLATFORM
ActiveStatusObject

Status of the property.

FieldDescription
activeNot nullable.

Whether the property is live on Expedia sites.

Type: Boolean
statusCheckpointNot nullable.

Top-level property status derived from supporting checkpoints.

Type: StatusCheckpoint
AdditionalDataRequirementObject

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 subtype, to be localized.

Type: String
type

Type of data.

Type: String
typeLocalized

Description of type, to be localized.

Type: String
AddressObject

Property address information.

FieldDescription
city

City where the property is located.

Type: String
country

Two-character ISO country code.

Type: String
line1

First line of the physical street address.

Type: String
line2

Second line of the physical street address.

Type: String
line3

Third line of the physical street address.

Type: String
postalCode

Postal code of the address.

Type: String
province

State or province of the property.

Type: String
AddressCheckpointObject
FieldDescription
addressLine1

Deprecated: Field no longer supported

Not nullable.

First line of the property's physical street address.

Type: Boolean
addressLine2

Deprecated: Field no longer supported

Not nullable.

Second line of the physical street address.

Type: Boolean
city

Deprecated: Field no longer supported

Not nullable.

City where the property is located.

Type: Boolean
code

Deprecated: Field no longer supported

Not nullable.

Platform name.

Type: String
country

Deprecated: Field no longer supported

Not nullable.

Two-character country code of the property.

Type: Boolean
fulfilled

Deprecated: Field no longer supported

Not nullable.

Whether the content has been specified.

Type: Boolean
postalCode

Deprecated: Field no longer supported

Not nullable.

Postal code of the address.

Type: Boolean
province

Deprecated: Field no longer supported

Not nullable.

State or province of the property.

Type: Boolean
ApplicableRegulationsObject

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
ApplicableRegulationsKeyEnum

Regulation key values.

NameDescription
LICENSE_DEPARTMENT_NAME
LICENSE_GOVERNMENT_NAME
LICENSE_HOLDER_NAME
LICENSE_HOLDER_STREET_ADDRESS_1
LICENSE_HOLDER_STREET_ADDRESS_2
LICENSE_HOLDER_CITY
LICENSE_HOLDER_PREFECTURE
LICENSE_HOLDER_COUNTRY
LICENSE_HOLDER_POSTAL
IS_VACATION_RENTAL
REGISTRATION_NUMBER
REGISTRATION_NUMBER_TYPE
AttachmentTypeEnum

Exemption category types.

NameDescription
DRIVERS_LICENSE
AttachmentUrlObject

Registration document information.

FieldDescription
key

Type of document referenced.

Type: AttachmentType
value

URL of the registration document file.

Type: String
BaseCheckpointObject
FieldDescription
code

Deprecated: Field no longer supported

Not nullable.

Platform name.

Type: String
fulfilled

Deprecated: Field no longer supported

Not nullable.

Whether the content has been specified.

Type: Boolean
BlackoutDateRangeObject
FieldDescription
travelDateFromNot nullable.

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

Type: Date
travelDateToNot nullable.

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

Type: Date
BookingLocalDateTimeInputInputObject

Information abaout 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: DateTime
to

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

Type: DateTime
BooleanBoolean

The Boolean scalar type represents true or false.

BusinessModelEnum

Entity that collects payment.

NameDescription
EXPEDIA_COLLECT

Expedia collects payment.

HOTEL_COLLECT

Property collects payment.

CheckoutDateFilterInputObject

Parameters to filter reservations based on checkout dates. 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: String
toNot nullable.

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

Type: String
CheckpointInterface

Implemented by

FieldDescription
code

Deprecated: Field no longer supported

Not nullable.

Name of the content.

Type: String
fulfilled

Deprecated: Field no longer supported

Not nullable.

Whether the content has been specified.

Type: Boolean
CheckpointFilterInputObject

Parameters to filter checkpoints.

FieldDescription
result

Resolution status.

Type: Array of non nullable ResultFilter
DateDate

A type representing a Date in ISO 8601 format (such as 2007-12-03).

DateTimeDateTime

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

DayOfWeekDiscountObject

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 only PERCENTAGE is supported.

Type: DiscountUnit
wednesdayNot nullable.
Type: Float
DiscountInterface

Implemented by

FieldDescription
typeNot nullable.

Type of the discount.

Type: DiscountType
unitNot nullable.

Unit of the discount.

Type: DiscountUnit
DiscountPromotionObject
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.

Name of 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.

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
nameNot nullable.

Name of the promotion.

Type: PromotionName
restrictions

List of restrictions that can be applied to these promotions.

Type: Restrictions
statusNot nullable.

Status of the promotion.

Type: PromotionStatus
DiscountTypeEnum

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.

DiscountUnitEnum
NameDescription
PERCENT

Percentage discount for the promotion.

DistrictObject

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 ja-JP for a property in Japan).

Type: String
referenceUrls

URL to jurisdiction regulation infomation.

Type: Array of String
registrationRequiredNot nullable.

Whether registration is required by the jurisdiction.

Type: Boolean
requirements

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

Type: Array of JurisdictionRequirement
EligibleRatePlanObject
FieldDescription
idNot nullable.

ID of the rate plan stored in the Expedia platform.

Type: ID
ExemptionObject

Exemption to jurisdiction requirements.

FieldDescription
category

Exemption type.

Type: ExemptionCategory
description

Description of the exemption.

Type: String
ExemptionCategoryEnum

Exemption types.

NameDescription
MAX_NIGHT_CAP
ExpediaSupplierAmountObject
FieldDescription
currencyCodeNot nullable.

Currency in which the amount is shown.

Type: String
ratesNot nullable.

Daily 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
FiltersInputInputObject
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. Currently, only ACTIVE promotions can be queried.

Type: PromotionStatus
travelDate

Travel date window being queried for.

Type: TravelDateInput
FloatFloat

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

GeoLocationObject

Geographical location coordinates.

FieldDescription
latitude

Latitudinal coordinates of property.

Type: Float
longitude

Longitudinal coordinates of property.

Type: Float
GuestObject
FieldDescription
firstNameNot nullable.

Traveler's first (given) name.

Type: String
lastNameNot nullable.

Traveler's last name (surname).

Type: String
IDID

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.

IdNodeObject
FieldDescription
id

ID in the source system.

Type: ID
idSourceNot nullable.

Source of the ID.

Type: IdSource
IdSourceEnum

Source of a given ID.

NameDescription
EXPEDIA

Expedia is the source of the ID.

SUPPLIER

Connectivity partner or supplier is the source of the ID. This value is not supported for use in promotions.

VRBO

Vrbo (HomeAway) is the source of the ID. This value cannot be used as an argument value, and it is not supported for use in promotions.

IntInt

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

InventorySourceObject
FieldDescription
checkpoints

Deprecated: Field no longer supported

Content that is required for a property to go live, such as images or bedrooms.

Type: Array of Checkpoint
primary

Deprecated: Field no longer supported

Status of the property on the primary platform where the property is listed.

Type: StatusBySource
secondary

Deprecated: Field no longer supported

Status of the property on a secondary platform where the property is listed.

Type: Array of StatusBySource
InventorySourceStatusObject

Status of the property on all platforms and property content.

FieldDescription
inventorySourceType: Array of InventorySource
JurisdictionRequirementObject

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

FieldDescription
additionalDataRequirements

Addtional 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 EG supports.

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
LegalPropertyTypeObject

Legacy property type for the district.

FieldDescription
subtype

Legal property subtype, applicable for residences, such as primary home or secondary home.

Type: String
type

Legal property type, such as hotel, bed and breakfast, residence, etc.

Type: String
LocalTimeLocalTime

A type representing a time (such as 10:15:30).

MaxNightCapObject

Maximum night cap parameters for the jurisdiction.

FieldDescription
annualLimit

Annual night cap.

Type: Int
isEnforced

Whether the cap is enforced (or just educational).

Type: Boolean
MinAndFoundCheckpointObject
FieldDescription
code

Deprecated: Field no longer supported

Not nullable.

Name of the content.

Type: String
found

Deprecated: Field no longer supported

Not nullable.

Number of items (content) that fulfilled the minimum content requirement.

Type: Int
fulfilled

Deprecated: Field no longer supported

Not nullable.

Whether the content has been specified.

Type: Boolean
minimum

Deprecated: Field no longer supported

Not nullable.

Minimum content requirement.

Type: Int
ModulesCheckpointObject
FieldDescription
code

Deprecated: Field no longer supported

Not nullable.

Name of the content.

Type: String
found

Deprecated: Field no longer supported

Not nullable.

Number of items (content) that fulfilled the minimum content requirement.

Type: Int
foundModules

Deprecated: Field no longer supported

List of content that is found for the property.

Type: Array of String
fulfilled

Deprecated: Field no longer supported

Not nullable.

Whether the content has been specified.

Type: Boolean
minimum

Deprecated: Field no longer supported

Not nullable.

Minimum content requirement.

Type: Int
missingModules

Deprecated: Field no longer supported

List of content that is missing (difference between requiredModules and foundModules).

Type: Array of String
requiredModules

Deprecated: Field no longer supported

List of items (content) that is required for the property to go live on Expedia.

Type: Array of String
MultiNightDiscountObject

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

Value applied for a member-only discount.

Type: Float
typeNot nullable.

Type of discount.

Type: DiscountType
unitNot nullable.

Unit of the discount.

Type: DiscountUnit
valueNot nullable.

Value of the discount applied.

Type: Float
PageInfoObject

Information about the current page of results.

FieldDescription
endCursor

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

Type: String
hasNextPageNot nullable.

Whether additional pages can be retrieved.

Type: Boolean
PromotionInterface

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
nameNot nullable.

Name of the promotion.

Type: PromotionName
statusNot nullable.

Status of the promotion.

Type: PromotionStatus
PromotionCategoryEnum
NameDescription
DISCOUNT_PROMOTION

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

PromotionNameEnum
NameDescription
BASIC_PROMOTION

Flexible offer with restrictions defined by the supplier. 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.

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.

PromotionNodeObject
FieldDescription
cursorNot nullable.

Cursor value for this edge.

Type: String
nodeNot nullable.

Node that references the promotion data.

Type: Promotion
PromotionsObject
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: PageInfo
totalCountNot nullable.

Total number of promotions returned that meet the search criteria.

Type: Int
PromotionStatusEnum
NameDescription
ACTIVE
INACTIVE
PropertyObject

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

FieldDescription
activeStatus

Status of the property on all platforms and property content.

Type: ActiveStatus
address

Physical street address of the property.

Type: Address
district

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

Type: District
geoLocation

Geographical location of the property.

Type: GeoLocation
idNot nullable.

Expedia ID of the property.

Type: ID
ids

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

Type: Array of IdNode
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.
  • 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
registration

Registration information for the property. You can specify the locale argument to specify the language of the results. Use a four-character code that indicates language and region, such as fr_FR for French in France.

Type: Registration
reservations

Paginated reservation data. You can specify these arguments:

  • checkoutDate (type: CheckoutDateFilter!), which enables you to to filter reservations based on checkout dates.
  • pageSize (type: Int!), which specifies the maximum number of reservations (up to 25) on each page.
  • after (type: String), which provides the cursor from the previous query response that marked the end of the previous page of results.
Type: ReservationsConnection
status

Deprecated: Field no longer supported - use activeStatus

Status of the property on all platforms and property content.

Type: InventorySourceStatus
units

Collection of unit configurations available for the property.

Type: Array of Unit
RateTimeUnitEnum
NameDescription
PER_DAY
PER_WEEK
PER_STAY
RateTypeEnum
NameDescription
NET

Net amount, which equals gross amount minus commission.

SELL

Gross amount.

RegistrationObject

Government registration information for a given property.

FieldDescription
applicableRegulations

Additional property registration information required by certain districts.

Type: Array of non nullable ApplicableRegulations
completeNot nullable.

Whether the property registration information is sufficient to fulfill the requirements of the property's district.

Type: Boolean
detailNot nullable.

List of registration information for each bookable unit of a multi-unit property.

Type: RegistrationDetail
district

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

Type: String
RegistrationDetailObject

Registration information for each bookable unit of a multi-unit property.

FieldDescription
acknowledgementRecordsNot nullable.

Acknowledgement records for the bookable unit.

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
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 available for 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 boat, trailer, residence, and so on.

Type: String
RegistrationNumberRequirementObject

Registration number requirements.

FieldDescription
allowPendingRegistrationsNot nullable.

Whether pending applications are allowed to list.

Type: Boolean
format

Sample format string to use as an example for partners.

Type: String
isExpirationDateRequiredNot nullable.

Whether the registration expiration date is required.

Type: Boolean
isOptionalNot nullable.

Whether the registration number is optional.

Type: Boolean
localName

Localized display name (such as みんぱく for Japan Minpaku).

Type: String
numberType

Registration number type.

Type: RegistrationNumberType
numberTypeLabel

Label of the registration number.

Type: String
regex

Regex used to validate the syntax of the registration number.

Type: String
RegistrationNumberTypeEnum

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
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
RegistrationRecordObject

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

Registration record type in the given locale.

Type: String
RegulatoryCategoryEnum

Category values for regulatory categories.

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
ReservationObject

Reservation details.

FieldDescription
adultCountNot nullable.

Count for all adult guests associated with the reservation.

Type: Int
bedTypes

Bed type of the reservation.

Type: String
businessModelNot nullable.

Business entity that collects payment for the reservation.

Type: BusinessModel
checkInDateNot nullable.

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

Type: String
checkOutDateNot nullable.

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

Type: String
childCountNot nullable.

Count for all children 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).

Type: String
multiRoomText

Text that is displayed to travelers if there is a multi-room booking associated with the reservation.

Type: String
paymentInstructionsNot nullable.

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

Type: String
primaryGuestNot nullable.

Guest who booked the reservation.

Type: Guest
rateIdsNot nullable.

ID of the rate/rate plan and the source of the ID.

Type: Array of non nullable IdNode
reservationIdsNot nullable.

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

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 travelers if there is a special request associated with the reservation.

Type: String
statusNot nullable.

Current status of the reservation.

Type: ReservationStatus
supplierAmount

Amount provided by the supplier for the reservation.

Type: SupplierAmount
totalGuestCountNot nullable.

Total number of guests associated with the reservation.

Type: Int
unitIdsNot nullable.

ID of the units/rooms and the source of the ID.

Type: Array of non nullable IdNode
ReservationEdgeObject
FieldDescription
cursorNot nullable.

Cursor value for this edge.

Type: String
nodeNot nullable.

Node that references the reservation data.

Type: Reservation
ReservationsConnectionObject

Logical connection to reservations data.

FieldDescription
edgesNot nullable.

Edges in the connection to traverse, each contain 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
ReservationStatusEnum

Status values of a reservation.

NameDescription
BOOKED
CANCELLED
ResolutionStatusEnum

Resolution status values.

NameDescription
RESOLVED
UNRESOLVED_PROPERTY_NOT_PROVISIONED
UNRESOLVED_CHECKPOINT_SYSTEM_UNAVAILABLE
RestrictionsObject
FieldDescription
bookingLocalDateTimeFrom

Beginning of the reservation date range for which this promotion is applicable. Format is YYYY-MM-DDThh:mm:ss, in the property’s local time zone.

Type: DateTime
bookingLocalDateTimeTo

End of the reservation date range for which this promotion is applicable. Format is YYYY-MM-DDThh:mm:ss, in the property’s local time zone.

Type: DateTime
isMemberOnly

Whether a promotion is applicable for only members shopping on Expedia.

Type: Boolean
isMobileUserOnly

Whether this promotion is applicable only for 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.

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: Date
travelDateTo

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

Type: Date
ResultFilterEnum
NameDescription
PASSED
FAILED
UNRESOLVED
SingleDiscountObject

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

FieldDescription
memberOnlyAdditionalValue

Value of member-only discount applied.

Type: Float
typeNot nullable.

Type of discount.

Type: DiscountType
unitNot nullable.

Unit of the discount. Currently only PERCENTAGE is supported.

Type: DiscountUnit
valueNot nullable.

Value of the discount applied.

Type: Float
SourceNameEnum
NameDescription
Expedia
Vrbo
StatusBySourceObject
FieldDescription
active

Deprecated: Field no longer supported

Not nullable.

AWhether the property is active on the specified platform.

Type: Boolean
code

Deprecated: Field no longer supported

Not nullable.

Platform name

Type: SourceName
propertyId

Deprecated: Field no longer supported

Internal ID in our system.

Type: String
StatusCheckpointObject
FieldDescription
checkpointByName

Checkpoint specified by name.

Type: StatusCheckpoint
checkpoints

Supporting checkpoints that determine overall status.

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.

Type: Boolean
lastEvaluatedNot nullable.

UTC time when checkpoint was last evaluated.

Type: String
maxCount

Maximum threshold allowed for the checkpoint to be satisfied.

Type: Int
minCount

Minimum threshold required for the checkpoint to be satisfied.

Type: Int
nameNot nullable.

Checkpoint name. Possible names are listed below. Note that not all checkpoints are included in every response and this list may not be definitive. Assumptions about the presence of any of these checkpoints should not be built into logic.

For properties onboarded on Expedia, these checkpoints may be met:

  • HasActiveImages
  • HasActiveRoom
  • HasAddress
  • HasAmenities
  • HasBathroomCount
  • HasBedroomCount
  • HasBusinessModel
  • HasCheckInInstructions
  • HasContact
  • HasCurrencyCode
  • HasImageScore
  • HasInventory
  • HasLatLong
  • HasPhone
  • HasPropertyName
  • HasPropertyTaxes
  • HasRegulatory
  • HasStructureType

For properties onboarded on Vrbo, these checkpoints may be met:

  • HasImages
  • HasLocation, which relies on these checkpoints:
    • HasAddressPassesExtended
    • HasGeoCode
    • HasPropertyAddress
  • HasPropertyDetails, which relies on these checkpoints:
    • HasBathroom
    • HasMaxOccupancy
    • HasPropertyDescription
    • HasPropertyHeadline
    • HasPropertyName
    • HasPropertyType
  • HasRates
  • HasRegistrationNumber
Type: String
pathNot nullable.

Ordered list of ancestor checkpoint nodes in the status calculation tree.

Type: Array of non nullable String
resolutionStatusNot nullable.

Status of the checkpoint retrieval.

Type: ResolutionStatus
StringString

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.

SupplierAmountInterface

Implemented by

FieldDescription
currencyCodeNot nullable.

Currency in which the amount is shown.

Type: String
rateTypeNot nullable.

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

Type: RateType
SupplierFeeTypeEnum

Types of fees.

NameDescription
BASE_RATE
EXTRA_GUEST_FEES
SERVICE_FEES
SupplierRateObject
FieldDescription
fromDateNot nullable.

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

Type: String
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: String
SupplierRateItemObject
FieldDescription
amountNot nullable.

Amount of the fee.

Type: Float
feeTypeNot nullable.

Type of fee for this itemized rate.

Type: SupplierFeeType
SupplierTotalObject
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
TravelDateInputInputObject
FieldDescription
from

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

Type: Date
to

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

Type: Date
UnitObject

Unit configuration.

FieldDescription
count

Cardinality of this unit configuration on the property.

Type: Int
idsType: Array of IdNode
registration

Regulatory registration information.

Type: Registration