Read Recipe

GET

/v1/object-types/hospitality.recipe/objects/{id}

const url = 'https://api.aerandil.com/v1/object-types/hospitality.recipe/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.aerandil.com/v1/object-types/hospitality.recipe/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Read an existing instance.

Production-side spec for a saleable item. 1:1 with service_item via recipe_for_service_item; composes other recipes via recipe_uses_sub_recipe (a clarified milk-wash referenced by multiple cocktails); references typed ingredient rows for pour-cost rollup. Allergens flow up from ingredient flags; the recipe allergens array is the producer- side rolled disclosure.

Authorizations

aerandil_oauth
objects:read
aerandil_oauth
objects:hospitality.recipe:read

Parameters

Path Parameters

required

string format: uuid

Object id (UUID v7, server-generated at create time).

Query Parameters

branch

string format: uuid

Read through an open branch’s copy-on-first-write overlay view instead of the canonical (main) plane. Does not compose with as_of (422). The branch must exist under the caller’s tenant.

Responses

200

Object found.

application/json

object

created_at

required

string format: date-time

required

string format: uuid

object_type

required

Allowed value: hospitality.recipe

properties

required

object

allergens

Allergens (rollup; EU 14 list)

Array<string>

Allowed values: gluten crustaceans eggs fish peanuts soybeans milk nuts celery mustard sesame sulphites lupin molluscs

build_duration_seconds

Build duration (seconds)

integer

build_method

Build method

string

Allowed values: stir shake build swizzle throw blend layer carbonate sous_vide milk_wash clarify bake grill saute sear braise poach other

dietary_classification

Dietary classification (lifestyle, not regulatory)

Array<string>

Allowed values: vegan vegetarian pescatarian halal kosher low_fodmap gluten_free dairy_free sugar_free keto paleo raw other

dilution_percent

Dilution percent (drink_*)

string format: decimal

garnishes

Garnishes

Array<string>

glass_specifier

Glass specifier (brand/size override)

string

glass_type

Glass type (drink_*)

string

Allowed values: nick_nora coupe rocks highball collins flute wine_red wine_white mug snifter tiki other

ice_type

Ice type (drink_*)

string

Allowed values: crushed cube big_rock sphere shaved none other

required

Recipe id

string

ingredients

required

Recipe ingredients

Ingredients (typed)

Array<object>

object

allergen_flags

Array<string>

Allowed values: gluten crustaceans eggs fish peanuts soybeans milk nuts celery mustard sesame sulphites lupin molluscs

garnish_role

string

ingredient_ref

string format: uuid

name

string

notes

string

quantity

required

string format: decimal

sub_recipe_ref

string format: uuid

unit

required

string

Allowed values: ml cl oz g kg each dash drop rim float scoop other

method_steps

Method steps (ordered prep instructions)

Array<string>

pour_cost

Recipe pour cost

Pour cost (projection)

object

amount

required

string format: decimal

currency

required

string format: iso-4217

pour_cost_computed_at

Pour cost refresh timestamp

string format: date-time

pre_batch

required

Pre-batched

boolean

recipe_kind

required

Recipe kind

string

Allowed values: drink_cocktail drink_coffee drink_tea drink_wine_pour dish_main dish_side dish_dessert dish_amuse spa_treatment_protocol other

sell_price

Recipe sell price

Sell price (cache from service_item)

object

amount

required

string format: decimal

currency

required

string format: iso-4217

serves_per_batch

required

Serves per batch

integer

shelf_life_hours

Shelf life (hours)

integer

shelf_life_storage

Shelf life storage

string

Allowed values: ambient refrigerated frozen controlled_atmosphere other

provenance

Per-property source attribution and pins. An entry under properties means the property’s current value came from that source (on the source’s own clock, source_updated_at); an entry under pins is a human override protecting the property from sourced writes.

object

pins

object

key

additional properties

object

pinned_at

string format: date-time

pinned_by

object

reason

required

string

properties

object

key

additional properties

object

external_id

string

recorded_at

required

string format: date-time

source

required

string

source_updated_at

string format: date-time

stream

string

scope

required

One of: discriminator: level

object

level

required

string

Allowed value: tenant

Allowed values: tenant

tenant_id

required

string format: uuid

updated_at

required

string format: date-time

version

required

integer

>= 1

Example

{
  "object_type": "hospitality.recipe",
  "properties": {
    "allergens": [
      "gluten"
    ],
    "build_method": "stir",
    "dietary_classification": [
      "vegan"
    ],
    "glass_type": "nick_nora",
    "ice_type": "crushed",
    "ingredients": [
      {
        "allergen_flags": [
          "gluten"
        ],
        "unit": "ml"
      }
    ],
    "recipe_kind": "drink_cocktail",
    "shelf_life_storage": "ambient"
  },
  "scope": {
    "level": "tenant"
  }
}

Headers

ETag

string

/^"\d+"$/

Quoted strong validator (RFC 7232 §2.3) carrying the object’s monotonic version. Informational on the read path — object mutation goes through typed actions on /v1/actions/{action}/apply, not raw CRUD.

404

No object with that id (or soft-deleted).