KDS
4 API calls in this section.
List KDS Orders
/restaurant/kds/ordersLoad the kitchen display queue for a location, filtered by kitchen ticket status.
Query parameters
| Parameter | Type | Description |
|---|---|---|
location_id | string | Example: |
statuses | string | Example: |
page | string | Example: |
limit | string | Example: |
append | string | Example: |
Headers
| Parameter | Type | Description |
|---|---|---|
Authorization | string | Example: |
1curl --globoff --request GET "https://staging-api.ondi.io/functions/v1/restaurant/kds/orders?location_id=${LOCATION_ID}&statuses=queued,preparing,ready&page=1&limit=10&append=false" \2 --header "Authorization: Bearer ${ONDI_ACCESS_TOKEN}"Response examples
No saved response example. Use Try it to inspect a staging response.
Print Ticket
/restaurant/kds/tickets/:id/printMark a kitchen ticket as printing and record its print time. The response returns the updated ticket.
Path parameters
| Parameter | Type | Description |
|---|---|---|
idRequired | string | Dynamic path value from the request URL. |
Headers
| Parameter | Type | Description |
|---|---|---|
Authorization | string | Example: |
1curl --globoff --request POST "https://staging-api.ondi.io/functions/v1/restaurant/kds/tickets/${ID}/print" \2 --header "Authorization: Bearer ${ONDI_ACCESS_TOKEN}"Response examples
No saved response example. Use Try it to inspect a staging response.
Update Ticket Status
/restaurant/kds/tickets/:id/statusMove a kitchen ticket to a supported status and optionally update its preparation estimate.
Path parameters
| Parameter | Type | Description |
|---|---|---|
idRequired | string | Dynamic path value from the request URL. |
Headers
| Parameter | Type | Description |
|---|---|---|
Authorization | string | Example: |
Body parameters
| Parameter | Type | Description |
|---|---|---|
status | string | — |
1curl --globoff --request POST "https://staging-api.ondi.io/functions/v1/restaurant/kds/tickets/${ID}/status" \2 --header "Authorization: Bearer ${ONDI_ACCESS_TOKEN}" \3 --header "Content-Type: application/json" \4 --data-raw '{5 "status": "preparing"6}'Response examples
No saved response example. Use Try it to inspect a staging response.
Update Ticket ETA
/restaurant/kds/tickets/:id/etaSet the kitchen ticket’s estimated preparation time in minutes.
Path parameters
| Parameter | Type | Description |
|---|---|---|
idRequired | string | Dynamic path value from the request URL. |
Headers
| Parameter | Type | Description |
|---|---|---|
Authorization | string | Example: |
Body parameters
| Parameter | Type | Description |
|---|---|---|
eta_minutes | number | — |
1curl --globoff --request POST "https://staging-api.ondi.io/functions/v1/restaurant/kds/tickets/${ID}/eta" \2 --header "Authorization: Bearer ${ONDI_ACCESS_TOKEN}" \3 --header "Content-Type: application/json" \4 --data-raw '{5 "eta_minutes": 156}'Response examples
No saved response example. Use Try it to inspect a staging response.