Search Recipe

POST

/v1/object-types/hospitality.recipe/search

const url = 'https://api.aerandil.com/v1/object-types/hospitality.recipe/search';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"branch":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","cursor":"example","filters":[{"property":"id","type":"eq","value":"example"}],"limit":1,"order":"asc","property_id":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","scope":{"level":"tenant"},"sort_by":"created_at"}'
};

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

curl --request POST \
  --url https://api.aerandil.com/v1/object-types/hospitality.recipe/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "branch": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "cursor": "example", "filters": [ { "property": "id", "type": "eq", "value": "example" } ], "limit": 1, "order": "asc", "property_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "scope": { "level": "tenant" }, "sort_by": "created_at" }'

Search for instances. Filters eq, contains, gte and lte AND-compose; or / not are additive follow-ups. Pages with an opaque cursor; the +1 fetch returns has_more without a second round-trip. Ordered by sort_by (default created_at) in order (default ascending), id breaking ties; rows with no value for a property key sort last.

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

Request Body^required

application/json

object

branch

Optional open-branch id. Search composes that branch’s copy-on-first-write overlay instead of main, so a preview reads its own hypothetical writes. Omit to read main.

string format: uuid

cursor

Opaque cursor from a prior response’s next_cursor. Pass back verbatim; do not introspect.

string

filters

Conjunctive list of predicates. Empty or omitted matches every row in scope, capped by limit.

Array

One of:

object

property

required

Allowed value: id

type

required

Allowed value: eq

value

required

string

limit

Page size. Server defaults to 50, silently clamps at 500 (AIP-158 §3).

integer

>= 1 <= 500

order

Direction of sort_by: asc (oldest / smallest first) or desc. A cursor is bound to the sort_by and order it was minted under; another pair is refused (422).

string

default: asc

Allowed values: asc desc

property_id

The house a desk stands in: keeps this property’s rows (property- or venue-scoped there) and every row scoped to no property (tenant, brand, portfolio), and drops a sibling house’s — the meaning property_id has on the event tail.

string format: uuid

scope

One of: discriminator: level

object

level

required

string

Allowed value: tenant

Allowed values: tenant

sort_by

What the page is ordered by: the row’s created_at or updated_at, or a property whose type orders — strings, enums and dates as text, ints, decimals and durations as numbers, datetimes as instants. Rows with no value sort last in either direction. A property the caller is not cleared to read is refused (403).

string

default: created_at

Allowed values: created_at updated_at id recipe_kind serves_per_batch build_method build_duration_seconds dilution_percent glass_type glass_specifier ice_type shelf_life_hours shelf_life_storage pour_cost_computed_at

Responses

200

Search results, ordered by (sort_by, id) in the requested order (ascending by default).

application/json

object

data

required

Array<object>

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

has_more

required

boolean

next_cursor

Cursor for the next page; omitted when the result set is exhausted.

string

Example

{
  "data": [
    {
      "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"
      }
    }
  ]
}

422

Validation error — unknown property or filter type mismatch.

Search Recipe

Authorizations

Request Bodyrequired

Responses

200

Example

422

Request Body^required