Query Parameters
Maximum number of price lists to return per page (1-999).
Include related data in the response. Supported value:
prices — embeds the individual product prices that belong to each list.Sort the results. Supported fields:
id, name, created_at. Use array notation, e.g. sort[0][0]=name&sort[0][1]=asc.Comma-separated list of fields to include in the response (e.g.
id,name,status).Request Example
Response Example
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). |