Reservation Resources
A reservation is a group of admissions for one event which are currently held for a customer. When a reservation is paid for, it becomes a sale. If a reservation is not paid for it will be removed by the IWannaTicket daemon after some time.
Get Reservation
- Description
- Get a reservation
- Method
- GET
- URL
- https://api.iwannaticket.com.au/api/v2/reservation/{key}
Output
| Name | Type | Description |
|---|---|---|
| successful | Boolean | Whether the reservation request was successful |
| messages | List[String] | Whether the reservation request was successful |
| key | String | The sale key |
| multiSaleKey | String | The multi-sale key (cart ID) |
| link | Ref | The related Sale |
| expiry | String | Time when the reservation will expire |
| invoice | Invoice | Display invoice for the reservation |
| layby | Boolean | Whether the reservation is for a layby sale |
| paymentSchedule | PaymentSchedule | Included only for a lay-by sale. Details of the payment plan |
Create Reservation
- Description
- Make a reservation
- Method
- POST
- URL
- https://api.iwannaticket.com.au/api/v2/reservation
Input
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| event | Number | The id for the event this reservation relates to | |||||||||
| tickets | List[Map] |
|
|||||||||
| bookingCode | optional String | Space-separated discount codes, booking codes and credit notes. | |||||||||
| boxOffice | optional Boolean, default false | If true, allows the reservation of tickets which are usually available by sale only at the box office. | |||||||||
| multiOrderKey | optional String | The cart ID for the cart this reservation should go into. | |||||||||
| layby | optional Boolean | Whether to create a payment plan for this sale. |
Output
| Name | Type | Description |
|---|---|---|
| successful | Boolean | Is this a successful reservation |
| messages | List[String] | Any failure messages |
| key | String | The sale key if successful |
| multiSaleKey | String | The multi-sale key (cart identifier) if successful |
| link | String | The link to the reservation |
| expiry | Date | The reservation expiry time |
| invoice | Invoice | The invoice for the reservation |
| layby | Boolean | Whether a payment plan has been created for this sale |
| paymentSchedule | PaymentSchedule | Included only for a lay-by sale. Details of the payment plan |
Preview Reservation
This call is similar to the reserve call above, but does not create a reservation. It turns the invoice describing the prices and discounts that would apply were the reservation to be made. Messages returned may indicate the likely success or failure of any attempt to make the reservation.
- Description
- Preview a reservation
- Method
- POST
- URL
- https://api.iwannaticket.com.au/api/v2/reservation/preview
Input
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| event | Number | The id for the event this reservation relates to | |||||||||
| tickets | List[Map] |
|
|||||||||
| bookingCode | optional String | Space-separated discount codes, booking codes and credit notes. | |||||||||
| boxOffice | optional Boolean, default false | If true, allows the reservation of tickets which are usually available by sale only at the box office. |
Output
| Name | Type | Description |
|---|---|---|
| successful | Boolean | Is this a successful reservation |
| messages | List[String] | Any failure messages |
| invoice | Invoice | The invoice for the reservation |
Delete Reservation
- Description
- Delete a reservation - tickets become available again
- Method
- DELETE
- URL
- https://api.iwannaticket.com.au/api/v2/reservation/{key}
Lock Reservation
- Description
- Lock a reservation for payment.
- Method
- POST
- URL
- https://api.iwannaticket.com.au/api/v2/reservation/{key}/lock
Input
JSON Map of payee data.
Example:
- FIRST_NAME (String)
- LAST_NAME (String)
- etc
Unlock Reservation
- Description
- Unlock a reservation - tickets become RESERVED again.
- Method
- POST
- URL
- https://api.iwannaticket.com.au/api/v2/reservation/{key}/unlock
Payment
- Description
- Make a payment on a reservation
- Method
- POST
- URL
- https://api.iwannaticket.com.au/api/v2/reservation/{key}/payment
Input
| Name | Type | Description |
|---|---|---|
| amounts | Map |
|
| creditCard | CreditCard | Credit card details used to make the payment if appropriate |