List Price Lists

This endpoint retrieves all price lists. A price list is a named set of product prices that can be applied to specific venues or sales channels — for example, a dedicated price list for delivery orders that differs from in-store prices.

This endpoint requires authentication. Include your JWT in the x-token header. See Authentication for how to obtain a token and Errors for error responses.

Query Parameters

integer

default:"50"

Maximum number of price lists to return per page (1-999).

array

Include related data in the response. Supported value: prices — embeds the individual product prices that belong to each list.

array

Sort the results. Supported fields: id, name, created_at. Use array notation, e.g. sort[0][0]=name&sort[0][1]=asc.

string

Comma-separated list of fields to include in the response (e.g. id,name,status).

Request Example

curl "https://integrations.clopos.com/open-api/v2/price-lists?with[]=prices" \
  -H "x-token: YOUR_ACCESS_TOKEN"

const response = await fetch(
  "https://integrations.clopos.com/open-api/v2/price-lists?with[]=prices",
  { headers: { "x-token": "YOUR_ACCESS_TOKEN" } }
);
const data = await response.json();

import requests

response = requests.get(
    "https://integrations.clopos.com/open-api/v2/price-lists",
    params={"with[]": "prices"},
    headers={"x-token": "YOUR_ACCESS_TOKEN"},
)
data = response.json()

Response Example

{
  "data": [
    {
      "id": 1,
      "name": "Delivery Prices",
      "description": "Prices applied to delivery orders",
      "status": true,
      "prices": [
        {
          "id": 10,
          "list_id": 1,
          "product_id": 105,
          "price": 12.5
        }
      ],
      "created_at": "2026-01-13T14:08:49.000000Z",
      "updated_at": "2026-01-13T10:22:12.000000Z"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 50,
    "total": 1,
    "total_pages": 1
  }
}

Field Reference

Price List Object

Field	Type	Description
`id`	integer	Unique identifier for the price list.
`name`	string	Display name of the price list (e.g., “Delivery Prices”).
`description`	string (nullable)	Optional description of the price list, or `null`.
`status`	boolean	Whether the price list is active.
`prices`	array	Individual product prices in this list. Included only when requested via `with[]=prices`. See Price object.
`created_at`	string	Creation timestamp (ISO 8601).
`updated_at`	string	Last update timestamp (ISO 8601).

Overview

Auth

Venues

Users

Customers

Categories

Station

Products

Price Lists

Sales

Orders

Receipts

Tables

Query Parameters

Request Example

Response Example

Field Reference

Price List Object

​Query Parameters

​Request Example

​Response Example

​Field Reference

​Price List Object

Query Parameters

Request Example

Response Example

Field Reference

Price List Object