Availability and Rates APIs
Booking APIs
Property Mgmt APIs
Promotions
ReferencePromotions

promotions query

Retrieves information about a single property's 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.

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

Note: The promotions query is nested under the property query, which provides access to other capabilities, such as property status 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 promotions.

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

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.

Retrieving all promotions

Promotions

API Explorer Alt content

Response

Retrieving a single promotion
Note that if you filter results by promotion ID, you cannot specify addition filters (as shown here).
Promotions
API Explorer Alt content
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
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.
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
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.
EligibleRatePlan
Object
FieldDescription
idNot nullable.
ID of the rate plan stored in the Expedia platform.
Type: ID
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.
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.
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.
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).
LocalTime
LocalTime
A type representing a time in this format: HH:mm:ss or HH:mm (such as 10:15:30 or 10:15).
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
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
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
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
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
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.
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