Antylogic
DemoApp login

399 operational guides

Docs sections
DocsKDS
Device

How to advance a KDS item

Move one visible kitchen item from the KDS board to its next production state, keeping the board, ticket detail and backend status in sync.

In this article

The KDS board is where the kitchen team moves live service items through production. In the Harbor Soho demo, a kitchen item can progress from Draft to Sent, Preparing, Ready and then Served without leaving the board.

This guide covers the operator flow for one item: open the live KDS board, find a kitchen-relevant row, swipe it forward and confirm that the board reflects the updated production state.

Before you start

  • Harbor Demo Group and the Harbor Soho location are selected.
  • KDS is enabled for the location through `tpv_settings.enable_kds`.
  • There is an active service session for Harbor Soho, otherwise the board cannot load service tickets.
  • The ticket belongs to the active service, is not closed or void, and contains at least one kitchen-relevant item.
  • The item is visible in Draft, Sent, Preparing or Ready. Served and Cancelled items are not shown on the KDS board.
  • The operator has `kds:use` or `kds:manage` at the location. Users with only `kds:view` can inspect the board but cannot advance items.

Instructions

  1. 1.

    Open the KDS board

    Open `/:orgId/:locationId/kds` for Harbor Soho. The board becomes operational only after the location, active service, KDS setting and access checks pass.

  2. 2.

    Find the kitchen item

    Locate the open ticket and choose the visible item that needs attention. The board keeps kitchen-relevant items that are still in Draft, Sent, Preparing or Ready.

  3. 3.

    Swipe the item forward

    Swipe the item row in the advance direction. The row reveals the next production state before the action commits: Draft to Sent, Sent to Preparing, Preparing to Ready, or Ready to Served.

  4. 4.

    Let the update finish

    The app sends `POST /api/app/{orgId}/{locationId}/tickets/{ticketId}/items/production-status` with the item id, its current `from_statuses` value and the next `to_status`.

  5. 5.

    Confirm the board state

    After the returned TicketDetail refreshes the board, the item appears in its next KDS state. If it moved from Ready to Served, it disappears because Served is not displayed on the board.

Validations and limits

  • The row is locked for users with only `kds:view`, so the swipe does not trigger the update.
  • The current status is sent as `from_statuses` to avoid advancing an item that another terminal has already changed.
  • If KDS is disabled or there is no active service session, the board cannot be used for this action.
  • The UI uses `POST`; the backend also accepts `PUT` for the same endpoint as compatibility behaviour.
  • When an item moves to Sent, Antylogic may create kitchen output jobs for configured kitchen printers or active KDS devices, but the status update does not require those jobs to exist.

Expected result

The kitchen item is advanced to the next production state, the ticket detail returned by the backend refreshes the board, and the item either remains visible in its next KDS stage or leaves the board after reaching Served.

Related articles