Categories

Manage menu categories (e.g. “Pizzeria”, “Grill”, “Drinks”). Categories group food items and can be toggled on/off to control availability.

Category Object

{
  "id": "clxyz123456789abcdef",
  "name": "Pizzeria",
  "available": true,
  "position": 1
}

GET /v1/categories

Retrieve all categories with optional filtering.

Authentication:

• available=true: Public, no authentication required
• Otherwise: Bearer token (admin)

Query Parameters

Response 200 OK

[
  {
    "id": "clxyz123456789abcdef",
    "name": "Pizzeria",
    "available": true,
    "position": 1
  }
]

GET /v1/categories/{id}

Retrieve a single category by ID.

Authentication: Bearer token (admin)

Path Parameters

Query Parameters

Response 200 OK

Returns a Category Object.

Errors

POST /v1/categories

Create a new category.

Authentication: Bearer token (admin)

Request Body

{
  "name": "Pizzeria",
  "available": true,
  "position": 1,
  "printerId": "clxyz987654321fedcba"
}

Response 201 Created

Errors

PUT /v1/categories/{id}

Update an existing category (full replacement).

Authentication: Bearer token (admin)

Note: Changing available will also update the availability of all associated foods. Changing printerId will also cascade to all associated foods — set to null to remove the printer association from the category and all its foods.

Path Parameters

Request Body

Same as POST.

Response 200 OK

Errors

PATCH /v1/categories/{id}

Partially update a category’s availability or printer.

Authentication: Bearer token (admin)

Note: Changing available will also update the availability of all associated food items. Changing printerId will also update the printer of all associated foods — set to null to remove the association.

Path Parameters

Request Body

{
  "available": true,
  "printerId": "clxyz987654321fedcba"
}

Response 200 OK

Errors

PATCH /v1/categories/{id}/image

Upload or update the category image.

Authentication: Bearer token (admin)

Path Parameters

Request Body

multipart/form-data with the following field:

Response 200 OK

Errors

DELETE /v1/categories/{id}

Delete a category.

Authentication: Bearer token (admin)

Path Parameters

Response 204 No Content

Errors