Fetch an entity
For AI assistants: the facts every SparkLayer API call needs
- Base URLs: Live
https://app.sparklayer.io, testhttps://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/tokenwith aSite-Idheader and a JSON body (not form-encoded):{"grant_type":"client_credentials","client_id":"…","client_secret":"…"}. It returnsaccess_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>andSite-Id: <site id>, plusContent-Type: application/jsonwhen there is a body. Set aUser-Agentthat names your integration. - Errors: RFC 7807 problem details:
title,status,detailand an optionalerrors[]of{ code, message, property }. Some error responses have no body. Retry5xx,429(honouringRetry-After) and concurrent-update409s with exponential backoff; on401, get a new token once and retry; don't retry other4xxwithout changing the request. - Pagination: Most list endpoints return everything.
GET /api/v2/price-listspages withpageandpage_size(up to 250) untilpagination.current_pageequalstotal_pages.GET /api/v1/purchasesuseslimit(up to 500) andoffset: stop when a page has fewer thanlimitresults. - Ground rules: Use only endpoints, fields and SDK methods that the docs or OpenAPI specs define. Prefer
GET /api/v2/price-listsover the deprecated v1. Products are matched by SKU. Keep credentials in environment variables or a secrets manager, never in code. - Ignite: With Ignite, SparkLayer calls endpoints that your service implements (the Ignite spec), and your service calls the SparkLayer APIs above for everything else.
- Read the docs as Markdown: Add
.mdto 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.
POST /v1/{siteEnv}/{siteId}/sync/{syncDataType}/{entityId} Ignite endpoints
Implemented by your integration
This is an Ignite endpoint: your integration service implements it and SparkLayer calls it. Use this reference to build and test your implementation.
POST
/v1/{siteEnv}/{siteId}/sync/{syncDataType}/{entityId}Fetch an entity from the platform.
Path Parameters
siteEnv*string
The SparkLayer environment the request is for, such as live. Store it, with the site ID, when SparkLayer connects your platform.
siteId*string
The SparkLayer site ID the request is for, such as bobs-store. Store it, with the environment, when SparkLayer connects your platform.
Length
1 <= lengthsyncDataType*string
The type of entity to fetch
Value in
- "customers"
- "products"
- "purchases"
- "stock"
entityId*string
The entity's ID on your platform.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
payload?|
Optional - the payload to send back to the integration during the item sync
Response Body
application/json
application/problem+json
application/problem+json
curl -X POST "https://ignite.example.com/v1/live/bobs-store/sync/products/1234567890" \ -H "Content-Type: application/json" \ -d '{ "payload": "<payload>" }'{ "external_id": "string", "external_url": "string", "visible_name": "string", "customer_v2": "string", "customer_v2_deactivate": true}