Ticketmaster Connection - Extension Keys

This documentation is specifically for partners connecting to Ticketmaster. Please be sure to review the Extensions page for additional details.

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

Currently, an extension key is not available for Ticketmaster integration at this level.

Product Level

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

Extension Key(s)	Required vs Optional	Description	Example
`beta-availabilityPricingType`	Supplemental	informs the Reseller if it is an attraction, seating or best available product	{`attraction`, `best_available`, `seating`}
`beta-generalInfo`	Supplemental	additional information about the event, venue, recommendations or anything else the partner wants to share	Example 1: `{""}` Example 2: `For Orlando Magic and Orlando Predators games, any patron who is 36 inches(3 feet) or taller must have a ticket for entry. Occasionally, a family show (Disney of Ice, Globetrotters, Ringling Bros., etc.) will require children younger than two (2) years old to purchase a ticket.` Example 3: `All items are subject to change per artist restrictions. NO bottles, coolers, or pets. NO weapons or recording devices are permitted. Blankets and cushions are allowed (restricted on some shows). Call venue for more info.`
`beta-localStartDate`	Optional, in case product type is `seating`	This field is populated only for products of type `seating` (SCAP). It was included as an extension to accommodate date-based SCAP products.	`{"2023-12-04"}`
`redemptionInstructions`	Supplemental	this field holds information related to the venue and product to be considered by the customer for entry	Example 1: `Dino Safari invites visitors to grab a prehistoric passport and discover how plate tectonics, land bridges, and volcanic activity allowed dinosaurs to disperse to all corners of the globe.\n\nHOURS OF OPERATION: Open 7 days a week - 11am-7:30pm (Self-guided tour takes 30-45min). The venue reserves the right to implement security procedures designed to protect the experience for all of our customers.\n\n` Example 2: `\n\nTickets are mobile only.\n\n Wheelchair accessible and companion seats are available at locations dispersed throughout Kia Center, offering guests the choice of an array of prices, amenities and lines of sight.`
`ticketmaster.AreaLabel`	Supplemental	informational only about the area group. Populated for options for products grouped by Area, SectionAndArea, Timed	Example 1: `{""}` Example 2: `{zone}`
`ticketmaster.SafetixProduct`	Supplemental	flag to inform if the product is safetix or not	{`true`, `false`}

Rate Level

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

Extension Key(s)	Required vs Optional	Description	Example
`beta-restrictSingleSeat`	Recommended	to share the indicator if there are restrictions applied to the product rate for seat selections. The flag indicates that no seats can be left unoccupied. Example: if there are 4 seats left and 3 seats are requested, the request fails as it is difficult to sell a single seat in a section. The Supplier specifies this restriction and Redeam expose the value to help Resellers understanding why the hold might be rejected. In order to increase the number of successful holds and receiving the reason for why it failed in case it does, we recommend implementing beta-restrictSingleSeat=true. The number of seats in a hold requests are limited to currentTicketLimit-1 to avoid unknowingly hitting this restriction.	{`true`, `false`}
`ticketmaster.Area`	Recommended	additional information about Area received from Ticketmaster System	Example 1: `TERRACE LEVEL (LOWER LEVEL)` Example 2: `THIRD TIER` Example 3: `Upper Level Seating`
`ticketmaster.AreaID`	Supplemental	additional information about Area ID received from Ticketmaster System. Populated for options for products grouped by Area, SectionAndArea, Timed and by default; it was discovered that there might be products where areaID for same section may differ among events	Example 1: `1` Example 2: 671bf700e339820ee47ed27e Example 3: 000000050009 The majority are still simple numbers like example #1 but we also started getting values like the others example. Just be aware of that in case any validation is added to this field data.
`ticketmaster.AreaLabel`	Supplemental	informational only about the area group. Populated for options for products grouped by Area, SectionAndArea, Timed	`zone`
`ticketmaster.Section`	Recommended depending on grouping rule	it is used only when the grouping is by 'Section', 'SectionAndArea', or another type not listed among known types (such as 'Area', 'Price', or 'Timed')	`{204}`
`ticketmaster.TicketTypeID`	Supplemental	additional information about ticket received from Ticketmaster System	Example 1: `000000050009` Example 2: `000010310003` Example 3: `000015B80003`

Extension Key(s)	Required vs Optional	Description	Example
`ticketmaster.CurrentTicketLimit`	Recommended	This additional extension key in the availability response indicates not only the product rate `maxTravelers` limit but also what the current ticket limit is set to. `maxTravelers` does not change as it is defined at product / rate level at its creation and indicates the maximum number of tickets that can be purchased. Whereas `ticketmaster.CurrentTicketLimit` informs you about the real time inventory at time of a request. Example: `maxTravelers` is 8 and the `ticketmaster.CurrentTicketLimit` is 4 at the time an availability call is made, therefore any ticket quantity higher than 4 will fail. Also, this field specifies the maximum limit of seats that can be booked together in a single request (`currentTicketLimit`). It also indicates that Ticketmaster may not be able to accommodate a party of 8 together in a single booking, but it can accommodate two separate parties of 4 for the same customer. For example, if the `ticketmaster.CurrentTicketLimit` is 4, but the event's overall ticket limit (`maxTravelers`) is 8, it means that you can book up to 4 seats in one request and then book an additional 4 seats in a separate request.	"`4`"
`ticketmaster.EventName`	Recommended	Information on this can be found in the availabilities response specific for the Ticketmaster connection. Resellers should expect to get the event name value for each availability object, not a single extension key value at the top level. Depending on the Ticketmaster event, the name can be different but are grouped under the same product. Example: a sports event uses the host team name under product name and the opponent team name in the extension key ticketmaster.EventName. Note: the Reseller needs to parse the field to get the desired data, for example Orlando Magic vs Detroit Pistons	"`Orlando Magic vs Detroit Pistons`"

Hold Level

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

Extension Key(s)	Required vs Optional	Description	Example
`beta-ticketLocations`	Required for live events	Once the supplier assigns the seats Redeam adds that information in the Hold and Booking response so the Resellers can share it with the buyer. This field reflects the real seats instead of a range of seats since the range could generate confusion in the case of venues with odd or even seat numbers. beta-ticketLocations should be 1 to 1 with the total quantity of the booking.	[`{\"section\":\"126\",\"row\":\"10\",\"seatNumbers\":[17,18],\"seats\":[\"17\",\"18\"]}`]
`resellerReference`	Supplemental	An OPTIONAL tracking reference for the Reseller that SHOULD be tracked by the Booking Platform.	{`""`}

Booking Level

Please note that at this level, there are currently beta keys (beta-(key)) and no prefix key.

Extension Key(s)	Required vs Optional	Description	Example
`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`}
`beta-ticketLocations`	Required for live events	Once the supplier assigns the seats Redeam adds that information in the Hold and Booking response so the Resellers can share it with the buyer. This field reflects the real seats instead of a range of seats since the range could generate confusion in the case of venues with odd or even seat numbers. beta-ticketLocations should be 1 to 1 with the total quantity of the booking.	[`{\"section\":\"126\",\"row\":\"10\",\"seatNumbers\":[17,18],\"seats\":[\"17\",\"18\"]}`]
`supplier.reference`	Required	is an existing field in the Redeam API spec which populates once the booking is confirmed. The Reseller needs to pull the data from this field and place it on the voucher.	Example 1: {`""`,`0017bd0f903822ecac659379,003cf3e47be47a8a655d55fe`} Example 2: `59-54207/NV3`
`ticketmaster.Safetix`	Supplemental	a default text in case the Reseller wants to share additional information with the buyer	`"The redemption URL will direct the fan to Ticketmaster website to claim the tickets. Simultaneously, the fan will receive a claim email from TM."`

Last updated on

Was this page helpful?

Ticketmaster Connection - Extension Keys

Supplier Level

Product Level

Rate Level

Rate Price Level

Price Schedule Level

Availability Level

Hold Level

Booking Level