REST API v2. Authenticate with a Bearer JWT in the Authorization header unless an endpoint is marked public.
Servers​
Orders​
Manages orders
Operations​
GET /orders​
Get orders
Authorizations​
Parameters​
Query Parameters
Field to sort by. Default id is system_orders.id (ASC). created is system_orders.created. ticket_id sorts by MAX(system_tickets.id) per order for V1 Order Manager list parity.
"ticket_id""id""created""id""id"Include related and additional data. Accepted values: order_total, tickets, purchase_questions, affiliate, promoCodes, purchaseProtected
"order_total,tickets,purchase_questions,affiliate,promoCodes,purchaseProtected"Filter by order status. Accepted values: refunded, partial, checkedIn, purchased, unpaid
"purchased,checkedIn"Filter orders created from this datetime (format: Y-m-d H:i)
"2025-11-05 08:19"Filter orders created up to this datetime (format: Y-m-d H:i)
"2025-11-05 08:25"Filter by a single event ID
2Filter by multiple event IDs (comma-separated)
"1,2"Filter by ticket type IDs (comma-separated)
"3,4"Filter by minimum ticket price paid
100"float"Filter by maximum ticket price paid
200"float"Filter by payment methods (comma-separated). Accepted values: cash,credit,sezzle
"cash,credit"Filter by shipping method IDs (comma-separated)
"1,2"Filter by affiliate ID(s) (comma-separated). Ignored when the affiliate filter is locked to the current admin.
"286,287"Filter by promo code ID(s) (comma-separated)
"2,3"Filter by promo code group name(s) (comma-separated)
"ICS Promo Code,Summer Sale"Filter by admin user ID(s) (comma-separated)
"1,2"Filter by purchase source (comma-separated). Accepted values: boxOffice, boxOfficeV2, frontEnd, backEnd, presale. Selecting boxOffice also matches boxOfficeV2.
"boxOffice,frontEnd"Filter by change status (comma-separated). Accepted value: transferred,eventChange,upgraded,claimed,unclaimed,withdrawn
"eventChange,upgraded"Filter by specific order ID
42962Filter by ticket barcode
"75387482648539"Filter by wave time IDs (comma-separated)
"1,2,3"Filter by last 4 digits of payment card
"4242"Filter by new customer flag (false = returning, true = new)
"false""true""false"Filter by ticket status. Accepted values: purchased, checkedIn, cancelled, refunded
"purchased,checkedIn"Filter orders purchased with a pass (true = yes)
"false""true""true"Hide orders that are currently worth nothing (true = hide). An order with free tickets is still returned while it carries a paid add-on or an upgrade made after checkout.
"false""true""true"Filter by ticket purchaseDate >= value (unix timestamp or Y-m-d H:i)
"1717200000"Filter by ticket purchaseDate < value (exclusive upper bound; unix timestamp or Y-m-d H:i). Matches V1 / export OrderQuery.
"1717286400"Minimum original ticket price
10"float"Maximum original ticket price
100"float"Minimum current ticket price
10"float"Maximum current ticket price
100"float"Filter by bib number (comma-separated)
"1001,1002"Filter by purchase protection: opted-in, opted-out, or vendor slug
"opted-in"Filter by event manager admin ID (resolves their event limits)
12Filter by ticket lastUpdate >= value (unix timestamp or Y-m-d H:i)
"1717200000"Filter by ticket lastUpdate < value (exclusive upper bound; unix timestamp or Y-m-d H:i). Matches V1 / export OrderQuery.
"1717286400"Include deleted tickets only (TS users only)
"false""true""true"Include all tickets including deleted (TS users only)
"false""true""true"Responses​
Order list
Get order​
Get order by Id
Authorizations​
Parameters​
Path Parameters
Order Id
"int64"Query Parameters
Include additional data. Accepted values: order_addons
"order_addons"Responses​
Order object
Update order​
Update order by Id
Authorizations​
Parameters​
Path Parameters
Orders Id
"int64"Request Body​
Responses​
Updated orders object
Get refundable order payload​
Refundable line items and max amounts for the refund UI (V1 getRefundableOrder parity).
Authorizations​
Parameters​
Path Parameters
Order Id
"int64"Responses​
Refundable order payload
List change orders for an order​
Change-order audit log for an order (v1 Order Manager Change Orders / Change Log parity).
Authorizations​
Parameters​
Path Parameters
Order Id
"int64"Query Parameters
Optional. Default includes ticket-level details. Pass without_tickets to omit tickets[].
"without_tickets"Responses​
Change-order log entries
Get order audit timeline​
Unified chronological audit timeline for an order (notes, change orders, refunds).
Authorizations​
Parameters​
Path Parameters
Order Id
"int64"Query Parameters
Comma-separated entry types to include: note, change_order, refund. Default: all.
"note,change_order,refund"Responses​
Timeline entries newest first
Refund order​
Process a refund for an order. Use GET /orders/{id}/refundable for max refundable amounts.
Authorizations​
Parameters​
Path Parameters
Order Id
"int64"Request Body​
Responses​
Refund processed successfully
Resend order email receipt​
Resend the order receipt via email. Optionally send to all attendees.
Authorizations​
Parameters​
Path Parameters
Order Id
"int64"Request Body​
Responses​
Email receipt sent successfully
Transfer order tickets​
Transfer one or more tickets on an order (event/type change or attendee info). Writes change-order audit logs matching V1 Order Manager.
Authorizations​
Parameters​
Path Parameters
Order Id
"int64"Request Body​
Responses​
Tickets transferred
Export orders as CSV​
Downloads a CSV file containing order summaries matching the given filters.
Authorizations​
Parameters​
Query Parameters
Filter by event ID. Supports comma-separated multiple values.
Filter by ticket type ID. Supports comma-separated multiple values.
Filter by promo code ID. Supports comma-separated multiple values.
Filter by affiliate ID. Supports comma-separated multiple values.
Filter by payment method.
Filter by purchase location. Supports comma-separated multiple values.
Filter by order status (active, cancelled, refunded, partialCancelled, partialRefunded).
Filter by ticket status (purchased, checkedIn, cancelled, refunded).
Earliest purchase date (inclusive).
Latest purchase date (exclusive upper bound: purchaseDate < to).
Responses​
CSV file download with order summary rows.
Export tickets as CSV​
Downloads a CSV file containing one row per ticket with attendee and cost details matching the given filters.
Authorizations​
Parameters​
Query Parameters
Filter by event ID. Supports comma-separated multiple values.
Filter by ticket type ID. Supports comma-separated multiple values.
Filter by wave time ID. Supports comma-separated multiple values.
Filter by promo code ID. Supports comma-separated multiple values.
Filter by affiliate ID. Supports comma-separated multiple values.
Filter by bib number. Supports comma-separated multiple values.
Responses​
CSV file download with one row per ticket.
Export purchasers as CSV​
Downloads a CSV file containing purchaser name, email, and order ID for each matching order.
Authorizations​
Parameters​
Query Parameters
Responses​
CSV file download with purchaser rows.
Export attendees as CSV​
Downloads a CSV file containing attendee name, email, and order ID for each ticket in matching orders.
Authorizations​
Parameters​
Query Parameters
Responses​
CSV file download with one row per attendee.
Export shipping details as CSV​
Downloads a CSV file containing shipping address information for each ticket in matching orders.
Authorizations​
Parameters​
Query Parameters
Filter by shipping method ID.
Responses​
CSV file download with shipping address rows.
Returns a single order​
Returns a single order
Authorizations​
Parameters​
Path Parameters
The id of the order
Query Parameters
Set to true to include the ticket details.
Include any answer's for both the orders and tickets.
Include costs as part of the order.
Responses​
The order was found.
Retrieves a list of orders.​
Returns a list of order summaries. Note that filters apply to the orders, not the ticket. If you filter by an event and order has tickets for the filtered event and another both tickets will be returned.
Authorizations​
Parameters​
Query Parameters
Set the max number of objects to return.
"integer"Set the number of objects to ignore before starting.
"integer"Searchs purchaser's first name, last name, email address as well as the ticket's barcode and order #.
The location the order was purchased. Supports multiple values seperated by a comma.
The id of the ticket types that where purchased. Supports multiple values seperated by a comma.
The id of the user who sold the ticket. Supports multiple values seperated by a comma.
The id of the event tickets where purchased for. Supports multiple values seperated by a comma.
The id of the wave time purchase. Supports multiple values seperated by a comma.
The last four of the CC used to pay for the order. Supports multiple values seperated by a comma.
Only include orders with a ticket that matches the bib number. Supports multiple values seperated by a comma.
The payment method used to purchase the order.
The id's of the promo code that was applied to the order. Supports multiple values seperated by a comma.
The names's of the promo code group that was applied to the order. Supports multiple values seperated by a comma.
Filter by the order's status. Acceptable values are active, cancelled, refunded, paritalCancelled, or partialRefunded.
Filter by the order change status. Acceptable values are transferred, upgraded, claimed, unclaimed, withdrawn, or eventChange.
Filter by the ticket's status. Acceptable values are purchased, checkedIn, cancelled, or refunded.
The id of affilate associated with the order. Supports multiple values seperated by a comma.
Filter by the shipping method id.
Pass true to limit search for to orders that were purchased with a pass.
Pass true to hide orders that are currently worth nothing. An order with free tickets is still returned while it carries a paid add-on or an upgrade made after checkout.
Filter by whether the purchaser was a new customer (1) or a returning customer (0) at the time of order creation.
"0""1"Filters based on if purchase protection was purchased. Supports opted-in, opted-out, or a vendor slug.
The earliest date the order was purchased (unix timestamp).
The latest date the order was purchased (unix timestamp).
The earliest ticket lastUpdate (unix timestamp).
The latest ticket lastUpdate (unix timestamp).
The lowest listed price for a ticket when purchased.
The highest lised price for a ticket when purchased.
The lowest price currently paid for a ticket.
The highest price currently paid for a ticket.
The lowest price originally paid for a ticket.
The highest price originally paid for a ticket.
Select the format of the returned data. If the parameter is not provided the default format is standard. Can be one of the following:
- attendees - A csv containing the list of matching attendees.
- purchasers - A csv containing the list of matching purchasers.
- tickets - A csv containing the list of matching tickets.
- orders - A csv contain the list of matching orders.
- shipping - A csv contain shipping information for the matching orders.
- standard - Json contain the selected data.
Adds additional details to the results. Ignored if format is any other then standard. Multiple options can be include seperated by a comma. Supports the following values:
- answers - Include answers to questions.
- tickets - Include ticket information.
- promoCodes - Include promo codes used.
- hash - Include order hash.
- costs - Include cost information.
- purchaseProtected - Include purchase protect information.
- allTicketsForOrder - Include all tickets for order ignoring fileters.
- ticketCount - Include the number of tickets per order.
- change - Include orders id of new/old orders.
- promoter - Include the ticket's promoter.
- waveTime - Include the wave time id (if any).
- waivers - Includes signed waivers attached to the ticket (if any).
- user - Include user information.
Responses​
A list of matching orders.
Creates an order once payment has been verified.​
Creates an order based on the cart created via the shopping cart end points. The order is only created after payment has been verified.
Authorizations​
Request Body​
Responses​
The order was created after payment was successfully. The order is only included if result is order.
Scan all tickets in an order.​
Scans all tickets in an order.
Authorizations​
Parameters​
Path Parameters
The id of the order.
Request Body​
Responses​
The order was successfully scanned.