Ticket Type Resources
A ticket type is a purchasable item. A ticket type is related to exactly one event date, so "Adult" on Friday night and "Adult" on Saturday night are different ticket types. Ticket types may be tickets for admission, merchandise, gift certificates, or raffle tickets.
Ticket Type Summary
- Description
- Gets a summary of the Ticket Type
- Method
- GET
- URL
- https://api.iwannaticket.com.au/api/v2/ticketType/{id}
Output
| Name | Type | Description |
|---|---|---|
| name | String | The name of this Ticket Type |
| prefix | String | The 3 digit prefix of this Ticket Type |
| eventDate | Ref | The Event Date of this Ticket Type |
| venueSection | Ref | The Venue Section of this Ticket Type |
| maximumAllocation | Number | The maximum number of Tickets of this type that may be sold |
| saleStatus | SaleStatus | The sale status of this Ticket Type |
| price | Currency | The price of this Ticket Type |
| fee | Currency | The fee of this Ticket Type |
| ticketsSold | Number | The amount of tickets sold for this Ticket Type |
| revenue | Currency | The revenue for this Ticket Type |
| average | Currency | The average sale price of this Ticket Type. Revenue divided by ticketsSold |
| tags | String | Tags on the Ticket Type |
| maximumScans | Number | The maximum number of times one of these tickets can be used for entrance |
| scanBarcode | Boolean | Whether a ticket will have a barcode other than the ticket code which should be scanned (e.g. a wristband or ID card) |
| sortIdx | Number | The ticket's sort order value |
| oncePerDay | Boolean | Whether the ticket will scan successfully at most once per day. |
| geolocationRule | String | The region in which the ticket should be shown according to IP geolocation. |
Creates a new ticket type
- Method
- POST
- URL
- https://api.iwannaticket.com.au/api/v2/ticketType/
Input
| Name | Type | Description |
|---|---|---|
| name | String | Name of the ticket |
| eventDate | Number | The event date which this ticket is for. |
| venueSection | Number | The venue section this ticket is for. |
| prefix | Optional String | The prefix for this ticket (used on the printed ticket instead of the name). |
| maxOrder | Number | The maximum you can buy of this ticket in one order. |
| minOrder | Number | The minimum you can buy of this ticket in one order. |
| quantity | Number | The maximum number of this ticket that can be sold. |
| price | Number | The price in AUD of this ticket. |
| maxScans | Optional Number | The maximum number of times this ticket can be validly scanned. |
| scanBarcode | Optional Boolean | Whether there will be a barcode, such as on a wristband or membership card, that should be scanned instead of the ticket number. |
| tags | Optional List[String] | Metadata tags for this ticket. |
| oncePerDay | Optional Boolean | Whether this ticket may be successfully scanned at most once per calendar day. |
| geolocationRule | Optional String | The region within which this ticket should be shown according to IP geolocation. |
Reserved Allocation Layout
- Description
- Gets the Venue Section layout for this Ticket Type
- Method
- GET
- URL
- https://api.iwannaticket.com.au/api/v2/ticketType/{id}/allocatables
Output
| Name | Type | Description |
|---|---|---|
| allocatables | List[Allocatable] | A list of Allocatables |