iRetail PRO
English Получить ключ
Меню

iRetail PRO store node 1.0.0-m1: kitchen

4 операции

← Вся документация · Источник: контракты, openapi/store-v1.yaml на коммите 8000474.

Справочники на английском — на языке контрактов, из которых они созданы.

← iRetail PRO store node 1.0.0-m1

Операции

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

operationId listKitchenTickets · Право kitchen.use

Параметры

Имя Где Тип Описание
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 обязательный query string The station.
state query "open" | "ready" open (new and started) or ready (bumped in the last 15 minutes).

Ответы

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

operationId startKitchenTicket · Право kitchen.use

Параметры

Имя Где Тип Описание
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 обязательный path string (uuid) Id.
If-Match header string The version the change is based on.

Ответы

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

operationId bumpKitchenTicket · Право kitchen.use

Параметры

Имя Где Тип Описание
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 обязательный path string (uuid) Id.
If-Match header string The version the change is based on.

Ответы

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

operationId recallKitchenTicket · Право kitchen.use

Параметры

Имя Где Тип Описание
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 обязательный path string (uuid) Id.
If-Match header string The version the change is based on.

Ответы

Схемы

Error object

Every error response.

error обязательный string Stable code, see spec/API.md.
message обязательный 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 обязательный string (uuid)
kind обязательный "order" | "cancel" order, or cancel for the voided lines of a check (acknowledged with a bump, never started).
receipt_id обязательный string (uuid) | null
receipt_number обязательный integer (int64) | null The receipt's number; null for a check's ticket.
check_id обязательный string (uuid) | null
check_number обязательный integer (int64) | null
course обязательный integer | null The check's course; null for a receipt's ticket.
waiter_id обязательный string (uuid) | null
waiter_name обязательный string | null
cancels_ticket_id обязательный string (uuid) | null
station обязательный string
state обязательный "new" | "started" | "ready" | "canceled"
order_type обязательный "dine_in" | "take_out" | "delivery" | null How a food-service order leaves; null for retail (spec/FOOD_SERVICE.md).
order_label обязательный string | null A name or table number the register asked for; a check's table or tab name.
order_label_kind обязательный "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 обязательный array of object
created_at обязательный string (date-time)
started_at обязательный string (date-time) | null
ready_at обязательный string (date-time) | null
version обязательный integer (int64)