Skip to content
API referencePricing API

Update prices across price lists

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
PATCH
/api/v1/batch-update-pricing

Accepts a JSON array or a CSV file (Content-Type: text/csv); each entry names a SKU, a price_list_slug and the prices for that combination. Only the SKU and price list combinations you send are affected, and their existing prices are replaced.

Returns 404 if a referenced price list does not exist, 400 for validation errors (usually as an array of {line, field, message} objects), and 409 if the update clashed with another one running at the same time, in which case you can retry it.

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

List of sku, price list, quantity and price to update. Partial updates are supported, meaning only the SKUs present will be affected. For the given SKUs, existing prices are deleted then the supplied prices are inserted. If a SKU is provided but quantity and price are blank, all prices for that SKU are removed from the price list.

TypeScript Definitions

Use the request body type in TypeScript.

[index: integer]?

Response Body

application/json

application/problem+json

curl -X PATCH "https://app.sparklayer.io/api/v1/batch-update-pricing" \  -H "Authorization: Bearer <ACCESS_TOKEN>" \  -H "Site-Id: jones-climbing" \  -H "Content-Type: application/json" \  -d '[    {      "sku": "SKU-1",      "price_list_slug": "example-list",      "display_tax_rate": 10,      "pricing": [        {          "quantity": 1,          "price": 10.49,          "unit_of_measure": "pallet"        }      ]    }  ]'
Empty

PATCHUpdate prices for a SKU

This patch endpoint will remove all pricing for the __price list slugs__ provided and apply provided pricing against the provided price lists. It is also important to note you can upload multiple price lists in one call.

POSTCalculate prices for SKUs

Works out the price of each SKU in `skus` from the price lists in `price_list_slugs`, checked in the order given. The first list that has prices for the SKU wins, whether those prices are stored on the list or derived from one of its rules (with currency conversion and the percentage adjustment applied). Prices are always net and are returned as `{number, currency}` objects. Returns an empty array if none of the price lists exist.