Skip to main content
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

limit
integer
default:"50"
Maximum number of price lists to return per page (1-999).
with[]
array
Include related data in the response. Supported value: prices — embeds the individual product prices that belong to each list.
sort
array
Sort the results. Supported fields: id, name, created_at. Use array notation, e.g. sort[0][0]=name&sort[0][1]=asc.
selects
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"

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

FieldTypeDescription
idintegerUnique identifier for the price list.
namestringDisplay name of the price list (e.g., “Delivery Prices”).
descriptionstring (nullable)Optional description of the price list, or null.
statusbooleanWhether the price list is active.
pricesarrayIndividual product prices in this list. Included only when requested via with[]=prices. See Price object.
created_atstringCreation timestamp (ISO 8601).
updated_atstringLast update timestamp (ISO 8601).