Read Menu item

GET

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

const url = 'https://api.aerandil.com/v1/object-types/hospitality.menu_item/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.menu_item/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Read an existing instance.

The catalogue master of one dish or drink, shared by every outlet that sells it: names, its item class (menu_item_in_class → VAT, revenue category, course), the reporting group menu engineering reads, and its allergens. What gets priced and ordered is a menu_item_variant (variant_of_menu_item); where it appears is menu_item_in_section; an optional recipe binding (menu_item_uses_recipe) carries COGS. Distinct from service_item, the venue-level catalogue row.

Authorizations

aerandil_oauth
objects:read
aerandil_oauth
objects:hospitality.menu_item: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.menu_item

properties

required

object

active

required

Orderable

boolean

allergens

Allergens (EU 14)

The item’s declared allergens (Food Information Regulations 2014). Absent = not yet declared, which the till treats as unknown; an empty list declares none. A recipe-bound item takes its recipe’s rollup instead.

Array<string>

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

code

required

Item code

string

course_default

Course number override (else the class's)

integer

description

Guest-facing description

string

name

required

Item name

string

orderable_alone

required

Orderable on its own

False for an item that is only ever added as a modifier option (extra bacon, a side sauce) and so has no till key of its own.

boolean

reporting_group

Reporting group

The operator’s own grouping for menu engineering and sales reports (Starters, Grills, Red wine) — Simphony’s family group. The revenue split itself comes from the item class.

string

short_name

Short name

What a till key and a kitchen ticket show when the full name will not fit.

string

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.menu_item",
  "properties": {
    "allergens": [
      "gluten"
    ]
  },
  "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).