⌘K
Service operations
Kitchen Display
Orders
Kitchen Display
Pickup
The Kitchen Display System (KDS) allows kitchen staff to view incoming orders in real time. These endpoints let you retrieve the kitchen display configuration for a restaurant.
GET/restaurants/{restaurantId}/kitchen_display/Get Kitchen Display
Retrieve the kitchen display configuration for a restaurant. Returns the display settings including language preference and activation status. Returns a "not found" code if no kitchen display has been configured.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| restaurantId | integer | Yes | The unique identifier of the restaurant. |
Response
{
"status": 200,
"code": "kitchen_display_found",
"message": "The kitchen has been found.",
"data": {
"kitchenDisplayId": 42,
"restaurantId": 200,
"language": "fr",
"isActive": true,
"createdAt": "2025-03-15T10:30:00.000Z",
"updatedAt": "2025-03-15T10:30:00.000Z"
}
}Response Properties
Every field in the example is listed below. Explicit requiredness is shown when the endpoint contract defines it.
| Property | Type | Example | Description |
|---|---|---|---|
| status | integer | 200 | HTTP status code returned by the API. |
| code | string | "kitchen_display_found" | Machine-readable application code for the result. |
| message | string | "The kitchen has been found." | Human-readable result message. Do not use this value for program logic. |
| data | object | {…} | Endpoint-specific response payload. |
| data.kitchenDisplayId | integer | 42 | Identifier of the associated kitchen display. |
| data.restaurantId | integer | 200 | Identifier of the restaurant. |
| data.language | string | "fr" | The language value. |
| data.isActive | boolean | true | Whether this resource is active. |
| data.createdAt | string | "2025-03-15T10:30:00.000Z" | Timestamp when this resource was created. |
| data.updatedAt | string | "2025-03-15T10:30:00.000Z" | Timestamp when this resource was last updated. |