iRetail PRO
Русский Get a key
Menu

iRetail PRO store node 1.0.0-m1: kitchen

4 operations

← All documentation · Source: contracts openapi/store-v1.yaml at 8000474.

← iRetail PRO store node 1.0.0-m1

Operations

GET /v1/kitchen/tickets A station's kitchen tickets, oldest first (spec/FOOD_SERVICE.md, "Kitchen display").

operationId listKitchenTickets · Permission kitchen.use

Parameters

Name In Type Description
IRetail-App header string Which app sends the request, at which version: <app>/<version>, optionally a space and (<platform>), as cashier/1.2.0 (windows-x64) or manager/1.2.0 (web). The register (cashier), the back office and the console (manager) and the device gateway (gateway) send it on every request; a request without it is not one of the apps and is served as the current API, and a device token of an app's kind without it is an app of an unknown version; a header that does not parse counts as absent. The node may refuse an app 426 app_update_required by it, except on the operations marked x-app-update-exempt. Not a security boundary (spec/API.md, Transport; spec/RELEASES.md, Who is asking).
station required query string The station.
state query "open" | "ready" open (new and started) or ready (bumped in the last 15 minutes).

Responses

POST /v1/kitchen/tickets/{id}/start Start a new ticket.

operationId startKitchenTicket · Permission kitchen.use

Parameters

Name In Type Description
IRetail-App header string Which app sends the request, at which version: <app>/<version>, optionally a space and (<platform>), as cashier/1.2.0 (windows-x64) or manager/1.2.0 (web). The register (cashier), the back office and the console (manager) and the device gateway (gateway) send it on every request; a request without it is not one of the apps and is served as the current API, and a device token of an app's kind without it is an app of an unknown version; a header that does not parse counts as absent. The node may refuse an app 426 app_update_required by it, except on the operations marked x-app-update-exempt. Not a security boundary (spec/API.md, Transport; spec/RELEASES.md, Who is asking).
id required path string (uuid) Id.
If-Match header string The version the change is based on.

Responses

POST /v1/kitchen/tickets/{id}/ready Bump a new or started ticket as ready.

operationId bumpKitchenTicket · Permission kitchen.use

Parameters

Name In Type Description
IRetail-App header string Which app sends the request, at which version: <app>/<version>, optionally a space and (<platform>), as cashier/1.2.0 (windows-x64) or manager/1.2.0 (web). The register (cashier), the back office and the console (manager) and the device gateway (gateway) send it on every request; a request without it is not one of the apps and is served as the current API, and a device token of an app's kind without it is an app of an unknown version; a header that does not parse counts as absent. The node may refuse an app 426 app_update_required by it, except on the operations marked x-app-update-exempt. Not a security boundary (spec/API.md, Transport; spec/RELEASES.md, Who is asking).
id required path string (uuid) Id.
If-Match header string The version the change is based on.

Responses

POST /v1/kitchen/tickets/{id}/recall Bring a ticket bumped in the last 15 minutes back as started.

operationId recallKitchenTicket · Permission kitchen.use

Parameters

Name In Type Description
IRetail-App header string Which app sends the request, at which version: <app>/<version>, optionally a space and (<platform>), as cashier/1.2.0 (windows-x64) or manager/1.2.0 (web). The register (cashier), the back office and the console (manager) and the device gateway (gateway) send it on every request; a request without it is not one of the apps and is served as the current API, and a device token of an app's kind without it is an app of an unknown version; a header that does not parse counts as absent. The node may refuse an app 426 app_update_required by it, except on the operations marked x-app-update-exempt. Not a security boundary (spec/API.md, Transport; spec/RELEASES.md, Who is asking).
id required path string (uuid) Id.
If-Match header string The version the change is based on.

Responses

Schemas

Error object

Every error response.

error required string Stable code, see spec/API.md.
message required string English text for logs.
details object

KitchenTicket object

One station's part of a sale, or of a send of a restaurant check (spec/FOOD_SERVICE.md, "Kitchen display"; spec/RESTAURANT.md).

id required string (uuid)
kind required "order" | "cancel" order, or cancel for the voided lines of a check (acknowledged with a bump, never started).
receipt_id required string (uuid) | null
receipt_number required integer (int64) | null The receipt's number; null for a check's ticket.
check_id required string (uuid) | null
check_number required integer (int64) | null
course required integer | null The check's course; null for a receipt's ticket.
waiter_id required string (uuid) | null
waiter_name required string | null
cancels_ticket_id required string (uuid) | null
station required string
state required "new" | "started" | "ready" | "canceled"
order_type required "dine_in" | "take_out" | "delivery" | null How a food-service order leaves; null for retail (spec/FOOD_SERVICE.md).
order_label required string | null A name or table number the register asked for; a check's table or tab name.
order_label_kind required "table" | "tab" | null Whether a check's order_label names a table or a tab; null for a receipt's ticket (spec/FOOD_SERVICE.md, Tickets of checks).
lines required array of object
created_at required string (date-time)
started_at required string (date-time) | null
ready_at required string (date-time) | null
version required integer (int64)