SaleState
Enum
Status of a box office sale.
Typical flow: OPEN → COMMITTED.
If a payment link is created while the sale is open: OPEN → PAYMENT_PENDING → OPEN → COMMITTED.
If an uncommitted sale is canceled: OPEN/OVERDUE → WITHDRAWN.
If a committed sale is canceled: COMMITTED → SaleState.CANCELED.
If the sale expires without being completed: OPEN → OVERDUE.
Enum Values
Deprecated fields are hidden.
| Value | Description |
|---|---|
CANCELED | Sale was canceled after being committed. Triggered by `cancelSale` on a `COMMITTED` sale. Terminal. |
COMMITTED | Sale has been completed. Triggered by `completeSale`. |
OPEN | Initial state. The sale is being prepared and has not been completed yet. Set by `createSale`. |
OVERDUE | The sale expired before being completed. Not triggered by a mutation. Can revert to `OPEN` if the expiration is extended. |
PAYMENT_PENDING | A payment link has been created and is awaiting payment. Once the payment link is paid or canceled (via `cancelPaymentLink`), the state is re-evaluated based on the sale's current data. |
WITHDRAWN | Sale was canceled before being committed. Triggered by `cancelSale` on an uncommitted (`OPEN` or `OVERDUE`) sale. Terminal. |
Used By (2)
SaleState is referenced by the following fields, arguments, and input fields:
Showing 2 of 2.
Deprecated fields are hidden.
| Type | Field |
|---|---|
Sale | state |
SaleFilter | state |