Our APIs?

General Information

Our API is served over HTTPS from a common sub-domain (tixuk.io), on the following endpoints:

Service	Endpoint	Information
Content	https://content-service.tixuk.io/api/vLatest	Show information and copy
Inventory	https://inventory-service.tixuk.io/api/vLatest	Inventory description and price
Payments	https://payment-service.tixuk.io/api/vLatest	Taking payment
Checkout	https://checkout-service.tixuk.io/api/vLatest	Sending customer details and receiving barcodes

Authentication

Most of our endpoints are public and don't require authentication (and authorization) - given they share data that exists in the public domain. Authentication is only required for sensitive endpoints which change state (i.e. create, delete or modify data). Any endpoints that require authentication (and authorization) are indicated as such in the API reference documentation.

Each API call requires standard headers affiliateId or x-tt-retailer which will allow you to access responses tailored to you. Talk to your account manager or follow the contact-us link to request this id.

API semantics

All of our APIs conform to the REST architectural style and all responses are sent back to you in JSON, a lightweight data interchange format. Responses are returned in two kinds of structure: item and list.

Items

Items are JSON objects consisting of unordered attributes–value pairs, with at least a top-level of pairs (some can contain nested objects). Curly brackets delimit them. This kind of response is used when a single object is requested. The properties are the requested field names and their corresponding values.

{
    id: 1587,
    name: "Wicked",
    type: "show",
    venue: {
        id: 138
    },
    onSale: "yes",
    bookingStarts: "2018-08-07T00:00:00+0000",
    bookingEnds: "2019-05-25T00:00:00+0000"
}

Lists

The list response type is a JSON object containing a list property. The associated value is a JSON array of items. Some other properties should be returned, like other APIs, but we've not developed this.

{
    "results": [
        {
            id: 1587,
            name: "Wicked",
            type: "show",
            venue: {
                id: 138
            },
            onSale: "yes",
            bookingStarts: "2018-08-07T00:00:00+0000",
            bookingEnds: "2019-05-25T00:00:00+0000"
        },
        {
            id: 1587,
            name: "Wicked",
            type: "show",
            venue: {
                id: 138
            },
            onSale: "yes",
            bookingStarts: "2018-08-07T00:00:00+0000",
            bookingEnds: "2019-05-25T00:00:00+0000"
        }]
}

Pagination

Many of our APIs allow paging through list endpoints in a standard way. Each endpoint support for paging is outlined in the relevant API reference as you work through it. Here's a summary below.

Property	Type	Description
x-total-count	Header	If you wish to have the total record set size returned, call the endpoint with the header x-total-count, and the endpoint will respond with the header x-total-count populated with the total record set size. Example: `curl -X GET "https://inventory-service.tixuk.io/api/v1/products" -H "accept: application/json" -H "x-total-count: 0"`
page	Query string	If you wish to "page" through results, you can use the page and limit query string parameters to iterate through pages of data. The API will multiply Page (1-based) by Limit to calculate the number of records at the head of the result set to skip. Example: `curl -X GET "https://inventory-service.tixuk.io/api/v1/products? page=5" -H "accept: application/json"`
limit	Query string	If you wish to return a fixed number of results, pass the total number of records to return as a limit query string parameter. Example: `curl -X GET "https://inventory-service.tixuk.io/api/v1/products? limit=50" -H "accept: application/json"`