Sale Resources
These were formerly described as payment resources.
A sale is a sale of tickets (admissions) to exactly one event to a buyer (who is historically incorrectly referred to as the payee).
Sale Summary
- Description
- Gets a summary of the sale
- Method
- GET
- URL
- https://api.iwannaticket.com.au/api/v2/payment/{id}
Output
| Name | Type | Description |
|---|---|---|
| key | String | The sale key |
| cartId | String | The cart identifier |
| status | String | The sale status - RESERVED, LOCKED, PROCESSING, CONFIRMED, UNFULFILLED |
| event | Ref | The sale's Event |
| customer | Customer | The purchasing customer |
| totalPrice | Currency | The total price of the payment |
| admissions | List[Ref] | All Admissions belonging to this Sale |
| transactions | List[PaymentTransaction] | All transactions that make up this Sale |
| data | Map[String, String] | Payee data |
| modifed | Date | Last modified date |
| created | Date | Sale creation date |
| tags | List[String] | Any relevant tags |
| transactions | List[Transaction] | All transactions for this sale |
| bookingCode | Optional String | Booking codes that were submitted for this sale |
Update Data
- Description
- Update Payee Data
- Method
- PUT
- URL
- https://api.iwannaticket.com.au/api/v2/order/{key}/data
Input
JSON Map of payee data.
Example:
- FIRST_NAME (String)
- LAST_NAME (String)
- etc
Resend Email
- Description
- Send Tickets via Email
- Method
- GET
- URL
- https://api.iwannaticket.com.au/api/v2/order/{key}/sendEmail
Send (or resend) tickets for the order by email. This will fail if any tickets are not allowed to be sent, e.g. if they are not yet paid for or if they require guest details to be added.
Admit Sale
- Description
- Admit whole sale to event
- Method
- POST
- URL
- https://api.iwannaticket.com.au/api/v2/order/{key}/admit
Admit the whole sale to the event. This API doesn't care about event dates, it just admits all the tickets.