Skip to main content
GET
/
consumers
/
{consumer_id}
/
pos
/
product-categories
Get product categories
curl --request GET \
  --url https://api.chift.eu/consumers/{consumer_id}/pos/product-categories
{
  "items": [
    {
      "id": "<string>",
      "name": "<string>",
      "description": "Delicious pizza",
      "id_parent": "371ca583-d218-4900-b236-397532cf0e55"
    }
  ],
  "total": 1,
  "page": 2,
  "size": 2
}

Path Parameters

​
consumer_id
string<uuid>
required

Query Parameters

​
page
integer
default:1

Page number

Required range: x >= 1
​
size
integer
default:50

Page size

Required range: 1 <= x <= 100
​
location_id
string | null

Unique identifier of the location. If none passed, product categories from all locations will be returned unless the location was selected by the end-user

​
only_parents
enum<string>
default:false

If true, only parent categories will be returned

Available options:
true,
false

Response

Successful Response

​
items
ProductCategoryItem · object[]
required
​
total
integer
required
Required range: x >= 0
​
page
integer
required
Required range: x >= 1
​
size
integer
required
Required range: x >= 1