Connect SparkLayer to the systems behind your B2B operation.
Keep products in your PIM, stock in your warehouse system and customer terms in your ERP or finance platform. The SparkLayer REST API connects that data to your B2B ordering experience, then sends completed orders and customer activity back into the systems your team already uses.
REST APIs
Four APIs. The same B2B rules everywhere.
Every SparkLayer API uses the same customer, pricing and ordering logic as your storefront.
If another system asks for a price, it receives the price that customer would see online. If it completes a basket, SparkLayer applies the same terms, quantities and checkout rules.
Ordering APIBuild and complete customer orders.
Create a basket for a customer, add or update its lines, calculate the order and submit it through the same checkout flow customers use online.
SparkLayer applies their pricing, payment terms and ordering rules before the order is completed.
POST /carts · /calculate · /completePricing APIReturn the price the customer should pay.
Sync pricing data into SparkLayer or request the live price for a particular customer and product.
Responses include unit prices, line totals and quantity breaks, with price lists, customer discounts and variant rules already resolved.
POST /pricing/lookupPurchasing APIKeep customer-visible orders up to date.
Update an order as it moves through your ERP, warehouse or fulfilment process.
The status in the customer’s account stays current, so they can see what has happened since checkout without contacting your team.
PATCH /orders/{orderId}Core APIWork with the wider SparkLayer data model.
Access products, customers and the other core records held by SparkLayer.
Supported ecommerce platforms sync much of this data automatically. Use the Core API when you need to supply, retrieve or manage it yourself.
GET /products · /customersKeep each system responsible for the data it already owns.
SparkLayer sits between your business systems and the B2B buying experience.
Pricing and customer terms can continue to come from your ERP. Product details can stay in your PIM. Your warehouse can update fulfilment. SparkLayer brings it together for the customer and sends each order back into your existing workflow.
ERPBring customer terms in. Send completed orders back.
Sync the prices, payment terms and credit limits your finance team already maintains. When a customer or sales rep places an order, send it back to the ERP for processing.
Warehouse and fulfilmentShow customers what is happening to their order.
Send fulfilment updates to SparkLayer as the order moves from placed to picked, packed and shipped. The customer sees the latest status in their account without waiting for an email from your team.
PIMKeep one source of product information.
Use the product descriptions, attributes and specifications already managed in your PIM. Customers can search and filter using the same product data, without your team maintaining a second copy that gradually falls out of date.
CRM and integration platformsConnect through the tools you already use.
Use CRM connectors and integration platforms such as Patchworks and Celigo when you do not want to build and maintain a direct API connection. They use the same SparkLayer APIs while the integration provider manages the connection.
What is the SparkLayer API?
The SparkLayer API is a REST API secured with OAuth2. It connects your own systems to the products, customers, prices, baskets and orders managed by SparkLayer.
Use it to let an ERP, warehouse system, CRM, PIM or integration platform drive parts of your B2B ordering operation without relying on manual imports.
Which APIs are available?
SparkLayer provides:
- Ordering API: Create, calculate and complete baskets for a customer
- Pricing API: Sync pricing data and return the price a customer should pay
- Purchasing API: Update the orders and statuses shown to customers
- Core API: Work with wider SparkLayer data such as products and customers
The wider technical platform also includes Stock and Files APIs for the Frontend SDK and custom implementations.
Which plans include API access?
API access is available on Pro and Enterprise plans.
You will need your SparkLayer site ID and API credentials, which you can generate from the dashboard.
Can I connect an ERP or warehouse system?
Yes. Common integrations include ERP, warehouse, CRM, PIM and integration platforms.
You can bring customer prices, payment terms and credit limits into SparkLayer, then send orders and fulfilment updates back through your existing systems.
Does the API apply the same B2B rules as the storefront?
Yes. A pricing request returns the price that specific customer would see online, including their price list, discounts and quantity breaks.
Completing a basket through the API also applies the same customer terms and checkout rules as an order placed through the storefront.
Do I need the API if I use Shopify?
Not for a standard setup. SparkLayer already retrieves products and customers from supported platforms such as Shopify.
Use the API when you want another system to control additional data, automate a process or support a requirement that is not covered by a ready-made integration.
Is there a Frontend SDK?
Yes. The Frontend SDK lets developers customise SparkLayer’s storefront components and basket behaviour, or run SparkLayer behind a headless frontend.
For websites and platforms without a standard SparkLayer integration, SparkLayer Ignite provides the wider framework for a custom implementation.
Where can I find the technical documentation?
The technical documentation covers authentication, API endpoints, request and response formats, and the Frontend SDK.
