Orders
An order represents a single commercial interaction and becomes a completed order during the final stage of an order flow.
Order types
Several types of orders can be made via the API representing Vista features that are typically presented as isolated UI flows. The type of an order cannot be changed throughout the order process nor can the functionality of the different order types be mixed within a single order.
| Order Type | Description |
|---|---|
| Standard | Used for purchasing tickets and/or food and beverage items from a site. |
| Gift Shop | Used for purchasing vouchers, gift cards, merchandise, etc. from the gift shop. |
| Subscription | Used for purchasing and reactivating subscriptions. |
Order status
An order will have an InProgress status until it has been completed. Once completed, the order will have a Completed status
and is considered a completed order.
Completed orders can be refunded, modified, or have other actions performed on them via completed order actions.
Order stages
Order creation
Creating an order typically involves knowing the type of order being made and the minimal required information in order to start it. For example, a standard order requires the identifier of the site the order is for whereas the subscription type requires additional information as to whether the subscription will be recurring or not.
Order population
The population stage of the order is akin to populating a shopping cart. This is done by adding and removing different items to the order. The types of items available to add to the order vary by order type. For example, a standard order will allow tickets and items to be added to the order whereas a gift shop order will only allow items.
The order population stage is also where other order customisations are made including:
- Customer details.
- Ticket vouchers.
- Ticket redemption cards.
- Discounts and deals.
- Tips.
Payment & order completion
Completion is the final step in the order process. During this step, data is committed to Vista such as:
- Transaction details (e.g., items sold).
- Seats reservations.
- Loyalty points/rewards redeemed.
- Loyalty points earned.
- Vouchers redeemed.
The payment stage technically occurs before the commit, however in terms of API interaction the two are often performed by a single action on the client, with the commit being triggered automatically once all payments are confirmed.