Hype5 Docs

Hype5 Theater 0.7.0 · Beta — by invitation

Ticket offers

A ticket offer is a link from a performance to an external seller, with an optional price range and availability. Hype5 Theater does not sell tickets, take payments or manage seats.

On this page

Where offers are edited

Ticket offers belong to a performance. Edit them in the performance panel of the Schedule (Mängukava) in the Hype5 app (where the app is switched off: the classic Schedule screen). This needs the manage performances permission (manage_hype5t_performances). See Schedule and performances.

A performance can have up to 30 offers, shown in the order you give them. A save writes the performance and all its offers together, or nothing.

Fields

Field Notes
Seller (provider) The organisation that sells the tickets, for example the box office or a ticketing service. Short text.
Name (label) What this offer is, for example Adult, Student or Group. Short text.
Web address The page where the ticket is bought. Must be an http or https address. Without an address there is never a purchase button.
Price from / to Non-negative prices with at most two decimals (a decimal comma is accepted in the app). The maximum must not be below the minimum. Leave both empty if you do not want to show a price.
Currency A three-letter code such as EUR (default). EUR is shown as €.
Availability Available, Sold out, Closed or Unknown.
Note A short public note, for example Includes a programme.

An offer row that is completely empty is ignored when you save.

When a ticket button appears

A purchase link (ticket button) is shown only when all of these are true:

  1. the performance is in the future;
  2. its occurrence status is Scheduled (not Sold out, Cancelled or Postponed);
  3. the offer has a web address;
  4. the offer's availability is Available or Unknown;
  5. the production is visible to the visitor — published, and not password protected (or unlocked on its own page). See Security and content visibility.

Offers that do not meet the rule stay visible as information — for example a sold-out offer with its price — but without a purchase link. Ticket availability and the performance's occurrence status are separate: marking an offer Sold out does not change the performance, and marking the performance Sold out does not change its offers.

Tip. Use the performance's occurrence status Sold out when the whole performance is sold out, and an offer's availability Sold out when only that kind of ticket is gone.

Prices on the website

How prices are summarised in schedules is a display option, set globally in the Appearance studio (production page and general schedule) and per shortcode with price_mode:

Mode Shows
from_lowest (default) From and the lowest minimum price of the purchasable offers, per currency.
range The lowest minimum to the highest maximum price of the purchasable offers.
hide No price summary.

Only offers that pass the purchase rule above and have a minimum price count towards the summary. The words From, Buy tickets, Sold out and so on are public texts (labels) that you can change in Appearance → Text. See Labels.

Overview reminders

In the Hype5 app, the Overview lists under Needs attention any performance in the next 30 days that is not cancelled and has no ticket offer. Reminders can be hidden per browser. See The Hype5 app.

For developers

  • The public REST route GET /hype5-theater/v1/performances returns each performance's ticket_offers with provider, label, url, price_min, price_max, currency, availability, note and sort_order. A client must apply its own purchase rule; see REST API.
  • In templates, prepared offers carry purchase (true when a button may be shown). Never build a purchase link where purchase is false. See Template overrides.