Update recipe

{
  "recipe_name": "Classic Burger v2",
  "recipe": {
    "lines": [
      {
        "consume_by": "ITEM",
        "item_id": "itm_beef_premium_01...",
        "qty_base": 200,
        "base_unit_id": "unit_g_01..."
      }
    ]
  },
  "external_user_id": "user_chef_99"
}

{
  "id": "rec_01j5k...",
  "status": "DRAFT",
  "recipe_name": "Classic Burger v2",
  "version": 1
}

{
  "error": {
    "kind": "recipe_not_editable",
    "message": "Only DRAFT recipes can be updated"
  }
}

PATCH

api

public

vendors

{vendorId}

recipes

{recipeId}

{
  "recipe_name": "Classic Burger v2",
  "recipe": {
    "lines": [
      {
        "consume_by": "ITEM",
        "item_id": "itm_beef_premium_01...",
        "qty_base": 200,
        "base_unit_id": "unit_g_01..."
      }
    ]
  },
  "external_user_id": "user_chef_99"
}

{
  "id": "rec_01j5k...",
  "status": "DRAFT",
  "recipe_name": "Classic Burger v2",
  "version": 1
}

{
  "error": {
    "kind": "recipe_not_editable",
    "message": "Only DRAFT recipes can be updated"
  }
}

string

required

BOH API key with recipes:write scope.

string

required

Vendor UUID.

string

required

Recipe UUID. Must be in DRAFT status.

string

New display name.

string

Store scoping UUID. Set null to make it global.

string

Updated POS product ID.

string

Updated POS variant ID.

string

Updated produced item UUID.

string

Updated short code.

object

Updated recipe content with lines[] (replaces entire lines array if provided).

string

Actor for audit trail.

{
  "recipe_name": "Classic Burger v2",
  "recipe": {
    "lines": [
      {
        "consume_by": "ITEM",
        "item_id": "itm_beef_premium_01...",
        "qty_base": 200,
        "base_unit_id": "unit_g_01..."
      }
    ]
  },
  "external_user_id": "user_chef_99"
}

{
  "id": "rec_01j5k...",
  "status": "DRAFT",
  "recipe_name": "Classic Burger v2",
  "version": 1
}

{
  "error": {
    "kind": "recipe_not_editable",
    "message": "Only DRAFT recipes can be updated"
  }
}

Overview

Identity

Stores

Suppliers

Catalog Items

Catalog Sync

Recipes

Goods Receipts

Stock Counts

Waste Events

Transfers

Production Batches

Tracking

Par Levels

Suggested Order

Purchase Orders

PO Lines

Webhooks