Skip to content

How SparkLayer connects

For AI assistants: the facts every SparkLayer API call needs
  • Base URLs: Live https://app.sparklayer.io, test https://test.app.sparklayer.io. Each environment has its own data and its own API keys.
  • Access: API access needs the Pro or Enterprise plan. Create credentials (Site ID, Client ID, Client Secret) in the SparkLayer Dashboard at Settings > API.
  • Access token: POST {base}/api/auth/token with a Site-Id header and a JSON body (not form-encoded): {"grant_type":"client_credentials","client_id":"…","client_secret":"…"}. It returns access_token, valid for 3,600 seconds. There is no refresh token: cache the token and request a new one shortly before it expires.
  • Every request: Authorization: Bearer <access_token> and Site-Id: <site id>, plus Content-Type: application/json when there is a body. Set a User-Agent that names your integration.
  • Errors: RFC 7807 problem details: title, status, detail and an optional errors[] of { code, message, property }. Some error responses have no body. Retry 5xx, 429 (honouring Retry-After) and concurrent-update 409s with exponential backoff; on 401, get a new token once and retry; don't retry other 4xx without changing the request.
  • Pagination: Most list endpoints return everything. GET /api/v2/price-lists pages with page and page_size (up to 250) until pagination.current_page equals total_pages. GET /api/v1/purchases uses limit (up to 500) and offset: stop when a page has fewer than limit results.
  • Ground rules: Use only endpoints, fields and SDK methods that the docs or OpenAPI specs define. Prefer GET /api/v2/price-lists over the deprecated v1. Products are matched by SKU. Keep credentials in environment variables or a secrets manager, never in code.
  • Read the docs as Markdown: Add .md to any page URL. Index of every page: docs.sparklayer.io/llms.txt. Every API operation, compactly: docs.sparklayer.io/llms-api.txt. The developer guides in full: docs.sparklayer.io/developers/llms.txt.
  • OpenAPI specs: core, ordering, pricing, purchasing, stock, files, sync-log: https://docs.sparklayer.io/openapi/<api>.yaml (also .json). Ignite: https://docs.sparklayer.io/openapi/ignite.yaml.
  • MCP: Search and read these docs from your assistant with the docs MCP server at https://docs.sparklayer.io/mcp.
Build with AI: ready-made prompts and MCP setup

SparkLayer works alongside your eCommerce platform; it doesn't replace it. Your platform still runs your catalogue, your customers, checkout and orders. SparkLayer adds what B2B buyers need on top, such as their own prices, pack sizes and ordering rules.

How SparkLayer connects: B2B data flows from your backend into the SparkLayer Backend; the SparkLayer Connector links to your eCommerce platform; the SparkLayer Frontend adds B2B widgets to your storefront.

Backend

ERP / CRM
Manual upload
Automatic
(this flows forward)

B2B-specific data

  • Price lists
  • Product pack sizes
  • Customer rules

Sent directly from a backend system or uploaded manually.

eCommerce platform

Core functions

  • Order management
  • Catalogue management
  • Customer management
  • Analytics
  • Marketing & promotions
  • CMS

SparkLayer connects to your eCommerce platform, e.g. Shopify.

Website storefront

Core templates

  • Homepage
  • Collections
  • Products
  • Static pages
  • Blog

Core pages work as normal.

B2B widgets

  • Product pricing
  • Buy button
  • Quick order form
  • Checkout & ordering
  • My Account area

SparkLayer overlays your website with these B2B features.

SparkLayer Backend

Stores the B2B data you send to it.

SparkLayer Connector

Connects to your eCommerce platform.

SparkLayer Frontend

Updates specific parts of your website.

The three parts of SparkLayer

PartWhat it does
BackendStores your B2B data, such as price lists, pack sizes and customer rules. Your backend systems send it through the SparkLayer API, or you add it with the import tools in the Dashboard.
ConnectorKeeps SparkLayer and your eCommerce platform in step, in both directions. Products and customers come in from your platform: see Product and customer sync.
FrontendAdds B2B features to your storefront, such as customer-specific prices, quick order and the My Account area. The rest of your site works as normal. See Frontend integration.

What this means for your integration

  • Keep products and customers on your eCommerce platform. SparkLayer reads them from there, so you don't send them to SparkLayer.
  • Send B2B data from the system that owns it. Prices and stock usually live in your ERP, which is their source of truth: send them to SparkLayer with the API, and change them in the ERP, not in SparkLayer.
  • No ready-made integration for your platform? With Ignite, you build the Connector yourself.

Next steps

SparkLayer API

What each API does, and which ones your integration needs.

Building integrations

Build the integration yourself, or use a middleware partner.

Data limitations

Recommended and hard limits on the data you send.

SparkLayer Ignite

Connect SparkLayer to a platform without a ready-made integration.

Was this page helpful?

Last updated

Developer documentation

Build on SparkLayer with the REST APIs, JavaScript SDK, storefront templates and Ignite, and make your first authenticated API call in a few minutes.

Building integrations

Choose how to connect your ERP or CRM to SparkLayer: build a direct integration with the SparkLayer API or use a middleware partner such as an iPaaS.