Read Menu item variant

GET

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

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

Read an existing instance.

The priced, orderable unit of a menu item — a 125 / 175 / 250 ml glass, a bottle, a half or full portion. Every item has at least one; a single-size item has one default variant. Prices attach here (price_for_variant), and a check line records the variant it sold.

Authorizations

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

properties

required

object

active

required

Orderable

boolean

required

Variant id

string

is_default

required

Default variant

The variant a till key or a feed line naming only the item rings. An item with one variant uses it whatever this says.

boolean

measure

Measure

The quantity served, as the menu states it (175 ml, 25 ml, 8 oz) — wine and spirits must be offered in specified quantities.

string

name

required

Variant name (Regular, 175 ml, Bottle)

string

sort_order

Order on the till

integer

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_variant",
  "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).