List recipes

GET /api/v1/public/vendors/vnd_abc123/recipes?recipe_type=SALES_RECIPE&status=PUBLISHED
x-api-key: boh_live_xxxxxxxx

{
  "items": [
    {
      "id": "rec_01j5k...",
      "account_id": "acc_01j...",
      "store_id": null,
      "recipe_type": "SALES_RECIPE",
      "status": "PUBLISHED",
      "version": 2,
      "recipe_name": "Classic Burger",
      "recipe_code": null,
      "external_product_id": "prod-burger-001",
      "external_variant_id": null,
      "output_item_id": null
    }
  ],
  "total": 1,
  "limit": 50,
  "offset": 0
}

GET

api

public

vendors

{vendorId}

recipes

GET /api/v1/public/vendors/vnd_abc123/recipes?recipe_type=SALES_RECIPE&status=PUBLISHED
x-api-key: boh_live_xxxxxxxx

{
  "items": [
    {
      "id": "rec_01j5k...",
      "account_id": "acc_01j...",
      "store_id": null,
      "recipe_type": "SALES_RECIPE",
      "status": "PUBLISHED",
      "version": 2,
      "recipe_name": "Classic Burger",
      "recipe_code": null,
      "external_product_id": "prod-burger-001",
      "external_variant_id": null,
      "output_item_id": null
    }
  ],
  "total": 1,
  "limit": 50,
  "offset": 0
}

string

required

BOH API key with recipes:read scope.

string

required

Vendor UUID.

string

Filter: SALES_RECIPE, PRODUCTION_RECIPE, or SUBRECIPE.

string

DRAFT, PUBLISHED, or ARCHIVED. Defaults to all non-archived.

string

UUID of a BOH store — returns recipes scoped to that store plus global ones.

string

Your product ID — returns recipes linked to that product.

string

UUID of the output item — for production recipes and subrecipes.

string

Returns recipes that have at least one line matching this service code.

string

Partial match on recipe name or code.

integer

default:"50"

Page size (1–200).

integer

default:"0"

Offset pagination.

string

Cursor-based pagination (mutually exclusive with offset).

GET /api/v1/public/vendors/vnd_abc123/recipes?recipe_type=SALES_RECIPE&status=PUBLISHED
x-api-key: boh_live_xxxxxxxx

{
  "items": [
    {
      "id": "rec_01j5k...",
      "account_id": "acc_01j...",
      "store_id": null,
      "recipe_type": "SALES_RECIPE",
      "status": "PUBLISHED",
      "version": 2,
      "recipe_name": "Classic Burger",
      "recipe_code": null,
      "external_product_id": "prod-burger-001",
      "external_variant_id": null,
      "output_item_id": null
    }
  ],
  "total": 1,
  "limit": 50,
  "offset": 0
}

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