Developer Quickstart


Updated on September 22, 2021

To retrieve and send data on behalf of LOU teams, you need to use the REST API. The REST API can be connected to over HTTPS.

This guide walks you through using the REST API.

Overview Schematic

Overview schematic

_👉 The REST API lets your integration access features that regular LOU operator users have access to, products, stock levels, and customers. _

How To Use

Direct usage (no library)

In case no library is available, it is still easy to use the REST API using an HTTP library available for your programming language. As long as you are able to make requests in all available HTTP methods, set body content, and configure request headers, then you are good to go.

The HTTP endpoint base you will need to use is: Note that all requests must be done via HTTPS (HTTP over TLS), we do not support HTTP (plain text HTTP).

The full list of HTTP routes available to you, as well as the data input that they expect, is available on the REST API Reference.

The examples that follow will use cURL over the command-line, as API users that do not rely on a library are most-likely using the command-line instead.

Example 1: Get Product details

Use 000a1a1a1a1a as a example product identifier.


var request = new XMLHttpRequest();'GET', '{sku_identifier}?sku_id_type=sku');

request.setRequestHeader('Content-Type', 'application/json');
request.setRequestHeader('APIKey', '{your-api-key}');

request.onreadystatechange = function () {
  if (this.readyState === 4) {
    console.log('Status:', this.status);
    console.log('Headers:', this.getAllResponseHeaders());
    console.log('Body:', this.responseText);


curl{sku_identifier}?sku-id-type=sku \
  --get \
  --header "APIKey: {your-api-key}"

Do you use Postman?

Run in Postman Collection

If you use Postman get started right away by selecting Run in Postman

Usage Considerations

Rate-limits (quotas)

The REST API is subject to rate-limits and daily quotas to protect our systems against abuse. It guarantees that the REST API stays as fast and responsive as possible for all LOU users.

Submitted data

Whenever you submit data to the API using POST, PUT or PATCH, it gets validated against a data schema.

The REST API Reference specifies the data format that schemas enforce, within the Data Structure section, for each request.

Whenever you submit data to the REST API, if it gets rejected by schema validators, you will receive the following response error: invalid_data. A message may also be provided, with explanations of what you did wrong.