Skip to main content

Kitchen Display System (KDS)

Authenticated API

KDS endpoints require a valid JWT Bearer token with kitchen/chef roles. Accessible via the API gateway at /v1/commerce/kds/*.

The Kitchen Display System (KDS) provides 6 gateway endpoints for managing kitchen tickets.

Get Station Tickets

GET /v1/commerce/kds/stations/:station_id/tickets

Retrieve all active tickets for a KDS station.

curl https://dev.api.olympuscloud.ai/v1/commerce/kds/stations/STATION_ID/tickets \
-H "Authorization: Bearer $TOKEN"

Response

[
{
"order_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
"station_id": "station-uuid",
"status": "pending",
"items": [
{
"name": "Margherita Pizza",
"quantity": 1,
"modifiers": {},
"notes": "Extra crispy",
"seat_number": 1
}
],
"priority": "normal",
"created_at": "2026-02-19T15:30:00Z"
}
]

Get Expo View

GET /v1/commerce/kds/expo

Get the expo (expeditor) view showing all tickets across all stations.

curl https://dev.api.olympuscloud.ai/v1/commerce/kds/expo \
-H "Authorization: Bearer $TOKEN"

Bump Ticket

POST /v1/commerce/kds/stations/:station_id/orders/:order_id/ticket/bump

Mark a ticket as completed and bump it off the KDS screen.

curl -X POST https://dev.api.olympuscloud.ai/v1/commerce/kds/stations/STATION_ID/orders/ORDER_ID/ticket/bump \
-H "Authorization: Bearer $TOKEN"

Recall Ticket

POST /v1/commerce/kds/stations/:station_id/orders/:order_id/ticket/recall

Bring back a previously bumped ticket to the screen.

curl -X POST https://dev.api.olympuscloud.ai/v1/commerce/kds/stations/STATION_ID/orders/ORDER_ID/ticket/recall \
-H "Authorization: Bearer $TOKEN"

Void Ticket

POST /v1/commerce/kds/stations/:station_id/orders/:order_id/ticket/void

Void (cancel) a kitchen ticket.

curl -X POST https://dev.api.olympuscloud.ai/v1/commerce/kds/stations/STATION_ID/orders/ORDER_ID/ticket/void \
-H "Authorization: Bearer $TOKEN"

Set Ticket Priority

POST /v1/commerce/kds/stations/:station_id/orders/:order_id/ticket/priority

Change the priority of a ticket (e.g., rush order).

curl -X POST https://dev.api.olympuscloud.ai/v1/commerce/kds/stations/STATION_ID/orders/ORDER_ID/ticket/priority \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $TOKEN" \
-d '{"priority": "rush"}'

Summary

These are the 6 KDS endpoints exposed through the API gateway:

EndpointMethodDescription
/v1/commerce/kds/stations/:station_id/ticketsGETGet station tickets
/v1/commerce/kds/expoGETExpo view (all stations)
/v1/commerce/kds/stations/:sid/orders/:oid/ticket/bumpPOSTBump (complete) ticket
/v1/commerce/kds/stations/:sid/orders/:oid/ticket/recallPOSTRecall bumped ticket
/v1/commerce/kds/stations/:sid/orders/:oid/ticket/voidPOSTVoid ticket
/v1/commerce/kds/stations/:sid/orders/:oid/ticket/priorityPOSTChange ticket priority