Connect SparkLayer to the systems behind your B2B operation.
Keep product data in your PIM, stock in your warehouse system and customer pricing, credit and terms in your ERP or finance platform. SparkLayer connects that data to the B2B buying and selling experience, then passes orders and updates back into the systems that already run your operation.
REST APIs
Four APIs. The same B2B rules everywhere.
Every SparkLayer API uses the same customer, pricing and ordering logic as your storefront.
The API does not create a second version of your B2B logic. A pricing request returns the same price that customer sees online, and an order created through the API follows the same terms, quantities and checkout rules.
Ordering APIBuild and complete customer orders.
Create a basket for a customer, add or update products, calculate the order and submit it through SparkLayer.
The same customer pricing, payment terms, pack sizes, minimums and ordering rules are applied before the order is completed.
POST /carts · /calculate · /completePricing APIReturn the price the customer should pay.
Send pricing data into SparkLayer or ask SparkLayer for the live price of a particular product for a particular customer.
Price lists, customer discounts, quantity breaks and variant-level rules are resolved before the response is returned.
POST /pricing/lookupPurchasing APIKeep order status in sync.
Send order and fulfilment updates back to SparkLayer as the order moves through your ERP, warehouse or fulfilment process.
Customers can then see the latest status from their account without contacting your team.
PATCH /orders/{orderId}Core APIWork with the wider SparkLayer data model.
Work directly with core SparkLayer records such as products and customers when your implementation needs to supply, retrieve or manage them itself.
Standard eCommerce integrations handle much of this automatically, so the Core API is mainly for custom or more advanced setups.
GET /products · /customersKeep each system responsible for the data it already owns.
SparkLayer does not need to replace the systems already running your business.
Let your ERP remain responsible for customer terms and credit, your PIM for product information and your warehouse for fulfilment. SparkLayer brings the data together for the B2B experience and sends the resulting orders back into the operational flow.
ERPBring customer terms in. Send completed orders back.
Use the pricing, payment terms, credit limits and customer data your ERP already maintains. SparkLayer applies that commercial setup to the buyer or sales rep experience, then sends completed orders back to the ERP for the next stage of processing.
Warehouse and fulfilmentShow customers what is happening to their order.
As an order moves from placed to picked, packed and shipped, your warehouse or fulfilment system can send those updates back to SparkLayer. The latest status appears in the customer’s account, reducing the need for routine “where is my order?” emails.
PIMKeep one source of product information.
Keep descriptions, attributes, specifications and other product information in the PIM your team already maintains. SparkLayer can use that data in the B2B experience without creating another product database that has to be updated separately.
CRM and integration platformsConnect through the tools you already use.
You do not have to build and host every integration yourself. Integration platforms and partners such as Patchworks and Celigo can connect business systems to SparkLayer. They use the same APIs and manage the integration layer for you.
Choose how you connect.
Native integrationsUse a ready-made SparkLayer integration where one already exists.
Browse integrationsIntegration partnersUse an iPaaS or specialist partner to connect your existing systems without owning the integration code yourself.
Explore integration partnersSparkLayer APIBuild directly against the REST API when you need control over the workflow.
Read the API docsSparkLayer IgniteUse SparkLayer’s wider integration framework when you are bringing B2B to a custom commerce platform.
Explore IgniteWhat is the SparkLayer API?
The SparkLayer API connects your business systems to SparkLayer’s customers, products, pricing, baskets and orders. It is a REST API secured with OAuth2 and can be used by ERPs, warehouse systems, CRMs, PIMs, integration platforms and custom applications.
Use it when you want those systems to drive part of the B2B workflow without relying on manual imports or duplicate data entry.
Which APIs are available?
SparkLayer provides:
- Ordering API: Build and complete customer orders
- Pricing API: Sync pricing or return the price a specific customer should pay
- Purchasing API: Keep customer-visible order status up to date
- Core API: Work with products, customers and other core SparkLayer records
Stock and Files APIs are also available for specific Frontend SDK and custom implementation use cases.
Which plans include API access?
API access is available on Pro and Enterprise plans.
API credentials can be generated for eligible sites from the SparkLayer dashboard.
Can I connect an ERP or warehouse system?
Yes. SparkLayer can sit between systems such as your ERP, warehouse, CRM or PIM and the B2B experience your customers and sales team use. See common integrations.
For example, pricing and credit can flow into SparkLayer while orders and fulfilment updates flow back into the systems responsible for processing them.
Does the API apply the same B2B rules as the storefront?
Yes. A pricing request resolves the same customer-specific price lists, discounts and quantity rules used on the storefront.
Orders created through the API are also validated against the same customer terms and ordering rules before they are completed.
Do I need the API if I use Shopify?
Not for a standard setup. SparkLayer’s supported eCommerce integrations, such as Shopify, already handle the core connection for products, customers and orders.
Use the API when another system needs to supply data, receive updates, automate a workflow or support a requirement that is not covered by the standard integration.
Where do the Frontend SDK and SparkLayer Ignite fit?
Use the Frontend SDK when you want more control over how SparkLayer behaves or appears in the storefront, including headless implementations.
Use SparkLayer Ignite when you need to bring SparkLayer to a commerce platform that does not have a standard SparkLayer integration.
What is SparkLayer MCP?
SparkLayer MCP lets approved AI tools use specific SparkLayer data and actions through the Model Context Protocol. It is the AI-facing counterpart to the API: the API gives software structured endpoints, while MCP lets a model work with supported SparkLayer capabilities through an AI interface. Explore SparkLayer AI & MCP.
Can MCP change things, or only read them?
For supported actions, it can prepare changes as well as read data. SparkLayer validates the proposed change and shows it for confirmation before it is applied. Permissions and business rules remain in force throughout.
Where can I find the technical documentation?
The technical documentation covers authentication, API endpoints, request and response formats, and the Frontend SDK.
