EPOS Integration

We recognise that many of our clients want to take advantage of the capabilities of Spektrix by connecting our platform to other systems. We support a number of existing integrations which are available to all of our clients without additional cost. Below, we have outlined how our APIs can be used to provide an integration between Spektrix and a third party EPOS system.

We have an open approach to those who want to integrate with Spektrix, and welcome third parties to make use of our APIs which can send and receive data from other third party systems. Whenever a third party wishes to integrate with Spektrix, we’ll provide them with access to our test APIs, the relevant documentation and technical support to get up and running. There is no cost for this support.

We don’t carry out custom development for a single client, and so any third parties would need to complete their integration using the APIs that are already available. If you would like to discuss something that might require development work please do get in touch. We are always interested to hear about new opportunities that may offer value to all Spektrix clients.

The following workflow can be achieved from a technical perspective by making use of the existing Spektrix APIs as an authorised user.

info

The below will require you to make some authenticated calls. The client you are working with will be able to grant you access.

Recognising Members

The below is a flow for recognising members at food & beverage points of sale, using membership information stored in Spektrix.

• Memberships will be sold through Spektrix both online and the box office.
• Using our API, it’s possible to check the status of the customer record to see if they hold an active membership. We recommend using an API call to find the Tags held on the customer record, as this provides maximum flexibility in terms of viewing the status of the customer account (for example, a tag can be set to apply to a customer's record automatically based on membership status, frequency etc.). This means that the EPOS system can access current membership status and use that information to provide members with their benefits at the bar. These benefit levels and discounts would need to be calculated in the EPOS system.

Request

GET

https://system.spektrix.com/{{clientname}}/api/v3/customers?email={{emailAddress}}&$expand=tags

Response

{
	"age": null,
	"billingAddress": null,
	"deliveryAddress": null,
	"birthDate": null,
	"email": "name@email.com",
	"firstName": "Customer First Name",
	"lastName": "Customer Last Name",
	"mobile": null,
	"name": "Customer Name",
	"phone": null,
	"tags": [
		{
			"id": "Unique Tag ID",
			"name": "Tag Name"
		}
	],
	"title": "",
	"passwordSet": false,
	"giftAidDeclarationRequired": false,
	"id": "Customers Unique ID"
}

• Because Membership benefits will likely need to apply to Food & Beverage purchases sold through the EPOS system (as well as ticket purchases), it is necessary to log a customers as a member in the EPOS system.

Applying Tags

It is also possible to use the API to append Tags to the customer record in Spektrix. These tags could be applied to the customer record based on Food & Beverage purchase history captured in the EPOS system.

The process would be as follows:

• The EPOS system would log customer spend and interaction, and apply the business logic to identify when a customer should be tagged in Spektrix.
• Using the API, the customer would be looked up in the Spektrix database and a tag applied to the customer record in Spektrix.

Request

GET

https://system.spektrix.com/{{clientname}}/api/v3/tag-groups

Response

[
  {
    "id": "Unique Tag Group ID",
    "name": "Tag Group Name",
    "description": "",
    "tags": [
      {
        "id": "Unique Tag ID",
        "name": "Tag Name"
      }
    ]
  }
]

Request

POST

https://system.spektrix.com/{{clientname}}/api/v3/customers/{{customerID}}/tags

Body

[{
  "id": "Unique Tag ID"
}]

Response

{
	"id": "Unique Tag ID",
	"name": "Tag Name"
}

• Spektrix out of the box functionality can then be used to provide a bespoke experience to the customers that have this tag - for example access to a loyal bookers offer, priority booking or an entry condition for a targeted email campaign.

Log purchase information

When members make a Food & Beverage purchase, information about this sale could be recorded in Spektrix as follows:

Purchase information can be logged against the customer record in Spektrix using the API. This will ‘sell’ Merchandise items and log them as such on the customer record in Spektrix. As the sale is made outside the Spektrix system the value of the purchase can be posted as a custom payment via the API. It will be necessary for the EPOS provider to map these sales to the appropriate stock item in Spektrix, via the API.

tip

The below sequence requires you to create a basket. Posting an empty body to https://system.spektrix.com/{{clientname}}/api/v3/baskets will return a unique basket ID.

Request a list of available merchandise.

Request

GET

https://system.spektrix.com/{{clientname}}/api/v3/stock-items

Response

[
  {
    "description": "",
    "htmlDescription": "<div id>\r\n\r\n</div>",
    "imageUrl": "",
    "name": "Merchandise Item Name",
    "postageAndPacking": 0.00,
    "price": 0.00,
    "stockLevel": 0,
    "thumbnailUrl": "",
    "id": "Unique Merchandise ID"
  }
]

Request a list of available custom payment types.

Request

GET

https://system.spektrix.com/{{clientname}}/api/v3/custom-payment-types

Response

[
  {
    "name": "EPOS System",
    "id": "93AGQTGJBKVCQVRRKBVCCRTPJTBKCNLBH",
    "isRefund": false,
    "attributeDefinitions": [
      {
        "name": "Ticket ref",
        "isRequired": false,
        "type": "Text field"
      }
    ]
  }
]

Add merch to the basket.

Request

POST

https://system.spektrix.com/{{clientname}}/api/v3/baskets/{{basketid}}/merchandise

Body

[
  {
    "stockItem": "Unique Merchandise ID",
    "reference": "Custom Reference Text" // maximum of 30 characters
  }
]

Add more information, including delivery type and customer ID.

Request

PATCH

https://system.spektrix.com/{{clientname}}/api/v3/baskets/{id}

Body

[
  {
    "Customer": "Unique Customer ID",
    "MerchandiseDelivery": { "Type": "1" },
    "Attribute": "value",
    "WaiveTransactionCommission": true
  }
]

The client you work with will be able to tell you the attribute name and values required.

Add a custom payment to the basket

Request

POST

https://system.spektrix.com/{{clientname}}/api/v3/baskets/{id}/custom-payments

Body

[
  {
    "PaymentTypeId": "93AGQTGJBKVCQVRRKBVCCRTPJTBKCNLBH",
    "Amount": 10.40,
    "PaymentAttributes": [
      {
        "Name": "Ticket ref",
        "Value": "ABC_123"
      }
    ]
  }
]

Finally, confirm the order.

Request

POST

https://system.spektrix.com/{{clientname}}/api/v3/baskets/{id}/confirm

Body

Body for this call is empty.

Spektrix segmentation tools can then be used to identify customers based on their Food and Beverage spend, as well as based on other interactions captured in Spektrix. For example, you could identify customers who have visited 3 times this month, included a donation in their purchase and spent over £15 at the bar.