latestOpenAPI 3.1.12026-08-108026304.2 KB

7b222e8ec91c

Orders

List orders

Returns a list of orders belonging to box office

get/v1/orders

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' | 'canceled'

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": [],
        "email": "john@example.com",
        "first_name": "John",
        "last_name": "Doe",
        "name": "John Doe",
        "phone": "07123456789"
      },
      "created_at": 1587042691,
      "currency": {
        "base_multiplier": 100,
        "code": "gbp"
      },
      "event_summary": {
        "id": "ev_40980",
        "event_id": "ev_40980",
        "event_series_id": "es_50897",
        "end_date": {
          "date": "2020-05-01",
          "formatted": "Fri 1 May 2020 10:30 PM",
          "iso": "2020-05-01T22:30:00+01:00",
          "time": "22:30",
          "timezone": "+01:00",
          "unix": 1588368600
        },
        "name": "Hackney Downs 2020 Tulip Festival",
        "start_date": {
          "date": "2020-05-01",
          "formatted": "Fri 1 May 2020 6:00 PM",
          "iso": "2020-05-01T18:00:00+01:00",
          "time": "18:00",
          "timezone": "+01:00",
          "unix": 1588352400
        },
        "venue": {
          "country": "GB",
          "name": "Royal Albert Hall",
          "postal_code": "SW7 2AP"
        }
      },
      "issued_tickets": [
        {
          "object": "issued_ticket",
          "id": "it_50198",
          "barcode": "al4R5",
          "barcode_url": "https://www.tickettailor.com/userfiles/cache/barcode/qr/attendee/50198/42bf63ef2a055b91a62f",
          "checked_in": "false",
          "created_at": 1587042697,
          "custom_questions": [],
          "description": "Free ticket",
          "email": "john@example.com",
          "event_id": "ev_40980",
          "reference": "my reference code",
          "full_name": null,
          "first_name": null,
          "group_ticket_barcode": null,
          "last_name": null,
          "status": "valid",
          "source": "api",
          "ticket_type_id": "tt_230656",
          "updated_at": 1587042697,
          "voided_at": null,
          "order_id": "or_737352",
          "qr_code_url": "https://www.tickettailor.com/userfiles/cache/barcode/st/attendee/50198/42bf63ef2a055b91a62f"
        },
        {
          "object": "issued_ticket",
          "id": "it_50199",
          "barcode": "dx2Fv",
          "barcode_url": "https://www.tickettailor.com/userfiles/cache/barcode/qr/attendee/50199/633d33a7ff6eba30a565",
          "checked_in": "false",
          "created_at": 1587042697,
          "custom_questions": [],
          "description": "Free ticket",
          "email": "john@example.com",
          "event_id": "ev_40980",
          "reference": "my reference code",
          "full_name": null,
          "first_name": null,
          "group_ticket_barcode": null,
          "last_name": null,
          "status": "valid",
          "source": "api",
          "ticket_type_id": "tt_230656",
          "updated_at": 1587042697,
          "voided_at": null,
          "order_id": "or_737352",
          "qr_code_url": "https://www.tickettailor.com/userfiles/cache/barcode/st/attendee/50199/633d33a7ff6eba30a565"
        }
      ],
      "line_items": [
        {
          "object": "line_item",
          "id": "li_1505167",
          "booking_fee": 0,
          "description": "Free ticket",
          "item_id": "tt_230656",
          "quantity": 2,
          "store_id": null,
          "total": 0,
          "type": "ticket",
          "value": 0
        }
      ],
      "marketing_opt_in": null,
      "meta_data": [],
      "notes": null,
      "payment_method": {
        "external_id": "seller222@example.com",
        "id": "pm_6691",
        "instructions": null,
        "name": null,
        "type": "paypal"
      },
      "referral_tag": "website",
      "refund_amount": 0,
      "refunded_voucher_id": null,
      "status": "completed",
      "status_message": null,
      "subtotal": 0,
      "tax": 0,
      "tax_treatment": "exclusive",
      "total": 0,
      "txn_id": "ABCD1234"
    }
  ],
  "links": {
    "next": "/v1/orders?starting_after=or_120",
    "previous": "/v1/orders?ending_before=or_100"
  }
}