Disney Connection - Extension Keys

This documentation is specifically for partners connecting to Disney. Please be sure to review the Extensions page for additional details. Also note that these keys will be used in the same way across both property brands, Walt Disney World® and Disneyland Resort®.

Redeam recommends implementing all keys, even if your system cannot currently process the provided information. By storing the data now, you will be prepared to easily update your processes in the future as your system evolves or when connecting to additional partners.

Please note that this is a living document. If the integration requires new extension keys to share additional information, Redeam will update both the code and this documentation accordingly.

Please do not develop the keys with an x- prefix as they will be excluded from distribution.

Note that the x-(key) are for Redeam's internal use only and should not be exposed to our partners and we are currently working on achieving this.

In this documentation, the following categories are used to describe the inclusion and usage of extension keys in API request and responses. These categories help you understand when an extension key is necessary, beneficial, or optional for your integration:

Required: The field is mandatory and must be included in the request or response. Omitting it may cause integration issues or result in supplier disapproval of the connection until it is correctly implemented.
Recommended: The field is not strictly required but is highly beneficial. Including it can enhance your integration or user experience.
Supplemental: The field provides additional, optional information. While not required, it can offer valuable context or or enhance the available data.
Optional, Use if Present: The field is not required, but if it appears in the response, it should be used. This category is typically used for fields that offer complementary information that can enhance functionality when available but can be ignored if not present.

Supplier Level

At this level, the API response currently includes partner-specific keys (disney-(key)).

Extension Key(s)	Required vs Optional	Description	Example
`disney-distributorName`	Supplemental	The human-readable name of the originating Reseller or Channel.	`{Super Travel Agency}`
`disney-marketRegions`	Supplemental	Specifies the geographical territories where the products are available for booking. This field includes a list of region codes that correspond to specific markets. By defining the market regions, Disney can manage product availability, pricing, and promotional efforts tailored to different locations.	{`DEST_SALES, INTL_WHOLESALE, UK_SELECT`}
`disney-pointOfSaleName`	Supplemental	Identifies the specific location or system where a transaction takes place.	`{Germany - WDW`, `HQ 1 - WDW`, `Ireland - WDW}`
`disney-propertyBrand`	Recommended	Disney operates numerous parks worldwide, including locations in Florida, California, Paris, and Tokyo. Each park is differentiated by its Property Brand, which serves to identify and categorise the distinct locations within the Disney portfolio.	`{WDW`, `DLR}`

Please note that the beta-distributorName, beta-marketRegions, and beta-pointOfSaleName extension keys in the API responses will be deprecated in the future. To prepare for this change, ensure that you have implemented the equivalent keys with the disney- prefix as listed above.

Product Level

At this level, the API response currently includes partner-specific keys (disney-(key))

Extension Key(s)	Required vs Optional	Description	Example
`disney-productDuration`	Optional, Use if Present	The length of time, in days, that a product is valid. This field helps calculate the full date range for ticket usage. For example, for a 2-day ticket with a 1-day buffer, the field provides just the duration (e.g., {`2`}), simplifying the calculation rather than having to parse the product name.	`{2}`
`disney-productType`	Supplemental	This field specifies the type of product being offered, such as whether it is a Theme Park, Special Event, or Waterpark product. It helps identify the category or experience associated with the product.	`{themepark}`

Please note that the beta-productDuration, and beta-productType extension keys in the API responses will be deprecated in the future. To prepare for this change, ensure that you have implemented the equivalent keys with the disney- prefix as listed above.

Rate Level

At this level, the API response currently includes partner-specific keys (disney-(key)) and beta keys (beta-(key)).

Extension Key(s)	Required vs Optional	Description	Example
`beta-policy`	Required for the Will Call	Text details outlining the cancellation policy or a URL where the policy can be accessed (as in the Disney integration). As the Reseller, you can either display the URL link with the policy information or retrieve the details from the URL and present them directly to the user.	{`https://dis-obs.redeam.io/content/xxxx/yyyy/policy?optionId=zzzz`}
`disney-bookingBufferDays`	Optional, Use if Present	This buffer period ensures that there is adequate time for using the tickets. Disney tickets need to be used within a specific time frame. That time frame is determined by the length of the ticket. This means depending on the length some buffer days can be given so the customer doesn't have to use the tickets on consecutive days. If buffer days are applied to the ticket selected, the number of Disney availability days must be at least the duration. For example, if the park reservation is for a duration of 5 days, and 2 buffer days are given, the total usage for that ticket reservation will be 7 days.	`{2}`
`disney-dateBasedTicket`	Recommended	A `true`/`false` flag to indicate if the ticket is date based or not. When a customer purchases a Disney ticket the usage of the ticket falls into these two different categories. DateBased (aka Validity Dates): These tickets must be used within a specific date range that is determined based on the ticket type and the arrival date of the customer. NonDateBased: These tickets can be used throughout a much larger range of dates (for example the rest of the year) and there are blackout dates where these tickets can not be used.	{`true`, `false`}
`disney-discountGroups`	Supplemental	Categorises discount groups for products within the API, enabling Disney to implement targeted promotions and offer tailored discounts to specific customer segments.	{`CONVENTION, CANADA_RESIDENT`}
`disney-marketRegions`	Supplemental	Specifies the geographical territories where the products are available for booking. This field includes a list of region codes that correspond to specific markets. By defining the market regions, Disney can manage product availability, pricing, and promotional efforts tailored to different locations.	{`DEST_SALES, INTL_WHOLESALE, UK_SELECT`}
`disney-parkLocations`	Supplemental	This field specifies the exact Disney park associated with a booking, providing clarity on the location.	{Magic Kingdom® Park`,`Disney's Animal Kingdom® Theme Park`,`Disney's Hollywood Studios®`,`EPCOT®}
`disney-parkReservationRequired`	Recommended, if the reseller is supposed to use park reservation through API	A `true`/`false` flag indicating whether Park Reservations are required for the product	{`true, false`}
`disney-productDuration`	Optional, Use if Present	The length of time, in days, that a product is valid. This field helps calculate the full date range for ticket usage. For example, for a 2-day ticket with a 1-day buffer, the field provides just the duration (e.g., {`2`}), simplifying the calculation rather than having to parse the product name.	`{2}`
`disney-productType`	Supplemental	This field specifies the type of product being offered, such as whether it is a Theme Park, Special Event, or Waterpark product. It helps identify the category or experience associated with the product.	{`themepark`, `waterpark`, `specialevent`}
`disney-salesStartDate`	Recommended	This field indicates the starting date a ticket is available for sale/purchase and especially relevant for promotions, seasonal tickets, and date-based pricing.	{`2023-10-24T00:00:00-04:00`}
`disney-salesEndDate`	Recommended	This field indicates the ending date a ticket is available for sale/purchase and especially relevant for promotions, seasonal tickets, and date-based pricing.	{`2025-12-31T23:59:59-05:00`}
`disney-ticketType`	Supplemental	Indicates the pricing structure of a product, specifying whether it has a fixed price or a variable price. Note: This does not correlate to dynamic/flexible pricing	{`fixed, variable`}
`disney-usageStartDate`	Supplemental	This field shows the starting date a purchased ticket can be used.	{`2024-10-24`}
`disney-usageEndDate`	Supplemental	This field shows the ending date a purchased ticket can be used.	{`2026-01-14`}

Please note that besides the beta-policy key, all the other beta-extension keys in the API responses will be deprecated in the future. To prepare for this change, ensure that you have implemented the equivalent keys with the disney- prefix as listed above. Please also note that the keys disney-usageStart, disney-usageEnd, disney-salesStart, and disney-salesEnd will be removed. The equivalent keys ending in 'Date,' as listed above, will be retained.

Rate Price Level

At this level, the API response currently includes partner-specific keys (disney-(key)).

Extension Key(s)	Required vs Optional	Description	Example
`disney-discountGroups`	Supplemental	Categorises discount groups for products within the API, enabling Disney to implement targeted promotions and offer tailored discounts to specific customer segments.	{`CONVENTION, CANADA_RESIDENT`}
`disney-marketRegions`	Supplemental	Specifies the geographical territories where the products are available for booking. This field includes a list of region codes that correspond to specific markets. By defining the market regions, Disney can manage product availability, pricing, and promotional efforts tailored to different locations.	{`DEST_SALES, INTL_WHOLESALE, UK_SELECT`}
`disney-parkReservationRequired`	Recommended, if the reseller is supposed to use park reservation through API	A `true`/`false` flag indicating whether Park Reservations are required for the product	{`true, false`}
`disney-productType`	Supplemental	This field specifies the type of product being offered, such as whether it is a Theme Park, Special Event, or Waterpark product. It helps identify the category or experience associated with the product.	{`themepark`, `waterpark`, `specialevent`}
`disney-salesStartDate`	Recommended	This field indicates the starting date a ticket is available for sale/purchase and especially relevant for promotions, seasonal tickets, and date-based pricing.	{`2023-10-24T00:00:00-04:00`}
`disney-salesEndDate`	Recommended	This field indicates the ending date a ticket is available for sale/purchase and especially relevant for promotions, seasonal tickets, and date-based pricing.	{`2025-12-31T23:59:59-05:00`}
`disney-ticketType`	Supplemental	Indicates the pricing structure of a product, specifying whether it has a fixed price or a variable price. Note: This does not correlate to dynamic/flexible pricing	{`fixed, variable`}
`disney-usageStartDate`	Supplemental	This field shows the starting date a purchased ticket can be used.	{`2024-10-24`}
`disney-usageEndDate`	Supplemental	This field shows the ending date a purchased ticket can be used.	{`2026-01-14`}

Price Schedule Level

At this level, the API response currently includes partner-specific keys (disney-(key)) and beta keys (beta-(key)).

Extension Key(s)	Required vs Optional	Description	Example
`beta-lastUpdated`	Supplemental	Provides the timestamp indicating the last time the supplier updated the data for a specific product. Since the supplier may update prices for some products but not all, this field helps track which products have been recently updated.	`{2025-01-02T13:56:19Z}`
disney-netDiscount	Supplemental	The discount applied to the product's net price, typically used for promotions or special pricing. This data can be provided as either a percentage or an amount. The Reseller needs to parse this field to get the desired data.	Example 1: `{"disney-netDiscount": "10.0%"}` Example 2: `{"disney-netDiscount": "$45.79"}`

Note: Disney shared one thing that may be noteworthy, the fact that net discounts for a ticket can vary by date or date range (as opposed to the same net discount for a ticket across all dates as it is today). In the Redeam API response, this data will be mapped to all price schedule dates where there is a netDiscount that is not null.

Availability Level

At this level, the API response currently includes partner-specific keys (disney-(key)).

Extension Key(s)	Required vs Optional	Description	Example
`disney-contractStart`	Supplemental	This field indicates the date when the reseller is authorized to begin selling tickets under their contract with Disney. It marks the official start of the agreed-upon sales period. Note: This field is conditional and will only be displayed if the queried availability falls outside of the contract dates. In such cases, the response will include this extension key, otherwise it will be omitted.	`{2022-01-01T00:00:00-05:00}`
`disney-contractEnd`	Supplemental	This field represents the date when the reseller’s authorization to sell tickets ends, as per their contract with Disney. It signifies the conclusion of the sales period defined in the agreement. Note: This field is conditional and will only be displayed if the queried availability falls outside of the contract dates. In such cases, the response will include this extension key, otherwise it will be omitted.	`{2025-12-31T00:00:00-05:00}`
`disney-details`	Supplemental	Returned at the availability level to indicate why certain availability items are removed. In such cases, the contract dates will also be included. Note: This field is conditional and will only be displayed if the queried availability falls outside of the contract dates. In such cases, the response will include this extension key, otherwise it will be omitted.	{`availability item removed - out of contract date range`}

Hold Level

At this level, the API request and response currently includes partner-specific keys (disney-(key)) and no prefix keys.

REQUEST

Extension Key(s)	Required vs Optional	Description	Example
`disney-parkReservationDates_YYYY-MM-DD`	Required, if the reseller is supposed to use park reservation through API	This field/value marks the date and the park reserved for that date. To create the ReservationDate, the field/value is structured as such "disney-parkReservationDate_[date of reservation]": "[comma delineated list of parks"]._ This field is the only mandatory requirement for initiating a park reservation request with Disney. However, if the corresponding date details are omitted or if an incorrect date is provided, the request will fail during the Create Booking Request process. This means that if the "disney-parkReservationDate_[Date]" field is left blank or contains invalid dates, the reservation request will not be successfully processed. Additionally, if the "disney-parkReservationRequired" field is set to true, it indicates that a reservation is mandatory. In this case, the system will expect corresponding dates to be provided in the "disney-parkReservationDate_" fields. Even if the "disney-parkReservationDate_[Date]" fields are not supplied, the request will still be sent, leading to a failure due to the missing date information.	Example 1: `{_disney-parkReservationDate_ 2022-11-02": "epcot"}` Example 2: `{_disney-parkReservationDate_ 2022-11-02": "epcot,animal-kingdom,hollywood-studios,magic-kingdom}`
`resellerReference`	Required if the reseller is distributing Disneyland Resort® products and creating bookings; Recommended for Walt Disney World®.	Reseller reference ID for the booking	{`b0057cd9-4103-4c46-83ee-9151c42879d7`}

RESPONSE

Note: The extension keys under the Rate object will be included in hold response, as they are part of our API schema, which you can view here. These extensions can be beneficial for resellers if they require rate information as part of the hold.

Extension Key(s)	Required vs Optional	Description	Example
`disney-correlationID-hold`	Supplemental	The Disney request ID for this transaction, which is useful for resolving support issues related to a specific hold transaction.	{`5fc468da2a135fd686ba22951c1e2541`}
`disney-dateBasedTicket`	Recommended	A `true`/`false` flag to indicate if the ticket is date based or not. When a customer purchases a Disney ticket the usage of the ticket falls into these two different categories. DateBased (aka Validity Dates): These tickets must be used within a specific date range that is determined based on the ticket type and the arrival date of the customer. NonDateBased: These tickets can be used throughout a much larger range of dates (for example the rest of the year) and there are blackout dates where these tickets can not be used.	{`true`, `false`}
`disney-isVariablePrice`	Supplemental	A `true`/`false` flag that indicates whether the product maintains a fixed price or a variable price throughout the ticket usage period. Note: This does not correlate to dynamic/flexible pricing	{`true, false`}
`disney-parkReservationRequired`	Recommended, if the reseller is supposed to use park reservation through API	A `true`/`false` flag indicating whether Park Reservations are required for the product	{`true, false`}
`disney-reservationValidityStart`	Optional, Use if Present	This field indicates the start date of the reservation validity period for the product. It defines the earliest date when a reservation can be made for the customer. *Note: This is a specific case where the reseller must pass this data based on the inventory and ticket type they have available.	{`2024-01-01,2024-01-02,2024-01-04`}
`disney-reservationValidityEnd`	Optional, Use if Present	This field specifies the end date of the reservation validity period. It marks the latest date by which the customer can make a reservation before it expires. *Note: This is a specific case where the reseller must pass this data based on the inventory and ticket type they have available.	{`2024-01-09,2024-01-14,2024-01-20`}
`disney-ticketStartDate`	Supplemental	This field defines the start date of the validity period for a product or booking. It indicates the first day the ticket can be used before it expires. *Note that these fields will only be present in the extension key for DateBased tickets.	{`2023-12-31,2024-01-01,2024-01-02`}
`disney-ticketEndDate`	Supplemental	This field defines the end date of the validity period for a product or booking. It indicates the last day the ticket can be used before it expires. *Note that these fields will only be present in the extension key for DateBased tickets.	{`2023-12-31,2024-01-01,2024-01-02`}
`resellerReference`	Required if the reseller is distributing Disneyland Resort® products and creating bookings; Recommended for Walt Disney World®.	Reseller reference ID for the booking	{`b0057cd9-4103-4c46-83ee-9151c42879d7`}

Important note about disney-ticketStartDate & disney-ticketEndDate: per Disney requirements, when presenting the information to the customer you MUST ensure the sentence is formatted as:

Your ticket is valid any {{TicketValidityDays}} day(s) between {{TicketStartDate}} and {{TicketEndDate}}

Example: “Your ticket is valid any 8 day(s) between 06/14/2023 and 06/22/2023”

Booking Level

At this level, the API request and response currently includes partner-specific keys (disney-(key)), beta keys (beta-(key)) and no prefix keys.

REQUEST

Extension Key(s)	Required vs Optional	Description	Example
`disney-deliveryDate`	Required, if the reseller is enrolled for Bulk Tickets sales	The date on which the Reseller is scheduled to pick up their tickets, or, if the tickets are being shipped, the expected shipping date.	{`2024-11-13`}
`disney-deliveryInstructions`	Required, if the reseller is enrolled for Bulk Tickets sales	A freeform field allowing Resellers to provide additional delivery details, such as reiterating previously shared instructions or specifying an alternate delivery address for the tickets.	`{132 Main Street, Kingston, New York 12401}`
`disney-deliveryType`	Required, if the reseller is enrolled for Bulk Tickets sales	Specifies the delivery method for the ticket. Possible values include: PICKUP: Tickets will be available for collection at a designated location. DELIVERY: Tickets will be shipped to the address provided by the Reseller. This field determines how the Reseller receives the ticket based on the selected delivery option.	{`PICKUP`, `DELIVERY`}
`disney-parkReservationDates_YYYY-MM-DD`	Required, if the reseller is supposed to use park reservation through API	This field/value marks the date and the park reserved for that date. To create the ReservationDate, the field/value is structured as such "disney-parkReservationDate_[date of reservation]": "[comma delineated list of parks"]._ This field is the only mandatory requirement for initiating a park reservation request with Disney. However, if the corresponding date details are omitted or if an incorrect date is provided, the request will fail during the Create Booking Request process. This means that if the "disney-parkReservationDate_[Date]" field is left blank or contains invalid dates, the reservation request will not be successfully processed. Additionally, if the "disney-parkReservationRequired" field is set to true, it indicates that a reservation is mandatory. In this case, the system will expect corresponding dates to be provided in the "disney-parkReservationDate_" fields. Even if the "disney-parkReservationDate_[Date]" fields are not supplied, the request will still be sent, leading to a failure due to the missing date information.	Example 1: `{_disney-parkReservationDate_ 2022-11-02": "epcot"}` Example 2: `{_disney-parkReservationDate_ 2022-11-02": "epcot,animal-kingdom,hollywood-studios,magic-kingdom}`

RESPONSE

Note: The extension keys under the Rate object will be included in booking response, as they are part of our API schema, which you can view here. These extensions can be beneficial for resellers if they require rate information as part of the booking.

Extension Key(s)	Required vs Optional	Description	Example
disney-correlationID-confirm	Supplemental	The Disney request ID for this transaction, which is useful for resolving support issues related to a specific confirm transaction.	{`795f890673c771f8fdac0ad25cac4793`}
`disney-correlationID-hold`	Supplemental	The Disney request ID for this transaction, which is useful for resolving support issues related to a specific hold transaction.	{`5fc468da2a135fd686ba22951c1e2541`}
`beta-deliveryMethod`	Supplemental	This extension key beta-deliveryMethod is used to map the product delivery format so the Reseller can use it as a reference. A value of TICKET indicates that there is one barcode.value for each ticket in the Booking, a value of VOUCHER indicates that there is one barcode.value which is shared for all tickets in the Booking.	{`TICKET`,`VOUCHER`}
`disney-dateBasedTicket`	Recommended	A true/false flag to indicate if the ticket is date based or not. When a customer purchases a Disney ticket the usage of the ticket falls into these two different categories. DateBased (aka Validity Dates): These tickets must be used within a specific date range that is determined based on the ticket type and the arrival date of the customer. NonDateBased: These tickets can be used throughout a much larger range of dates (for example the rest of the year) and there are blackout dates where these tickets can not be used.	{`true`, `false`}
`disney-disneyPayloadId`	Supplemental	A unique identifier assigned to Disney data payload transmitted within an API request or response.	`{38242278960079176449}`
`disney-isVariablePrice`	Supplemental	A `true`/`false` flag that indicates whether the product maintains a fixed price or a variable price throughout the ticket usage period. Note: This does not correlate to dynamic/flexible pricing	{`true, false`}
`disney-parkReservationRequired`	Recommended, if the reseller is supposed to use park reservation through API	A `true`/`false` flag indicating whether Park Reservations are required for the product	{`true, false`}
`disney-parkReservationStatus`	Recommended, if the reseller is supposed to use park reservation through API. If not the case it defaults to `none`	Indicate the current status of a park reservation. These values provide insights into whether the reservation is [success, partial, failure, error, or none]. In the event of an error during the reservation process, additional information about the nature of the error will be provided in the `disney-parkReservationErrorDetails` field.	{`failure`,`none`,`partial`}
`disney-reservationValidityStart`	Optional, Use if Present	This field indicates the start date of the reservation validity period for the product. It defines the earliest date when a reservation can be made for the customer. *Note: This is a specific case where the reseller must pass this data based on the inventory and ticket type they have available.	{`2024-01-01,2024-01-02,2024-01-04`}
`disney-reservationValidityEnd`	Optional, Use if Present	This field specifies the end date of the reservation validity period. It marks the latest date by which the customer can make a reservation before it expires. *Note: This is a specific case where the reseller must pass this data based on the inventory and ticket type they have available.	{`2024-01-09,2024-01-14,2024-01-20`}
`disney-ticketStartDate`	Supplemental	This field defines the start date of the validity period for a product or booking. It indicates the first day the ticket can be used before it expires. *Note that these fields will only be present in the extension key for DateBased tickets.	{`2023-12-31,2024-01-01,2024-01-02`}
`disney-ticketEndDate`	Supplemental	This field defines the end date of the validity period for a product or booking. It indicates the last day the ticket can be used before it expires. *Note that these fields will only be present in the extension key for DateBased tickets.
`supplier.reference`	Recommended	A tracking reference ID provided by the Supplier. This field is recommended to be tracked by the Reseller for accurate record-keeping and reconciliation purposes.	{`25100002052440848`}

Last updated on

Was this page helpful?