Premiere V2 API

Appearance

GET /orders​

GET
/api/v2/orders

Get orders

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Query Parameters

_include

Include related and additional data. Accepted values: order_total, tickets, purchase_questions

Type
string
Example"order_total,tickets,purchase_questions"
order_status

Filter by order status. Accepted values: refunded, partial, checkedIn, purchased, unpaid

Type
string
Example"purchased,checkedIn"
from

Filter orders created from this datetime (format: Y-m-d H:i)

Type
string
Example"2025-11-05 08:19"
to

Filter orders created up to this datetime (format: Y-m-d H:i)

Type
string
Example"2025-11-05 08:25"
event

Filter by a single event ID

Type
integer
Example2
events

Filter by multiple event IDs (comma-separated)

Type
string
Example"1,2"
ticket_type

Filter by ticket type ID

Type
integer
Example3
min_ticket_price_paid

Filter by minimum ticket price paid

Type
number
Example100
Format
"float"
max_ticket_price_paid

Filter by maximum ticket price paid

Type
number
Example200
Format
"float"
payment_methods

Filter by payment methods (comma-separated). Accepted values: cash,credit,sezzle

Type
string
Example"cash,credit"
shipping_methods

Filter by shipping method IDs (comma-separated)

Type
string
Example"1,2"
affiliate

Filter by affiliate ID

Type
integer
Example286
promo_code

Filter by promo code ID

Type
integer
Example2
promo_code_group

Filter by promo code group name

Type
string
Example"ICS Promo Code"
admin_user

Filter by admin user ID

Type
integer
Example1
purchase_from

Filter by purchase source (comma-separated). Accepted values: boxOffice, frontEnd, backEnd, presale

Type
string
Example"boxOffice,frontEnd"
change_status

Filter by change status (comma-separated). Accepted value: transferred,eventChange,upgraded,claimed,unclaimed,withdrawn

Type
string
Example"eventChange,upgraded"
order_id

Filter by specific order ID

Type
integer
Example42962
ticket_barcode

Filter by ticket barcode

Type
string
Example"75387482648539"
wave_time

Filter by wave time IDs (comma-separated)

Type
string
Example"1,2,3"
last_4

Filter by last 4 digits of payment card

Type
string
Example"4242"
new_customer

Filter by new customer flag (false = returning, true = new)

Type
string
Valid values
"false""true"
Example"false"
ticket_status

Filter by ticket status. Accepted values: purchased, checkedIn, cancelled, refunded

Type
string
Example"purchased,checkedIn"
purchase_with_pass

Filter orders purchased with a pass (true = yes)

Type
string
Valid values
"false""true"
Example"true"
deleted

Include deleted orders (true = include deleted)

Type
string
Valid values
"false""true"
Example"true"
all_and_delete

Include all orders including deleted (true = yes)

Type
string
Valid values
"false""true"
Example"true"

Responses​

Order list

application/json
JSON
{
  
"count": 10,
  
"totalCount": 25,
  
"limit": 50,
  
"offset": 25,
  
"data": [
  
]
}

Playground​

Authorization
Variables
Key
Value

Samples​

Get order​

GET
/api/v2/orders/{id}

Get order by Id

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

id*

Order Id

Type
integer
Required
Format
"int64"

Query Parameters

_include

Include additional data. Accepted values: order_addons

Type
string
Example"order_addons"

Responses​

Order object

application/json
JSON
{
  
"data": "string"
}

Playground​

Authorization
Variables
Key
Value

Samples​

Update order​

PATCH
/api/v2/orders/{id}

Update order by Id

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

id*

Orders Id

Type
integer
Required
Format
"int64"

Request Body​

application/json
JSON
{
  
"data": {
  
  
"shippingMethod": 2,
  
  
"affiliate": 286,
  
  
"customer": {
  
  
  
"id": 5,
  
  
  
"newCustomer": true
  
  
},
  
  
"purchaser": {
  
  
  
"firstName": "John",
  
  
  
"lastName": "Doe",
  
  
  
"email": "john@example.com",
  
  
  
"phone": "+112345678000"
  
  
},
  
  
"orderNote": "Note order canceled by admin",
  
  
"purchaseQuestions": [
  
  
  
{
  
  
  
  
"questionId": 1166,
  
  
  
  
"answerId": 414,
  
  
  
  
"answerText": "M ($10.00)",
  
  
  
  
"dynamicQuantity": 0,
  
  
  
  
"displayText": "M ($10.00)",
  
  
  
  
"sku": "123"
  
  
  
}
  
  
],
  
  
"shipping": {
  
  
  
"address": "Address shipping",
  
  
  
"address2": "Address 2 shipping",
  
  
  
"city": "City shipping",
  
  
  
"state": "State shipping",
  
  
  
"country": "Country shipping",
  
  
  
"zip": "Zip shipping"
  
  
},
  
  
"billing": {
  
  
  
"firstName": "Jane billing",
  
  
  
"lastName": "Doe billing",
  
  
  
"address": "Address billing",
  
  
  
"address2": "Address 2 billing",
  
  
  
"city": "City billing",
  
  
  
"state": "State billing",
  
  
  
"country": "Country billing",
  
  
  
"zip": "Zip billing",
  
  
  
"phone": "0622875986 billing"
  
  
}
  
}
}

Responses​

Updated orders object

application/json
JSON
{
  
"data": "string"
}

Playground​

Authorization
Variables
Key
Value
Body

Samples​

Refund order​

POST
/api/v2/orders/{id}/refund

Process a refund for an order. Use GET /orders/{id} to retrieve refundable item details.

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

id*

Order Id

Type
integer
Required
Format
"int64"

Request Body​

application/json
JSON
"string"

Responses​

Refund processed successfully

Playground​

Authorization
Variables
Key
Value
Body

Samples​

Resend order email receipt​

POST
/api/v2/orders/{id}/resend-email

Resend the order receipt via email. Optionally send to all attendees.

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

id*

Order Id

Type
integer
Required
Format
"int64"

Request Body​

application/json
JSON
"string"

Responses​

Email receipt sent successfully

Playground​

Authorization
Variables
Key
Value
Body

Samples​

Export orders as CSV​

GET
/api/v2/orders/export/orders

Downloads a CSV file containing order summaries matching the given filters.

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Query Parameters

event

Filter by event ID. Supports comma-separated multiple values.

Type
integer
ticketType

Filter by ticket type ID. Supports comma-separated multiple values.

Type
integer
promoCode

Filter by promo code ID. Supports comma-separated multiple values.

Type
integer
affiliate

Filter by affiliate ID. Supports comma-separated multiple values.

Type
integer
paymentMethod

Filter by payment method.

Type
string
purchaseLocation

Filter by purchase location. Supports comma-separated multiple values.

Type
string
orderStatus

Filter by order status (active, cancelled, refunded, partialCancelled, partialRefunded).

Type
string
ticketStatus

Filter by ticket status (purchased, checkedIn, cancelled, refunded).

Type
string
fromPurchaseDate

Earliest purchase date (inclusive).

Type
string
toPurchaseDate

Latest purchase date (inclusive).

Type
string
fromTicketPrice
Type
number
toTicketPrice
Type
number

Responses​

CSV file download with order summary rows.

text/csv
JSON
"string"

Playground​

Authorization
Variables
Key
Value

Samples​

Export tickets as CSV​

GET
/api/v2/orders/export/tickets

Downloads a CSV file containing one row per ticket with attendee and cost details matching the given filters.

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Query Parameters

event

Filter by event ID. Supports comma-separated multiple values.

Type
integer
ticketType

Filter by ticket type ID. Supports comma-separated multiple values.

Type
integer
waveTime

Filter by wave time ID. Supports comma-separated multiple values.

Type
integer
promoCode

Filter by promo code ID. Supports comma-separated multiple values.

Type
integer
affiliate

Filter by affiliate ID. Supports comma-separated multiple values.

Type
integer
paymentMethod
Type
string
orderStatus
Type
string
ticketStatus
Type
string
bibNumber

Filter by bib number. Supports comma-separated multiple values.

Type
string
fromPurchaseDate
Type
string
toPurchaseDate
Type
string

Responses​

CSV file download with one row per ticket.

text/csv
JSON
"string"

Playground​

Authorization
Variables
Key
Value

Samples​

Export purchasers as CSV​

GET
/api/v2/orders/export/purchasers

Downloads a CSV file containing purchaser name, email, and order ID for each matching order.

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Query Parameters

event
Type
integer
ticketType
Type
integer
orderStatus
Type
string
ticketStatus
Type
string
fromPurchaseDate
Type
string
toPurchaseDate
Type
string

Responses​

CSV file download with purchaser rows.

text/csv
JSON
"string"

Playground​

Authorization
Variables
Key
Value

Samples​

Export attendees as CSV​

GET
/api/v2/orders/export/attendees

Downloads a CSV file containing attendee name, email, and order ID for each ticket in matching orders.

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Query Parameters

event
Type
integer
ticketType
Type
integer
orderStatus
Type
string
ticketStatus
Type
string
fromPurchaseDate
Type
string
toPurchaseDate
Type
string

Responses​

CSV file download with one row per attendee.

text/csv
JSON
"string"

Playground​

Authorization
Variables
Key
Value

Samples​

Export shipping details as CSV​

GET
/api/v2/orders/export/shipping

Downloads a CSV file containing shipping address information for each ticket in matching orders.

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Query Parameters

event
Type
integer
ticketType
Type
integer
shippingMethod

Filter by shipping method ID.

Type
integer
orderStatus
Type
string
ticketStatus
Type
string
fromPurchaseDate
Type
string
toPurchaseDate
Type
string

Responses​

CSV file download with shipping address rows.

text/csv
JSON
"string"

Playground​

Authorization
Variables
Key
Value

Samples​

Returns a single order​

GET
/api/v2/order/{id}

Returns a single order

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

id*

The id of the order

Type
string
Required

Query Parameters

includeTickets

Set to true to include the ticket details.

Type
boolean
includeAnswers

Include any answer's for both the orders and tickets.

Type
boolean
includeCosts

Include costs as part of the order.

Type
boolean

Responses​

The order was found.

application/json
JSON
{
  
"id": "string",
  
"created": "string",
  
"purchasedDate": "string",
  
"status": "string",
  
"emailAddress": "string",
  
"total": 0,
  
"purchaser": "string",
  
"affiliate": "string",
  
"paymentMethod": "string",
  
"lastFour": "string",
  
"tickets": [
  
  
{
  
  
  
"id": "string",
  
  
  
"status": "active",
  
  
  
"price": 0,
  
  
  
"attendee": 0,
  
  
  
"name": "string",
  
  
  
"attendeeAddress": "string",
  
  
  
"answers": [
  
  
  
  
{
  
  
  
  
  
"question": "string",
  
  
  
  
  
"answer": "string"
  
  
  
  
}
  
  
  
]
  
  
}
  
],
  
"transactions": [
  
  
{
  
  
  
"timestamp": "string",
  
  
  
"type": "string",
  
  
  
"amount": 0
  
  
}
  
],
  
"answers": [
  
]
}

Playground​

Authorization
Variables
Key
Value

Samples​

Retrieves a list of orders.​

GET
/api/v2/order

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​

bearerAuth
Type
HTTP (bearer)

Parameters​

Query Parameters

_limit

Set the max number of objects to return.

Type
number
Format
"integer"
_offset

Set the number of objects to ignore before starting.

Type
number
Format
"integer"
search

Searchs purchaser's first name, last name, email address as well as the ticket's barcode and order #.

Type
string
emailAddress

The email address of the purchaser.

Type
string
purchaseLocation

The location the order was purchased. Supports multiple values seperated by a comma.

Type
string
eventSummary

The id of the event tickets where purchased for. Supports multiple values seperated by a comma.

Type
integer
ticketType

The id of the ticket types that where purchased. Supports multiple values seperated by a comma.

Type
integer
adminUser

The id of the user who sold the ticket. Supports multiple values seperated by a comma.

Type
integer
event

The id of the event tickets where purchased for. Supports multiple values seperated by a comma.

Type
integer
waveTime

The id of the wave time purchase. Supports multiple values seperated by a comma.

Type
integer
creditCardNumber

The last four of the CC used to pay for the order. Supports multiple values seperated by a comma.

Type
string
bibNumber

Only include orders with a ticket that matches the bib number. Supports multiple values seperated by a comma.

Type
string
paymentMethod

The payment method used to purchase the order.

Type
string
promoCode

The id's of the promo code that was applied to the order. Supports multiple values seperated by a comma.

Type
integer
promoCodeGroup

The names's of the promo code group that was applied to the order. Supports multiple values seperated by a comma.

Type
string
orderStatus

Filter by the order's status. Acceptable values are active, cancelled, refunded, paritalCancelled, or partialRefunded.

Type
string
changeStatus

Filter by the order change status. Acceptable values are transferred, upgraded, claimed, unclaimed, withdrawn, or eventChange.

Type
string
ticketStatus

Filter by the ticket's status. Acceptable values are purchased, checkedIn, cancelled, or refunded.

Type
string
affiliate

The id of affilate associated with the order. Supports multiple values seperated by a comma.

Type
integer
shippingMethod

Filter by the shipping method id.

Type
number
purchasedWithPass

Pass true to limit search for to orders that were purchased with a pass.

Type
bool
refundProtect

Filters based on if refund proctected was purchased and type. Supports the following values opted-in, opted-out, meetch, or refundProtect.

Type
boolean
fromPurchaseDate

The earliest date the order was purchased.

Type
string
toPurchaseDate

The latest date the order was purchased.

Type
string
fromLastUpdate

The earliest date the order was updated.

Type
string
toLastUpdate

The latest date the order was updated.

Type
string
fromTicketPrice

The lowest listed price for a ticket when purchased.

Type
number
toTicketPrice

The highest lised price for a ticket when purchased.

Type
number
fromCurrentTicketPrice

The lowest price currently paid for a ticket.

Type
number
toCurrentTicketPrice

The highest price currently paid for a ticket.

Type
number
fromTicketPricePaid

The lowest price originally paid for a ticket.

Type
number
toTicketPricePaid

The highest price originally paid for a ticket.

Type
number
return

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.
Type
string
_include

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.
Type
string

Responses​

A list of matching orders.

Playground​

Authorization
Variables
Key
Value

Samples​

Creates an order once payment has been verified.​

POST
/api/v2/order

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​

bearerAuth
Type
HTTP (bearer)

Request Body​

application/json
JSON
{
  
"order": "string"
}

Responses​

The order was created after payment was successfully. The order is only included if result is order.

application/json
JSON
{
  
"id": "string",
  
"order": "string"
}

Playground​

Authorization
Body

Samples​

Scan all tickets in an order.​

POST
/api/v2/order/{id}/scan

Scans all tickets in an order.

Authorizations​

bearerAuth
Type
HTTP (bearer)

Parameters​

Path Parameters

id*

The id of the order.

Type
string
Required

Request Body​

application/json
JSON
{
  
"tickets": [
  
  
{
  
  
  
"ticketId": "string",
  
  
  
"bibNumber": "string",
  
  
  
"chipNumber": "string"
  
  
}
  
]
}

Responses​

The order was successfully scanned.

Playground​

Authorization
Variables
Key
Value
Body

Samples​

Process the cart data to describe what order would be created with it​

POST
/api/v2/order/describe

Process the cart data to describe what order would be created with it

Authorizations​

bearerAuth
Type
HTTP (bearer)

Request Body​

application/json
JSON
"string"

Responses​

Playground​

Authorization
Body

Samples​

Complete a staged order and run the after order processes​

POST
/api/v2/order/complete

Complete a staged order and run the after order processes

Authorizations​

bearerAuth
Type
HTTP (bearer)

Request Body​

application/json
JSON
{
  
"orderId": 0,
  
"orderGuid": 0
}

Responses​

Playground​

Authorization
Body

Samples​

Powered by VitePress OpenAPI