Flavours Partner API
Order

Mark Order Product Done

POST
/api/v2/orders/{orderId}/products/{orderProductId}

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.

Authorization

API-TOKEN
API-TOKEN<token>

Your partner API key. Send it in the API-TOKEN header on every request.

In: header

Path Parameters

orderId*string
orderProductId*string

Header Parameters

X-API-Version*string

API contract version to target. See the Changelog for what changed in each version.

Default"2.0.0"
Value in"2.3.0" | "2.2.0" | "2.1.0" | "2.0.0"

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://api.flavours.sa/dev/api/v2/orders/voluptas/products/earum" \  -H "X-API-Version: 2.3.0"
{
  "meta": {
    "code": 401,
    "status": "error",
    "message": "Unauthenticated."
  },
  "data": null
}
{
  "meta": {
    "code": 403,
    "status": "error",
    "message": "Unauthorized."
  },
  "data": null
}
{
  "meta": {
    "code": 404,
    "status": "error",
    "message": "Resource not found."
  },
  "data": null
}
{
  "meta": {
    "code": 500,
    "status": "error",
    "message": "Internal server error."
  },
  "data": null
}

Get Api V2 Orders Order Id Products Order Product Id GET

Order Products GET

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).