Read Stock level

GET

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

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

Read an existing instance.

How much of one material one store holds — one row per material × store, linked stock_level_for_material and stock_level_in_store (the ids ride on the row too, so a store’s board filters without a walk). on_hand is a cache with one writer: every movement verb records its stock_movement and moves this figure in the same transaction, under the level’s lock; the movements are the truth and recount_stock_level folds them to check it. Never below zero unless the store allows it. Carries the reorder_point (OPERA’s par) and when it was last counted. Minted by the first movement (or reorder point) for the pair.

Authorizations

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

properties

required

object

required

Stock level id

string

last_counted_at

When it was last physically counted

string format: date-time

last_movement_at

When its last movement was recorded

string format: date-time

material_id

required

The material counted (its `stock_level_for_material` edge, on the row)

string

on_hand

required

How much the store holds, in the material's unit — the sum of the level's movements

string format: decimal

reorder_point

At or below this, the store's stock of the material is reordered (OPERA's par)

string format: decimal

store_id

required

The store it is kept in (its `stock_level_in_store` edge, on the row)

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