Order Object

Properties
orderNumberstring

Unique order number.

reservationIdstringformat GUID

Reservation ID.

snapshotIdstringRead-onlyformat GUID

Payment snapshot ID. Empty for FREE order.

eventIdstringformat GUID

Event ID.

contactIdstringformat GUID

Contact ID of buyer (resolved using email address).

memberIdstringformat GUID

Member ID of buyer (if relevant).

createdstringRead-onlyformat date-time

RSVP created timestamp.

firstNamestring

Guest first name.

lastNamestring

Guest last name.

emailstringformat EMAIL

Guest email.

checkoutFormobject

Checkout form response. When each purchased ticket is assigned to a guest, guest forms are returned for each ticket, and buyer info is returned.

confirmedboolean

Whether the order is confirmed (triggered once payment gateway processes the payment and funds reach the merchant's account).

statusstring
8 enum supported values:
NA_ORDER_STATUSFREEPENDINGPAIDOFFLINE_PENDINGINITIATEDCANCELEDDECLINED

Order status.

methodstring

Payment method used for purchase, e.g., "payPal", "creditCard", etc.

ticketsQuantityinteger

Tickets ordered.

totalPriceobject

Total order price.

ticketsPdfstring

URL to ticket PDF.

ticketsArray <Ticket>

Tickets (generated after payment).

archivedboolean

Whether the order is archived.

anonymizedboolean

Whether the order is anonymized by GDPR delete.

fullNamestring

Guest full name.

invoiceobject

Order invoice.

fullyCheckedInboolean

Whether all tickets in order are checked-in.

paymentDetailsobject

Internal order payment details

channelstring
2 enum supported values:
ONLINEOFFLINE_POS

Checkout channel type

Was this helpful?
Yes
No