Skip to content
API referenceCore API

Update discount priorities

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/set-discount-priorities

Sets the priority of several discounts in a single transaction and returns the full list of discounts. Every id and every priority in the request must be unique, otherwise you get a 400. IDs that don't match a discount are ignored.

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.

[index: integer]?

Response Body

application/json

application/problem+json

curl -X PATCH "https://app.sparklayer.io/api/v1/set-discount-priorities" \  -H "Authorization: Bearer <ACCESS_TOKEN>" \  -H "Site-Id: jones-climbing" \  -H "Content-Type: application/json" \  -d '[    {      "id": "942651af-f950-4716-9916-16170fe0645f",      "priority": 0    }  ]'
[  {    "id": "942651af-f950-4716-9916-16170fe0645f",    "created_at": "2019-08-24T14:15:22Z",    "deleted_at": "2019-08-24T14:15:22Z",    "updated_at": "2019-08-24T14:15:22Z",    "name": "string",    "internal_name": "string",    "internal_slug": "string",    "template": "string",    "calculation_group": 0,    "priority": 0,    "times_applicable_per_order": -1,    "max_rewards": 1,    "groups": [      "default"    ],    "excluded_customers": [      "customer@b2b.com"    ],    "simultaneity": [      "default"    ],    "requirement_selection_type": "any",    "reward_selection_type": "all",    "currency_code": "gbp",    "start_date": "2019-08-24T14:15:22Z",    "end_date": "2019-08-24T14:15:22Z",    "active": true,    "requirements": [      {        "items": [          {            "restrictions": [              {                "type": "productSKU",                "ref": "string",                "metadata_namespace": "erp",                "metadata_key": "vendor"              }            ],            "points_type": "line",            "points": 1,            "quantity": 0,            "selection_type": "minimum"          }        ],        "max_rewards": 0,        "min_spend": 0,        "max_spend": 0,        "spend_tax_type": "net",        "selection_type": "minimum",        "min_points": 0      }    ],    "rewards": [      {        "type": "requirements|all",        "amount_type": "percent",        "restriction_type": "equals",        "item_id": "string",        "metadata_namespace": "erp",        "metadata_key": "vendor",        "amount": 1000000000      }    ],    "other_requirements": [      {        "requirement_type": "coupons",        "coupons": [          {            "code": "string"          }        ]      }    ]  }]

POSTCreate a discount

Creates a discount and returns it with its generated UUID. `currency_code` is required when a reward or other requirement is based on a monetary amount, and coupon codes may only contain letters, numbers, underscores and hyphens. A discount can have at most 10 requirements (with up to 10 items each) and 25 rewards; breaking any of these rules returns `400`.

GETGet a discount

Returns a single discount by its UUID. Returns `404` if the discount doesn't exist or has been deleted.