Packages, products and add-ons
list_packages_and_add_onsFetch packages for an event or performance; if a transaction ID is given, also return that basket's products and add-ons.
Instructions
Packages (bundles priced per performance, with capacity remaining and total price) for one event (GET /package/, paged) or one performance (GET /performance/{id}/package/). With a transaction_id, also the products available to that basket (GET /product/) and its add-ons such as booking protection (GET /add-on/); the API scopes both to a transaction, so without one they are not fetched. Give event_id or performance_id.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | API page number to start from (1-based, as the spec documents; use next_page from a previous call) | |
| event_id | No | Packages for every performance of this event (API parameter `event_id`, required by GET /package/) | |
| package_id | No | Only this package (API parameter `package_id`) | |
| max_results | No | Stop once at least this many records have been fetched. Whole API pages are returned, so up to one page more may come back; next_page says where to continue | |
| performance_id | No | Packages for this one performance instead | |
| start_date_gte | No | Only performances starting on or after this date (API parameter `start_date.gte`) | |
| start_date_lte | No | Only performances starting on or before this date (API parameter `start_date.lte`) | |
| transaction_id | No | A basket (txn_ id) to list products and add-ons for (API parameter `transaction_id`) | |
| include_contact_details | No | Include email addresses and phone numbers typed into package, product and add-on names and descriptions. Off by default: email addresses and phone numbers typed into any text field (names, descriptions, notes, labels, references) are replaced with [email redacted] / [phone redacted]. |