Documentation

ReferencePromotions

updateDayOfWeekDiscountPromotion mutation

Updates a day-of-the-week promotion. Specify only those fields that need to be modified. We recommend that you retrieve the latest data stored for the promotion on the Expedia platform (by issuing the property query and specifying the promotion ID) before issuing this mutation.

Syntax

1    updateDayOfWeekDiscountPromotion(
2      propertyId: ID!,
3      propertyIdSource: IdSource!,
4      promotion: DayOfWeekDiscountPromotionUpdateInput!
5    ): Promotion!

Examples

Request
Response

1mutation {
2      updateDayOfWeekDiscountPromotion(
3        propertyId: "9309913",
4        propertyIdSource: EXPEDIA,
5        promotion: {
6          id: "391035963",
7          code: "Updated DOW",
8          eligibleRatePlans: [
9            {
10                id: "204971917"
11            }
12          ],
13          discount: {
14            unit: PERCENT,
15            monday: 17.0,
16            tuesday: 14.0,
17            wednesday: 13.0,
18            thursday: 12.0,
19            friday: 11.0,
20            saturday: 10.0,
21            sunday: 9.0
22          }
23        }
24    ) {
25        __typename
26        id
27        name
28        status
29        category
30        ... on DiscountPromotion {
31          code
32          restrictions {
33            isMemberOnly
34            isMobileUserOnly
35            minLengthOfStay
36            maxLengthOfStay
37            minAdvanceBookingDays
38            maxAdvanceBookingDays
39            bookingLocalDateTimeFrom
40            bookingLocalDateTimeTo
41            travelDateFrom
42            travelDateTo
43            sameDayBookingStartTime
44          }
45          eligibleRatePlans {
46            id
47          }
48          blackoutDates {
49            travelDateFrom
50            travelDateTo
51          }
52          discount {
53            __typename
54            type
55            unit
56            ... on DayOfWeekDiscount {
57              monday
58              tuesday
59              wednesday
60              thursday
61              friday
62              saturday
63              sunday
64            }
65          }
66        }
67      }
68    }

Schema

Arguments

Name	Description
`promotion`	Required. Additional arguments to specify details for updating the promotion. Type: DayOfWeekDiscountPromotionUpdateInput
`propertyId`	Required. Property ID. If using an external ID (from your system, source is SUPPLIER), specify the ID in this format: system_ID/advertiser_ID/property_ID. If the source is EXPEDIA, this is the Expedia ID (EID). Type: String
`propertyIdSource`	Required. Source of the ID. Type: IdSource

Types

Name

Type

BlackoutDateRange Object

Field	Description
`travelDateFrom`	Not nullable. Travel start date for the exception (blackout) window in the YYYY-MM-DD format. Type: Date
`travelDateTo`	Not nullable. Travel end date for the exception (blackout) window in the YYYY-MM-DD format. Type: Date

BlackoutDateRangeInput InputObject

Information about the blackout date range.

Field	Description
`travelDateFrom`	Not nullable. Travel start date for the exception (blackout) window in the YYYY-MM-DD format. Type: Date
`travelDateTo`	Not nullable. Travel end date for the exception (blackout) window in the YYYY-MM-DD format. Type: Date

Boolean Boolean

The Boolean scalar type represents true or false.

Date Date

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

DateTime DateTime

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

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

Field	Description
`friday`	Not nullable. Type: Float
`monday`	Not nullable. Type: Float
`saturday`	Not nullable. Type: Float
`sunday`	Not nullable. Type: Float
`thursday`	Not nullable. Type: Float
`tuesday`	Not nullable. Type: Float
`type`	Not nullable. Type of discount. Type: DiscountType
`unit`	Not nullable. Unit of the discount. Currently only PERCENTAGE is supported. Type: DiscountUnit
`wednesday`	Not nullable. Type: Float

DayOfWeekDiscountPromotionUpdateInput InputObject

Parameters used to modify the day-of-week promotion.

Field	Description
`blackoutDates`	The exception dates for which the promotion should NOT apply. If you do not want to specify blackout dates, specify an empty array here. Type: Array of non nullable BlackoutDateRangeInput
`category`	Category of the promotion. Type: PromotionCategory
`code`	Name of the promotion. Only these characters are supported: a-z, A-Z, 0-9, , /.,':!?$%() \\- 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`	Details of the actual discount being applied on the promotion. Type: DayOfWeekDiscountUpdateInput
`eligibleRatePlans`	Rate plans for which this promotion is applicable. Type: Array of non nullable EligibleRatePlanInput
`id`	Not nullable. ID of the promotion as stored in the Expedia platform. Type: ID
`name`	Name of the promotion. For day-of-week discounts, only BASIC and EARLY_BOOKING_PROMOTION are supported. Type: PromotionName
`restrictions`	List of restrictions that can be applied to this promotion. Type: RestrictionsUpdateInput
`status`	Status of the promotion. Type: PromotionStatus

DayOfWeekDiscountUpdateInput InputObject

Parameters used to update the day-of-week discount.

Field	Description
`friday`	Type: Float
`monday`	Type: Float
`saturday`	Type: Float
`sunday`	Type: Float
`thursday`	Type: Float
`tuesday`	Type: Float
`unit`	Unit of the discount. Currently, only PERCENTAGE is supported. Type: DiscountUnit
`wednesday`	Type: Float

Discount Interface

Implemented by

DayOfWeekDiscount
MultiNightDiscount
SingleDiscount

Field	Description
`type`	Not nullable. Type of the discount. Type: DiscountType
`unit`	Not nullable. Unit of the discount. Type: DiscountUnit

DiscountPromotion Object

Field	Description
`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
`category`	Not nullable. Category of the promotion. Currently, only DISCOUNT_PROMOTION is supported (such as Priced Promotions). Type: PromotionCategory
`code`	Not 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
`eligibleRatePlans`	Not nullable. Rate plans for which this promotion is applicable. Type: Array of non nullable EligibleRatePlan
`id`	Not nullable. ID of the Promotion stored in the Expedia platform. Type: ID
`name`	Not nullable. Name of the promotion. Type: PromotionName
`restrictions`	List of restrictions that can be applied to these promotions. Type: Restrictions
`status`	Not nullable. Status of the promotion. Type: PromotionStatus

DiscountType Enum

Discount type values.

Name	Description
`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

Name	Description
`PERCENT`	Percentage discount for the promotion.

EligibleRatePlan Object

Field	Description
`id`	Not nullable. ID of the rate plan stored in the Expedia platform. Type: ID

EligibleRatePlanInput InputObject

Field	Description
`id`	Not nullable. ID of the merchant rate plan stored in the Expedia platform. Specify the ID as an integer-only value, and do not specify an agency ID. Type: ID

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.

Name	Description
`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`.

Int Int

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

LocalTime LocalTime

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

MultiNightDiscount Object

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

Field	Description
`applicableNight`	Not 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
`type`	Not nullable. Type of discount. Type: DiscountType
`unit`	Not nullable. Unit of the discount. Type: DiscountUnit
`value`	Not nullable. Value of the discount applied. Type: Float

Promotion Interface

Implemented by

DiscountPromotion

Field	Description
`category`	Not nullable. Category of the promotion. Currently, only DISCOUNT_PROMOTION is supported (such as Priced Promotions). Type: PromotionCategory
`id`	Not nullable. ID of the Promotion stored in the Expedia platform. Type: ID
`name`	Not nullable. Name of the promotion. Type: PromotionName
`status`	Not nullable. Status of the promotion. Type: PromotionStatus

PromotionCategory Enum

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

PromotionName Enum

Name	Description
`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.

PromotionStatus Enum

Name	Description
`ACTIVE`
`INACTIVE`

Restrictions Object

Field	Description
`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

RestrictionsUpdateInput InputObject

Field	Description
`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. If the dates are the same in `bookingLocalDateTimeFrom` and `bookingLocalDateTimeTo`, make sure the timestamp in this field is at least one minute later than in `bookingLocalDateTimeFrom`. Type: DateTime
`isMemberOnly`	Whether a promotion is applicable for only members shopping on Expedia. Type: Boolean
`isMobileUserOnly`	Additional discounts that are available only for members shopping on Expedia. 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: Boolean
`maxAdvanceBookingDays`	Maximum number of days in advance the reservation date for the promotion to be applicable. Type: Int
`maxLengthOfStay`	Maximum duration of stay for which the promotion can be applicable. The maximum value is 28. For multi-night discounts, this value cannot be less than `applicableNight` in `MultiNightDiscount`. 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 (1-28) 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`	Travel date from which this promotion is applicable in YYYY-MM-DD format. Type: Date
`travelDateTo`	Travel date until which this promotion is applicable in YYYY-MM-DD format. Type: Date

SingleDiscount Object

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

Field	Description
`memberOnlyAdditionalValue`	Value of member-only discount applied. Type: Float
`type`	Not nullable. Type of discount. Type: DiscountType
`unit`	Not nullable. Unit of the discount. Currently only PERCENTAGE is supported. Type: DiscountUnit
`value`	Not 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.

Availability and Rates APIs

Booking APIs

Property Mgmt APIs

Promotions

updateDayOfWeekDiscountPromotion mutation

Syntax

Examples

Schema

Arguments

Types

Availability and Rates APIs

Booking APIs

Property Mgmt APIs

Promotions

updateDayOfWeekDiscountPromotion mutationCopy link

Syntax

Examples

Schema

Arguments

Types

updateDayOfWeekDiscountPromotion mutation