This documentation is specifically for partners connecting to Broadway Inbound. Please be sure to review the Extensions page for additional details.
Travel Curious 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, Travel Curious 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 Travel Curious'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 Broadway Inbound integration at this level.
Product 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-availabilityPricingType | Supplemental | informs the Reseller if it is an attraction, seating or best available product | {attraction, best_available, seating} |
beta-categories | Supplemental | designed to offer additional contextual information that helps classify or group related products. | {MUSICAL, PLAY, COMEDY, SPORTS } |
beta-generalInfo | Supplemental | additional information about the event, venue, recommendations or anything else the partner wants to share | {Runtime: Approximately 3 hours and 10 minutes including one 30 minute intermission} |
redemptionInstructions | Supplemental | this field holds information related to the venue and product to be considered by the customer for entry |
|
Rate Level
Currently, an extension key is not available for Broadway Inbound integration at this level.
Rate Price Level
Currently, an extension key is not available for Broadway Inbound integration at this level.
Price Schedule Level
Currently, an extension key is not available for Broadway Inbound integration at this level.
Availability Level
At this level, the API response currently includes beta keys (beta-(key)).
| Extension Key(s) | Required vs Optional | Description | Example |
|---|---|---|---|
beta-attractions | Supplemental | provides additional details about attractions or events, offering contextual information to facilitate better understanding and consumption of event-specific data. This key can include the opponent's name for sports events, enabling Resellers to access more details about the game scheduled for a particular day. | "Houston Astros" |
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, Travel Curious 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. |
|
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)), no prefix key and partner-specific keys (broadwayinbound-(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, Travel Curious 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. |
|
broadwayinbound.eTicketPrintDate | |||
supplier.reference | Required | this is an existing field in the Travel Curious 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. |
|