Search price lists for the dashboard table with search, filter and sort
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, and the Customers API (/api/v2/customers) over the legacyDELETE /api/v1/customersin the Core API. Products are matched by SKU. Keep credentials in environment variables or a secrets manager, never in code. - 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:
customers,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 /api/v2/search-price-lists Pricing API
Authorization
bearerAuth 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
Query Parameters
The page of results to fetch
1 <= value1Number of records per page
1 <= value <= 250100Field to order the search results by
^(name|created_at|updated_at|currency|slug):(asc|desc)$"name:asc"Header Parameters
Your SparkLayer Site ID, from Settings > API in the SparkLayer Dashboard.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Default
[ "custom", "integration", "platform"]Free text search matching a price list's name or slug (case-insensitive)
Filter to price lists with these ISO 4217 currency codes
Filter by whether a price list is manual (has manual prices or no rules) or automatic (has rules). An empty string means no filter.
Value in
- "manual"
- "automatic"
- ""
Filter to the price lists whose rules reference this slug as their source.
Response Body
application/json
application/problem+json
curl -X POST "https://app.sparklayer.io/api/v2/search-price-lists" \ -H "Authorization: Bearer <ACCESS_TOKEN>" \ -H "Site-Id: jones-climbing" \ -H "Content-Type: application/json" \ -d '{ "source": [ "custom", "integration", "platform" ], "search": "<search>", "currency": [ "<currency>" ], "view": "manual", "source_price_list_slug": "base-list" }'{ "data": [ { "slug": "base-list", "name": "Base Price List", "currency_code": "GBP", "source": "custom", "tax_inclusive_display": false, "rules": [ { "source_price_list_slug": "base-list", "adjustment_percentage": 0.103333, "adjustment_direction": "plus", "currency_exchange_rate": 1.254324 } ], "num_manual_prices": 0 } ], "pagination": { "total": 0, "per_page": 0, "current_page": 0, "total_pages": 0 }}