メインコンテンツへ移動
tablezio
無料でメニューを作る

Order operations

Kitchen, delivery and status transitions

The operational order surface, authenticated with an X-API-Key widget key. It pages with page/limit and projects with `fields`, unlike the versioned /v1/orders resource — use these for live screens, and /v1/orders for integrations.

List orders

GET /public/orders スコープ: X-API-Key (widget key)

Lists orders for the restaurant the key belongs to, with offset paging and sorting. `fields` selects the projection — the default is a compact set (id, orderNumber, type, status, total, createdAt) rather than the whole order, because these screens refresh often.

クエリパラメータ

fieldsstring任意

Comma-separated fields. Defaults to id,orderNumber,type,status,total,createdAt.

statusstring任意

Filter by order status.

typestring任意

Filter by order type.

pageinteger任意

Page number, 1-based.

limitinteger任意

Page size.

sortstring任意

Field to sort on, e.g. createdAt.

orderstring任意

Sort direction.

ascdesc

リクエスト

curl 'https://api.tablezio.com/public/orders?status=placed&limit=20' \
  -H 'X-API-Key: tbz_…'

Active orders

GET /public/orders/active スコープ: X-API-Key (widget key)

The orders currently in play, without you having to know which statuses count as active. Poll this one for a floor or expo screen instead of filtering the full list client-side.

クエリパラメータ

fieldsstring任意

Comma-separated fields to return.

リクエスト

curl 'https://api.tablezio.com/public/orders/active' -H 'X-API-Key: tbz_…'

Kitchen orders

GET /public/orders/kitchen スコープ: X-API-Key (widget key)

The kitchen view, optionally narrowed to one station. Station routing is stored on the menu category, so an item reaches this list already assigned — the screen filters, it does not decide.

クエリパラメータ

fieldsstring任意

Comma-separated fields to return.

stationstring任意

Restrict to one kitchen station.

リクエスト

curl 'https://api.tablezio.com/public/orders/kitchen?station=grill' \
  -H 'X-API-Key: tbz_…'

Active deliveries

GET /public/orders/delivery/active スコープ: X-API-Key (widget key)

The delivery orders currently out or waiting to go out — the board a dispatcher watches. Same field selection as the other list views.

クエリパラメータ

fieldsstring任意

Comma-separated fields to return.

リクエスト

curl 'https://api.tablezio.com/public/orders/delivery/active' -H 'X-API-Key: tbz_…'

Track a delivery

GET /public/orders/delivery/{id}/track スコープ: X-API-Key (widget key)

Tracking state for one delivery order, resolved through the delivery fleet service. Use it to drive a per-order tracking view rather than polling the whole active board.

パスパラメータ

idstring必須

Order id.

クエリパラメータ

fieldsstring任意

Comma-separated fields to return.

リクエスト

curl 'https://api.tablezio.com/public/orders/delivery/507f1f77bcf86cd799439011/track' \
  -H 'X-API-Key: tbz_…'

Retrieve an order

GET /public/orders/{id} スコープ: X-API-Key (widget key)

One order, scoped to the restaurant the key resolves to — an id from another restaurant does not resolve. Ask for the fields the detail view needs; the list endpoints deliberately return less.

パスパラメータ

idstring必須

Order id.

クエリパラメータ

fieldsstring任意

Comma-separated fields to return.

リクエスト

curl 'https://api.tablezio.com/public/orders/507f1f77bcf86cd799439011' \
  -H 'X-API-Key: tbz_…'

Create an order

POST /public/orders スコープ: X-API-Key (widget key)

Creates an order on the operational surface. If you are building an integration rather than a screen, prefer `POST /v1/orders`: it is the versioned resource, it supports idempotency keys and expansions, and it is the one covered by the API changelog.

リクエスト

curl -X POST 'https://api.tablezio.com/public/orders' \
  -H 'X-API-Key: tbz_…' \
  -H 'Content-Type: application/json' \
  -d '{"type":"dine-in","items":[{"menuItemId":"5a1b2c3d4e5f6a7b8c9d0e1f","quantity":1}]}'

Update order status

PATCH /public/orders/{id}/status スコープ: X-API-Key (widget key)

Moves the whole order to a new status. This is the transition a floor or expo screen fires; the allowed values are validated server-side, so an unknown status is a 400 rather than a silently stored string.

パスパラメータ

idstring必須

Order id.

ボディパラメータ

statusstring必須

New order status.

リクエスト

curl -X PATCH 'https://api.tablezio.com/public/orders/507f1f77bcf86cd799439011/status' \
  -H 'X-API-Key: tbz_…' \
  -H 'Content-Type: application/json' \
  -d '{"status":"ready"}'

Update an order item status

PATCH /public/orders/{id}/items/{itemIndex}/status スコープ: X-API-Key (widget key)

Moves a single line of the order — addressed by its index, not by an id, because an order item is a position in the order rather than a standalone record. The accepted values are pending, preparing, ready and served, which is what makes a per-station display possible: each station advances only its own lines.

パスパラメータ

idstring必須

Order id.

itemIndexinteger必須

Zero-based index of the item within the order.

ボディパラメータ

statusstring必須

New item status.

pendingpreparingreadyserved

リクエスト

curl -X PATCH 'https://api.tablezio.com/public/orders/507f1f77bcf86cd799439011/items/0/status' \
  -H 'X-API-Key: tbz_…' \
  -H 'Content-Type: application/json' \
  -d '{"status":"ready"}'