Read Ingredient supplier price

GET

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

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

Read an existing instance.

Per-property supplier price for an ingredient. The pour-cost rollup reads the active row (effective_to IS NULL) for the recipe’s property. Append-only ledger via effective_from / effective_to — supplier invoices land as fresh rows; the handler closes the prior open row.

Authorizations

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

properties

required

object

cost_per_unit_canonical

Ingredient supplier price cost per unit canonical

Cost per canonical unit

object

amount

required

string format: decimal

currency

required

string format: iso-4217

effective_from

required

Effective from

string format: date-time

effective_to

Effective to (null = currently in effect)

string format: date-time

required

Price id

string

ingredient_ref

required

Ingredient

string format: uuid

invoice_reference

Supplier invoice reference

string

property_ref

required

Property

string format: uuid

received_at

required

Received at (supplier invoice timestamp)

string format: date-time

supplier_code

Supplier code

string

unit_canonical_at_record

required

Canonical unit (snapshot at record time)

string

Allowed values: ml cl oz g kg each dash drop rim float scoop 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.ingredient_supplier_price",
  "properties": {
    "unit_canonical_at_record": "ml"
  },
  "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).