Get Orders Endpoint

The get orders endpoint will allow resellers to retrieve all order information for their exchange.

Endpoint URL

https://api.tixstock.com/v1/order/get

Authorisation

Authorisation	Description
Bearer Token	A valid bearer token must be provided within the header parameters for the API request. To generate an access token, please see your API settings from within the Tixstock Reseller Admin Area.

Please see 'Authentication - Bearer Tokens' for further information

Request Data

The supplied data must adhere to the following ruleset and passed as query parameters:

Query Parameters	Description
order_id	The ID of the order. Type: String
event_id	The ID of the event linked to the order. Type: String
broker_id	The ID of the broker the orders belongs to. Type: String
from	A date to start filtering the orders from. Type: Date in ISO-8601 UTC Format Example: 2020-03-10T17:30:00-0400
to	A date to finish the filtering of the orders. Type: Date in ISO-8601 UTC Format Example: 2020-03-10T17:30:00-0400
ticket_type	The reseller can pass through the ticket type to filter the orders Must match the supported ticket types in Tixstock. Paper, eTicket, Members / Season Card
status	The ID of the order status Type: String
order_by	Accepted Values: * id * date * event_id * event_date
sort_order	Accepted Values: asc / desc Type: String
per_page	Max: 50 Type: Integer
page	Type: Integer

API Response:

Please note the example shown below consists of dummy data for illustration purposes only

{
  "data": [
    {
      "id": "234234324",
      "date": "2020-04-05T21:30:00+0000",
      "customer": {
        "id": "123",
        "first_name": "Walter",
        "last_name": "Smith",
        "email_address": "walter.smith@example.com",
        "dob": "1993-06-24",
        "national_id": "NI23221245",
        "contact_number": "+441234567890",
        "billing_address": {
          "address_line_1": "1st Floor 49 Peter Street",
          "address_line_2": "",
          "town": "Manchester",
          "county": "Greater Manchester",
          "postcode": "M2 3NG",
          "country_code": "GB"
        },
        "shipping_address": {
          "address_line_1": "1st Floor 49 Peter Street",
          "address_line_2": "",
          "town": "Manchester",
          "county": "Greater Manchester",
          "postcode": "M2 3NG",
          "country_code": "GB"
        }
      },
      "items": [
        {
          "listing_id": "9211231",
          "general_admission": "true",
          "type": "Paper",
          "section": "",
          "row": "",
          "file": [],
          "customer": {
            "first_name": "Walter",
            "last_name": "Smith",
            "email_address": "",
            "dob": "1993-06-24",
            "national_id": "NI23221245",
            "contact_number": "+441234567890",
            "address":"49 Peter Street, Manchester",
            "nationality": "British",
            "birth_place": "Manchester",
            "birth_country": "United Kingdom"
          }
        }
      ],
      "quantity": 1,
      "currency": "GBP",
      "sub_total": "90.00",
      "grand_total": "90.00",
      "status": "Pending Review",
      "shipping_tracking_id": null,
      "shipping_label": "",
      "notes": [
        {
          "note":"Sample note 1",
          "date":"30-03-2023 11:15:18"
        },
        {
          "isUser":"true",
          "date":"30-03-2023 10:48:34",
          "note":"Sample note 2"
        }
      ]
    }
  ],
  "meta": {
    "mode": "Production",
    "type": "orders.get",
    "current_page": 1,
    "from": 1,
    "path": "https://api.tixstock.com/v1/orders/get",
    "per_page": 10,
    "to": 1,
    "request_id": "01eg13cw13473tagfvrxscpmbd"
  },
  "links": {
    "self": "link-value",
    "first": "https://api.tixstock.com/v1/orders/get?page=1",
    "last": null,
    "prev": null,
    "next": null
  }
}