Skip to main content
Scalev API v3 is a headless commerce API for storefront, customer, and authenticated business integrations. You can use it to power catalog, cart, checkout, orders, subscriptions, digital product access, and related commerce workflows in your own app or system.

Base URL

https://api.scalev.com
All documented endpoints in this reference live under the /v3 namespace.

Authentication

Authentication depends on the route family:

Public storefront routes

Store-derived public storefront routes under /v3/stores/{store_id}/public/* require a publishable storefront API key:
X-Scalev-Storefront-Api-Key: sfpk_...

Customer-authenticated routes

Customer routes use bearer authentication:
Authorization: Bearer CUSTOMER_ACCESS_TOKEN

Authenticated business routes

Authenticated business routes use bearer authentication with an access token or business API key:
Authorization: Bearer YOUR_TOKEN_HERE

Common Response Format

Scalev API v3 does not use the legacy code / status / data response envelope.

Single Resource Success

Single-resource success responses return the resource directly:
{
  "id": "ord_123",
  "status": "paid"
}

Non-Paginated Collection Success

{
  "data": [
    {
      "id": "prod_123"
    }
  ],
  "is_paginated": false
}

Paginated Collection Success

{
  "data": [
    {
      "id": "prod_123"
    }
  ],
  "is_paginated": true,
  "has_next": true,
  "has_previous": false,
  "next_cursor": "opaque-token",
  "previous_cursor": null,
  "page_size": 25
}

Error Response

{
  "error": "Error message",
  "error_code": "optional_error_code"
}

HTTP Status Codes

The API uses standard HTTP status codes:
  • 200 OK - Successful read, update, or action request
  • 201 Created - Successful create request
  • 204 No Content - Successful request with no response body
  • 400 Bad Request - Invalid request format, parameters, or cursor
  • 401 Unauthorized - Authentication required or token is invalid
  • 403 Forbidden - Authenticated but not allowed
  • 404 Not Found - Resource not found
  • 409 Conflict - Resource conflict
  • 422 Unprocessable Entity - Validation errors
  • 429 Too Many Requests - Rate limit exceeded
  • 5xx - Unexpected server error

Rate Limiting

API requests may be rate limited. When rate limiting is applied, limit information is returned in response headers such as:
  • X-Ratelimit-Limit
  • X-Ratelimit-Remaining
  • X-Ratelimit-Reset

Pagination

Paginated /v3 endpoints use opaque cursor-based pagination.

Request Parameters

  • page_size - Number of items to return
  • next_cursor - Cursor for the next page
  • previous_cursor - Cursor for the previous page

Response Fields

  • data - Array of items in the current page
  • is_paginated - Always true for paginated responses
  • has_next - Whether a next page exists
  • has_previous - Whether a previous page exists
  • next_cursor - Opaque cursor for the next page
  • previous_cursor - Opaque cursor for the previous page
  • page_size - Number of items returned per page
{
  "data": [
    {
      "id": "prod_123"
    }
  ],
  "is_paginated": true,
  "has_next": true,
  "has_previous": false,
  "next_cursor": "opaque-token",
  "previous_cursor": null,
  "page_size": 25
}

Support

If you encounter issues, contact the Scalev support team.
This documentation may change as the Scalev API evolves.