The SparkLayer API

Introduction

The SparkLayer API follows REST principles with OAuth2 authentication, allowing you to tightly integrate with your backend systems. Our API Docs give a complete overview of how to integrate with SparkLayer and we've also included some key information below

API elements

The SparkLayer API can be used to connect to a wide range of data, however, the extent will depend on your integration.

For example, if you're using one of the supported platform integrations (e.g. Shopify), SparkLayer will automatically be able to retrieve product and customer data from the platform itself. In this scenario, the SparkLayer API will only be used to send through Product price list data primarily and limited other data (e.g. pack sizes). If you're building a bespoke integration with a custom platform, the integration will be more extensive and require most elements of the API to be used.

The SparkLayer API has support for the following data elements:

Area

Data required

Products

Product and Variant Data

Stock

Product Stock Data

Pricing & Price Lists

Product Pricing and Price Lists

Customers

Customer information

Addresses

Customer Addresses

Orders

Order Data

Shipping

Shipping pricing and rules

Stock Locations

Locations where stock is stored

Getting started with the API

Integrating with the SparkLayer API will require technical expertise and our recommendation is to review our SparkLayer API Docs in detail before beginning the process. Please note the following:

  1. Before starting, you'll need your unique Site ID which can be found in the SparkLayer Dashboard My Account section.

  2. To better understand how the SparkLayer API works, you can experiment with our Postman simulation environment.

  3. If you have any technical questions about how best to integrate with the SparkLayer API, please contact us here and we'll be happy to assist

To get started, visit our SparkLayer API Docs.