REST API v2. Authenticate with a Bearer JWT in the Authorization header unless an endpoint is marked public.
Servers​
Change Order​
Additive /api/v2/change-order/* API for Upgrade Ticket and Switch Event, built natively on the Box Office v2 cart/checkout stack (not the legacy ShoppingCart hash).
Operations​
Create a change-order/transfer cart for an order​
Creates a change-order cart (upgradeTickets or changeEvent) for an existing order, gated by changeOrdersActive plus upgradesActive/changeEventActive.
Authorizations​
Parameters​
Path Parameters
Original order id.
"int64"Request Body​
Responses​
Change-order cart created.
Change/upgrade a ticket in the change-order cart​
Selects the new ticket type (upgrade) or event ticket type (change-event) for one original ticket in the change-order cart. Computes max(0, newPrice - originalPrice) plus the flat upgradeTicketsFee/changeEventFee.
Authorizations​
Parameters​
Path Parameters
GUID of the original ticket being changed.
Request Body​
Responses​
Ticket changed successfully.
Set attendee info for a change-order cart ticket​
Sets (or clears, when omitted) attendee info for the new ticket mapped to the given original ticket in the change-order cart.
Authorizations​
Parameters​
Path Parameters
GUID of the original ticket.
Request Body​
Responses​
Attendee saved.
Remove a ticket from the change-order cart (undo)​
Removes a staged original ticket from the change-order cart so POST /change can be called again with a different type.
Authorizations​
Parameters​
Path Parameters
GUID of the original ticket.
Request Body​
Responses​
Ticket removed from the cart.
List questions for a change-order cart ticket​
Returns custom questions linked to the new ticket type already selected for this original ticket.
Authorizations​
Parameters​
Path Parameters
GUID of the original ticket.
Query Parameters
The change-order cart guid.
Responses​
Questions for the selected type.
Set answers for a change-order cart ticket​
Replaces custom-question answers for the new ticket mapped to the original ticket guid.
Authorizations​
Parameters​
Path Parameters
GUID of the original ticket.
Request Body​
Responses​
Answers saved.
Override ticket price on a change-order cart item​
Overrides the new ticket list price used in difference math (admin box-office override).
Authorizations​
Parameters​
Path Parameters
GUID of the original ticket.
Request Body​
Responses​
Price override saved.
Override add-on price on a change-order cart item​
Overrides the charged amount for a priced question-answer add-on on a staged ticket.
Authorizations​
Parameters​
Path Parameters
GUID of the original ticket.
system_questionAnswers id of the priced option.
Request Body​
Responses​
Add-on price override saved.
Start payment for a change-order/transfer cart​
Starts the payment process for a change-order/transfer cart. The charge amount is the sum of each item's price/tax/gratuity differences plus the flat change/upgrade fee and priced add-ons (same formula as the cart total). For Square/NMI, send paymentToken after client-side tokenization; without it, credit checkout returns 412 with keys and missing.
Authorizations​
Request Body​
Responses​
Checkout started successfully.
Verify payment and finalize a change-order/transfer cart​
Verifies the payment status for a change-order/transfer cart. On success, finalizes the change order via ChangeOrderFinalizationService: transferState=transferred on the original ticket, upgradeState=upgraded|eventChange on the new ticket, and changeOrderLog/changeOrderTicketLog rows. The client should poll this endpoint after checkout.
Authorizations​
Request Body​
Responses​
Order finalized successfully.
Cancel payment on a change-order/transfer cart​
Cancels an in-progress payment on a change-order/transfer cart and resets it so the operator can modify the cart or retry checkout. Voids an uncaptured Stripe PaymentIntent. A Square/NMI/Digitzs sync charge is already captured — this resets the cart only and does not refund.
Authorizations​
Request Body​
Responses​
Payment cancelled (or cart reset after a captured sync charge). Does not refund Square/NMI/Digitzs.
