Working with an Event's Orders
An Order is placed in Eventbrite for one or more Ticket Classes. This means that a single Order can be made up of multiple tickets. By default, an Order object returns only financial and transactional information. Additional Order data can be retrieved using expansions.
Order objects are considered private, meaning that all Order information is only available to the Order Owner and a User who is a member of an Organization to which the Event and it's associated Order belongs.
The first step in working with an Event's Orders is to identify the ID of the Event associated with the Order of interest. For information on finding an Event ID, refer to Getting Information on an Event.
Authenticating Your Access to the Eventbrite API
To work with Orders, you must authenticate your access to the Eventbrite API. To learn how, refer to Authenticating Your Access page.
Listing an Event's Orders
You can get a list of all an Event's Orders by using the following request
curl -X GET https://www.eventbriteapi.com/v3/events/{event_id}/orders/ -H 'Authorization: Bearer PERSONAL_OAUTH_TOKEN' Example response:
{
"costs": {
"base_price": {
"display": "CA$0.00",
"currency": "CAD",
"value": 0,
"major_value": "0.00"
},
"eventbrite_fee": {
"display": "CA$0.00",
"currency": "CAD",
"value": 0,
"major_value": "0.00"
},
"gross": {
"display": "CA$0.00",
"currency": "CAD",
"value": 0,
"major_value": "0.00"
},
"payment_fee": {
"display": "CA$0.00",
"currency": "CAD",
"value": 0,
"major_value": "0.00"
},
"tax": {
"display": "CA$0.00",
"currency": "CAD",
"value": 0,
"major_value": "0.00"
}
},
"resource_uri": "https://www.eventbriteapi.com/v3/orders/12345/",
"id": "12345",
"changed": "2018-11-02T19:07:24Z",
"created": "2018-11-02T19:07:24Z",
"name": "Kennedy Singleton",
"first_name": "Kennedy",
"last_name": "Singleton",
"email": "kennedy@gmail.com",
"status": "placed",
"time_remaining": null,
"event_id": "123456"
}
Narrowing Order Search Returns for an Event
You can narrow the return of Orders for an Event by using the appropriate parameter, appended to the end of the Get request URL.
| Parameter | Type | Description |
|---|---|---|
status | string | Possible values are: active - Order has Attendees, inactive - Order does not have Attendees, both - Active, inactive and deleted Orders, or all_not_deleted - Active and inactive, but not deleted, Orders |
changed_since | datetime | Orders changed on or after this time. Date time format is YYYY-MM-DDThh:mm:ssZ |
last_item_seen | string | Orders changed on or after this time, and with an ID larger than last item seen. |
only_emails | array[string] | Orders placed only by this email address. |
exclude_emails | array[string] | Do not include Orders placed by this email address in the return. |
refund_request_statuses | array[string] | Include only Orders with the specified refund request status in the return. Possible values are completed,pending,outside_policy,disputed or denied. |
For example, to obtain a list of an Event's Orders changed after the date 2018-01-01T00:00:01z, you use the following request
curl -X GET https://www.eventbriteapi.com/v3/events/{event_id}/orders?changed_since=2019-01-01T00:00:01z -H 'Authorization: Bearer PERSONAL_OAUTH_TOKEN' Getting Information on Order Attendees for an Event
Use the expansion expand=attendees to get detail information on the Attendees
associated with an Order, by appending the expansion to the end of the following
request
curl -X GET https://www.eventbriteapi.com/v3/events/EVENT_ID/orders/expand=attendees -H 'Authorization: Bearer PERSONAL_OAUTH_TOKEN' The result is an array of Attendee objects attached in the Order object, as shown in this example
{
...
"attendees": [
{
"team": null,
"costs": {
"base_price": {
"display": "CA$0.00",
"currency": "CAD",
"value": 0,
"major_value": "0.00"
},
"eventbrite_fee": {
"display": "CA$0.00",
"currency": "CAD",
"value": 0,
"major_value": "0.00"
},
"gross": {
"display": "CA$0.00",
"currency": "CAD",
"value": 0,
"major_value": "0.00"
},
"payment_fee": {
"display": "CA$0.00",
"currency": "CAD",
"value": 0,
"major_value": "0.00"
},
"tax": {
"display": "CA$0.00",
"currency": "CAD",
"value": 0,
"major_value": "0.00"
}
},
"resource_uri": "https://www.eventbriteapi.com/v3/events/12345/attendees/12345/",
"id": "12345",
"changed": "2018-11-02T22:36:48Z",
"created": "2018-11-02T19:07:24Z",
"quantity": 1,
"variant_id": null,
"profile": {
"first_name": "Kennedy",
"last_name": "Singleton",
"email": "kennedy@gmail.com",
"name": "Kennedy Singleton",
"addresses": {
"home": {},
"ship": {},
"work": {},
"bill": {},
"fulfillment": {}
}
},
"barcodes": [
{
"status": "used",
"barcode": "1234567435234",
"created": "2018-11-02T19:07:24Z",
"changed": "2018-11-02T22:36:48Z",
"checkin_type": 0,
"checkin_method": "search",
"is_printed": false
}
],
"answers": [
],
"checked_in": true,
"cancelled": false,
"refunded": false,
"affiliate": null,
"guestlist_id": null,
"invited_by": null,
"status": "Checked In",
"ticket_class_name": "General Admission",
"delivery_method": "electronic",
"event_id": "12345",
"order_id": "123123123",
"ticket_class_id": "123123123"
},
]
...
}