Getting Started
Introduction
The Loaded API is designed to allow the near realtime synchronisation of Point Of Sale (POS) data with the Loaded platform. This data is combined within the Loaded platform with other data sources to provide realtime business insight features, allowing hospitality businesses to run more profitabily.
Technically speaking, the API we provide is organised around REST with JSON as the native data format. Our API has predictable resource-oriented URLs, accepts JSON-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs. The standard integration pattern has the POS system send requests to our API immediately after operations have been performed on the POS by venue staff.
This API is documented in OpenAPI format and describes the publicly available API to interact with the Loaded platform.
This API is currently in beta. It is under active development and features are continually being added as integration needs arise. Please raise any issues or feature requests you have with your Loaded contact.
Example API request
The following is a basic example of a request to the api.loadedreports.com endpoint:
curl -H '"Authorization=Bearer {token}"' https://api.loadedreports.com/v1/orders
The response received will be a JSON object in the Order format that contains the orders for the Loaded company that the authorization token belongs to.
Starting an integration
When you're ready to start integrating with the Loaded API get in touch with us to get API credentials. The easiest way to do that is to fill out the form behind the 'Get in touch' button that appears at the bottom of every page. We'll set you up with a demo Loaded account that the data you synchronise via the API will be displayed in.
The Documentation section of this site will then help you understand the Loaded domain model. You'll likely find that your own product's data model is subtely different but it should be straightforward to map nicely between the two systems.
Once you've understood how you'll map activity in your own system to Loaded it's then a matter of writing code to send requests to the Loaded API as thing happen in the POS.
We'll also share with you a set of integration QA test cases. This doc will allow you to understand the scenarios that generally occur on a POS system and how they are expected to end up reflected in the Loaded system. These tests are eventually used to make sure the integration is ready to go into production too so it's useful to review them early.