Offering Resources
An offering is a structured set of tickets that can be sold. So far it is a subset of the tickets from a single event. The offering is intended to be detailed enough to support the general-purpose IWannaTicket widget, so it includes many details that are configured in IWannaTicket for that widget. Alternative interfaces using the Offering API will not necessarily support all of those configuration options - that should be decided between the developer of the interface and the client for whom they are working.
Offerings implement the follow features of IWannaTicket:
- ticket sale status
- event date sale status
- ticket on-sale dates
- removal of past event dates
- removal of merchandise on event dates with no tickets available
- ticket visibility according to user permissions
- ticket visibility according to availability for lay-by
- separate pages for tickets and merchandise
- interspersal of tickets and copy
- tickets available on multiple event dates
- reveal codes
- tickets remaining counts
- ticket restriction by IP geolocation
An offering type is a name which specifies a purpose for the offering, and hence the set of tickets which will be available.
- PUBLIC
- the tickets available from the public event widget
- LAYBY
- the tickets available from the public event widget which can be purchased by layby
- BOX_OFFICE
- the tickets available from the IWannaTicket box office - the authenticated user must have permission to sell as a box office operator for the event
Gets all the data for the offering
- Method
- GET
- URL
- https://api.iwannaticket.com.au/api/v2/offering/{eventId}/{type}
Request URL Components
| Name | Type | Description |
|---|---|---|
| eventId | Number | The ID of the event the offering is for |
| type | String | The offering type being requested (see description above) |
Request Parameters
| Name | Type | Description |
|---|---|---|
| showSoldOut | Optional Boolean | Whether to include sold out tickets in the response, default false. |
| reveal | Optional String | Any reveal code being used, default none. |
| forceShowTickets | Optional Boolean | If the event is withdrawn from sale tickets would not normally be returned. This option requests that tickets be returned under all circumstances. |
Output
| Name | Type | Description |
|---|---|---|
| name | String | The name of the Offering (typically the name of the event) |
| accountName | String | The name of the Account the Offering comes from |
| saleStatus | String | The sale status of the event: NOT_AVAILABLE_FOR_SALE_PUBLIC_OR_PRIVATE | NOT_AVAILABLE_FOR_SALE | AVAILABLE_FOR_SALE | AVAILABLE_FOR_SALE_FROM | SOLD_OUT | WITHDRAWN |
| onSaleDate | String | When the event goes on sale (if it's not on sale yet). |
| encodedId | String | An encoded version of the event ID, used in some URLs. |
| eventId | Number | The numeric ID of the event. |
| raCopy | OfferingCopy | Client-configured copy for the reserved allocation page. |
| tsCopy | OfferingCopy | Client-configured copy for the ticket selector page. |
| msCopy | OfferingCopy | Client-configured copy for the merchandise selector page. |
| groups | List[OfferingGroup] | The groups tickets for sale in the offering (typically event dates). |
| hideEventDate | Boolean | Whether to hide the date when displaying an offering group (usually used for tickets that don't apply to a particular date). |
| voterConfigs | List[OfferingVoterConfig] | Configuration for guardian rules configured for the event. |
| paymentGatewayConfig | OfferingPaymentGatewayConfig | Payment configuration for the event. |