Skip to main content

Introduction

Overview​

The Loaded API is designed to make it simple sync data with our platform. In this integration guide, we'll walk you through the ins and outs of using the Loaded API to synchronize your POS system, taking into account the various workflows that can pop up during service. Each of the pages in this section focus on a specific concept, or area of the API. The intention is that they give you a good overview of what each area is expected to be used for, and then where necessary you can dive a bit deeper into the specifics by checking the more raw reference documention here.

Example 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/pos/orders

The response received will be a JSON object in the Order format that contains the orders for the Loaded company that your authorization token is bound to.

Making the most of the documentation​

It's worth having a good read through the documentation on this site before getting too stuck into writing code. Having a good understanding of how the API has been designed and how it approaches modelling the real world scenarios a POS supports will allow you to efficiently integrate. We've got some concepts like External Ids that are only implemented to make life easy for API clients so it's worth finding out about them early!

  • Start with reading the Core Concepts section. That'll give you an overview of what this API does / can do.
  • The Tutorial then provides you with a worked example of sending data into the Loaded system.
  • The Advanced section dives a bit deeper into areas that you'll likely encounter and aren't as straight forward as the normal flows.