Order

Order ProductsGET

Paginated on-demand line items for an order, filtered by status (related/returned/changed). At X-API-Version >= 2.6.0 each row eager-loads its product/modifiers/taxes/discounts by default; below 2.6.0 rows are bare unless explicit includes are passed. Scoped to the caller's market/branch. Paginated via page/per_page (max 100).

Get Api V2 Orders Order Id Products Order Product IdGET

Mark Order Product DonePOST

Flips a single kitchen line's `is_done` flag. When the flip leaves no unfinished `RELATED` line on the order, the order is transitioned to `COMPLETED` through the same service the order update endpoint uses, so a status log is written, the table is released and the broadcast carries the new status. `is_done: 0` never moves the order back. When the order type's mandatory-field settings block the completion the tick still succeeds (200) and the response carries `meta.completion_blocked`, a list of `{field, message}`. **Gated by the branch cutover switch** (`branch_settings.kitchen.legacy_board`, contract §14.1): a branch on `READ_ONLY` answers `409` with `data.error.code = "kitchen.legacy_board_read_only"` and one on `OFF` answers `409 kitchen.legacy_board_off`, both before any write, so a stale client cannot tick a line on a branch that has moved to the kitchen screens.

Generate Order InvoicePOST

Generate (or reuse a cached) invoice PDF for an order and return its file URL.

List Order TypesGET

List the shared order type catalog, flagged with whether the caller market has adopted each entry. For the customer role this returns the market's digital-menu order types (is_digital && is_active configs) with the icon relation and allowed payment methods; filter[market_id] is required for customers.

Create Order TypePOST

Register a new order type in the shared catalog.

Detail Order TypeGET

Get a catalog order type by its key.

Delete Order TypeDELETE

Remove a catalog order type (blocked while any market has adopted it).

Update Order TypePUT

Update a catalog order type's canonical name/image.

List Order Type ConfigsGET

List the caller market's adopted order types with pagination and filtering options.

Create Order Type ConfigPOST

Adopt an existing order type or mint a new one for the caller market. A target=PRODUCT config may carry a products[] batch of per-product charge overrides (sync/replace, keyed by modifier_id).

Detail Order Type ConfigGET

Get details of a specific adopted order type by its config id.

Delete Order Type ConfigDELETE

Remove an adopted order type from the caller market.

Update Order Type ConfigPUT

Update an adopted order type for the caller market. When the effective target is PRODUCT, a products[] batch syncs per-product charge overrides (sync/replace, keyed by modifier_id).

Detail Order Type ProductGET

Get a product's saved price for an order type, or null if unverified.

Upsert Order Type ProductPOST

Create or update a product's saved price for an order type.

Delete Order Type ProductDELETE

Revert a product to auto/computed pricing for an order type.