v1

latestOpenAPI 3.1.02026-07-22155403592.5 KB

Point of Sale

Get product categories

Returns a list of product categories

get/consumers/{consumer_id}/pos/product-categories

Path parameters

consumer_idstring uuid required

Query parameters

pageinteger

Page number

sizeinteger

Page size

location_idstring nullable

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'true' | 'false'

If true, only parent categories will be returned

Response

Successful Response

totalinteger required

pageinteger required

sizeinteger required

Example response

{
  "items": [
    {
      "id": "371ca583-d218-4900-b236-397532cf0e52",
      "name": "Pizza",
      "description": "Delicious pizza",
      "id_parent": "371ca583-d218-4900-b236-397532cf0e55"
    }
  ]
}