Orders v2

Returns a list of orders belonging to the box office, in the v2 representation.

get/v2/orders

Request

Query parameters

created_atinteger

Unix timestamp filter that returns items with matched created_at value.

created_at.gtinteger

Unix timestamp filter that returns items with created_at greater than given value.

created_at.gteinteger

Unix timestamp filter that returns items with created_at greater than or equal given value.

created_at.ltinteger

Unix timestamp filter that returns items with created_at less than given value.

created_at.lteinteger

Unix timestamp filter that returns items with created_at less than or equal given value.

starting_afterstring

A paginator cursor value of object id (e.g. "or_123") that defines place in the list. To fetch next page of results, use the last object id from the current result list, e.g. starting_after=or_223.

ending_beforestring

A paginator cursor value of object id (e.g. "or_123") that defines place in the list. To fetch previous page of results, use the first object id from the current result list, e.g. ending_before=or_123.

limitstring

The number of items to retrieve

namestring

The first, last or full name of the buyer

emailstring

The email of the buyer

txn_idstring

The transaction id

barcodestring

The ticket barcode

event_idstring

Comma separated list of event ids

event_series_idstring

Comma separated list of event series ids

status'completed' | 'pending' | 'cancelled'

The order status

store_idstring

The store id prefixed with 'st_'

referral_tagstring

The tag that tracks where sales originated

Response

A successfully returned list of orders

Example response

{
  "data": [
    {
      "object": "order",
      "id": "or_737352",
      "buyer_details": {
        "address": {
          "address_1": "The Queen's Walk",
          "address_2": "Bishop's",
          "address_3": "London",
          "postal_code": "SE1 7PB"
        },
        "custom_questions": [
          {
            "question": "How did you hear about us?",
            "answer": "Instagram"
          }
        ],
        "email": "john@example.com",
        "first_name": "John",
        "last_name": "Doe",
        "name": "John Doe",
        "phone": "07123456789"
      },
      "created_at": "2026-04-16T13:51:31+01:00",
      "currency": {
        "base_multiplier": 100,
        "code": "GBP",
        "symbol": "£"
      },
      "line_items": [
        {
          "object": "line_item",
          "id": "li_1610093",
          "booking_fee": 0,
          "bundle_id": null,
          "description": "General Admission",
          "discount_id": null,
          "event_summary": {
            "end_date": "2026-05-01T22:30:00+01:00",
            "event_id": "ev_40980",
            "event_series_id": "es_50897",
            "name": "Hackney Downs 2026 Tulip Festival",
            "start_date": "2026-05-01T18:00:00+01:00"
          },
          "fulfilment": "issued_ticket",
          "fulfilments": [
            {
              "reference_id": "it_50198",
              "reference_name": "al4R5"
            },
            {
              "reference_id": "it_50199",
              "reference_name": "bX9kQ"
            }
          ],
          "item_id": "tt_246785",
          "list_booking_fee": 0,
          "list_price": 2500,
          "quantity": 2,
          "store_summary": null,
          "tax": {
            "amount": 833,
            "label": "VAT",
            "rate": 20,
            "treatment": "INCLUSIVE"
          },
          "total": 5000,
          "type": "ticket",
          "value": 5000
        },
        {
          "object": "line_item",
          "id": "li_1610094",
          "booking_fee": 0,
          "bundle_id": null,
          "description": "Festival T-shirt",
          "discount_id": null,
          "event_summary": null,
          "fulfilment": "other",
          "fulfilments": [],
          "item_id": "pr_100003",
          "list_booking_fee": 0,
          "list_price": 1500,
          "quantity": 1,
          "store_summary": {
            "name": "Festival merchandise",
            "store_id": "st_1201"
          },
          "tax": {
            "amount": 250,
            "label": "VAT",
            "rate": 20,
            "treatment": "INCLUSIVE"
          },
          "total": 1500,
          "type": "product",
          "value": 1500
        }
      ],
      "marketing_opt_in": true,
      "meta_data": [
        {
          "key": "crm_id",
          "value": "CUST-48213"
        }
      ],
      "notes": null,
      "referral_tag": "website",
      "status": "completed",
      "status_message": null,
      "total": 6500,
      "transactions": [
        {
          "transaction_id": "pi_3PQx2bLkdIwHu7ix0Zz9Y1aB",
          "type": "payment",
          "amount": 3250,
          "currency": "GBP",
          "payment_method": "STRIPE",
          "pending": false,
          "created_at": "2026-04-16T13:51:31+01:00"
        }
      ],
      "payment_plan": {
        "status": "outstanding",
        "currency": "GBP",
        "total": 6500,
        "amount_paid": 3250,
        "amount_outstanding": 3250,
        "instalments": [
          {
            "id": "pi_901",
            "sequence_number": 1,
            "amount": 3250,
            "currency": "GBP",
            "due_date": "2026-04-16",
            "status": "paid",
            "is_deposit": true
          },
          {
            "id": "pi_902",
            "sequence_number": 2,
            "amount": 3250,
            "currency": "GBP",
            "due_date": "2026-04-30",
            "status": "pending",
            "is_deposit": false
          }
        ]
      }
    }
  ],
  "links": {
    "next": "/v2/orders?starting_after=or_120",
    "previous": "/v2/orders?ending_before=or_100"
  }
}

Changes