Skip to content
API referenceStock API

Get stock levels for multiple SKUs

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
POST
/api/v1/batch-fetch-stock

Returns stock levels for the SKUs in skus, grouped by SKU. By default only the stock location with the external ID default is included: set filter.all_stock_locations to true to include every location, or pass filter.stock_location_ids to choose specific ones. SKUs with no matching stock levels are left out of the response.

Authorization

bearerAuth
AuthorizationBearer <token>

Send Authorization: Bearer <access_token>, together with your Site-Id header, on every request. Get the token from POST /api/auth/token with your Site ID in the Site-Id header and a JSON body (not form-encoded, so standard OAuth 2.0 client libraries don't work): {"grant_type": "client_credentials", "client_id": "…", "client_secret": "…"}. Tokens are valid for 3,600 seconds and there is no refresh token: request a new one shortly before it expires. Create API credentials in the SparkLayer Dashboard under Settings > API. See Authentication.

In: header

Header Parameters

Site-Id*string

Your SparkLayer Site ID, from Settings > API in the SparkLayer Dashboard.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

skus?array<string>

The SKUs to get stock levels for.

filter?

Which stock locations to include. Without it, only the location with the external ID default is included.

Response Body

application/json

application/problem+json

curl -X POST "https://app.sparklayer.io/api/v1/batch-fetch-stock" \  -H "Authorization: Bearer <ACCESS_TOKEN>" \  -H "Site-Id: jones-climbing" \  -H "Content-Type: application/json" \  -d '{    "skus": [      "SKU-1"    ],    "filter": {      "stock_location_ids": [        "123e4567-e89b-12d3-a456-426614174000"      ],      "all_stock_locations": true    }  }'
[  {    "sku": "SKU-1",    "stock_levels": [      {        "stock_level": 9,        "restock_date": "2020-01-01",        "min_stock_level": -9,        "created_at": "2019-08-24T14:15:22Z",        "updated_at": "2019-08-24T14:15:22Z",        "stock_location_id": "123e4567-e89b-12d3-a456-426614174000",        "stock_location_name": "Main Warehouse"      }    ]  }]

Stock API

The Stock API reads, batch updates and deletes stock levels by SKU and manages stock locations for your SparkLayer site. Lists every endpoint and its responses.

POSTUpdate stock levels for multiple SKUs

Creates or updates the stock level for each SKU and stock location pair in the array. Identify the location with either `stock_location_id` or `stock_location_external_id`, not both. The stored values for each pair you send are overwritten; pairs you leave out are unchanged. Returns `400` if a `stock_location_external_id` does not exist, or if the same SKU and location appear more than once in the request.