Finding Information on an Order

You may want to find information about a specific Order, for example as part of a checkout flow that involves an Order cancellation or refund. By default, an Order object returns only financial and transactional information. Additional Order data can be retrieved using expansions. The first step in finding information about an Order is to identify the ID of the Order of interest. For information on finding an Order ID by Event, refer to Working with an Event's Orders.

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.

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.

Retrieving Information on a single Order

Use the following GET request to retrieve information on an Order

curl -X GET   https://www.eventbriteapi.com/v3/orders/{order_id}/  -H 'Authorization: Bearer PERSONAL_OAUTH_TOKEN'

An 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"
}

Retrieving Information on a list of Orders

There are 3 endpoints to get a list of Orders. The response includes a pagination object and an array of Orders.

An example response

{
    "pagination": {
        "object_count": 6,
        "page_number": 1,
        "page_size": 50,
        "page_count": 1,
        "has_more_items": false
    },
    "orders": [
        ...
        ]
}

List Orders for a specific Event

To get list all Orders in an Event, use the following GET request

curl -X GET   https://www.eventbriteapi.com/v3/events/{event_id}/orders  -H 'Authorization: Bearer PERSONAL_OAUTH_TOKEN'

To filter in the Orders, append parameters listed below in the request url.

Field	Type	Description
`status`	`string`	Filter Event's Order by status. Possible values are `active` (Attending Order), `inactive`(Not attending Order), `both`(All Orders) and `all_not_deleted`(Active and inactive, but not deleted, Orders).
`changed_since`	`datetime`	Orders changed on or after this time.
`only_emails`	`array[string]`	Orders placed by this email address.
`exclude_emails`	`array[string]`	Orders placed by this email address are not included in return.
`refund_request_statuses`	`array[string],`	Only Orders with specified refund request status are included in return. Possible values are `completed`, `pending`, `outside_policy`, `disputed` and `denied`.

List Orders placed by your User

To get list all Orders placed by you, use the following GET request

curl -X GET   https://www.eventbriteapi.com/v3/users/me/orders  -H 'Authorization: Bearer PERSONAL_OAUTH_TOKEN'

To filter in the Orders, append parameters listed below in the request url.

Field	Type	Description
`changed_since`	`datetime`	Order changed on or after this time.
`time_filter`	`string`	Filter the list to only, or all, past or current and future Orders. Possible values are `all`, `past` and `current_future`.

List Orders under Events owned by a specific Organization

To get list all Orders by a specific organization_id, use the following GET request

curl -X GET   https://www.eventbriteapi.com/v3/organizations/{organization_id}/orders  -H 'Authorization: Bearer PERSONAL_OAUTH_TOKEN'

You can only access by Organizations your account is in.

To filter in the Orders, append parameters listed below in the request url.

Field	Type	Description
`status`	`string`	Filter Order by status. Possible values are `active` (Attending Order), `inactive`(Not attending Order), `both`(All Orders) and `all_not_deleted`(Active and inactive, but not deleted, Orders).
`changed_since`	`datetime`	Only return orders changed on or after the time given.
`only_emails`	`array[string]`	Orders placed by this email address.
`exclude_emails`	`array[string]`	Orders placed by this email address are not included in return.

Next steps

These are the next articles to continue with your building

Working with an Event's Orders

Continue

Obtaining Attendee Information

Continue