Publish recipe

{
  "external_user_id": "user_chef_99"
}

{
  "id": "rec_01j5k...",
  "status": "PUBLISHED",
  "version": 1,
  "recipe_name": "Classic Burger",
  "published_at": "2026-08-07T15:00:00.000Z",
  "published_by_external_user_id": "user_chef_99"
}

{
  "error": {
    "kind": "recipe_no_lines",
    "message": "Recipe must have at least one line before publishing"
  }
}

POST

api

public

vendors

{vendorId}

recipes

{recipeId}

publish

{
  "external_user_id": "user_chef_99"
}

{
  "id": "rec_01j5k...",
  "status": "PUBLISHED",
  "version": 1,
  "recipe_name": "Classic Burger",
  "published_at": "2026-08-07T15:00:00.000Z",
  "published_by_external_user_id": "user_chef_99"
}

{
  "error": {
    "kind": "recipe_no_lines",
    "message": "Recipe must have at least one line before publishing"
  }
}

string

required

BOH API key with recipes:write scope.

string

required

Vendor UUID.

string

required

Recipe UUID. Must be in DRAFT status with at least one line.

string

Actor for audit trail.

string

Recipe UUID.

string

PUBLISHED.

integer

Incremented publish version.

string

ISO 8601 timestamp of publication.

{
  "external_user_id": "user_chef_99"
}

{
  "id": "rec_01j5k...",
  "status": "PUBLISHED",
  "version": 1,
  "recipe_name": "Classic Burger",
  "published_at": "2026-08-07T15:00:00.000Z",
  "published_by_external_user_id": "user_chef_99"
}

{
  "error": {
    "kind": "recipe_no_lines",
    "message": "Recipe must have at least one line before publishing"
  }
}

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