Read Material

GET

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

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

Read an existing instance.

A part or a product a house keeps — a spare part, a consumable, an amenity, linen, a minibar product, a laundry item, a cleaning product (hubOS’s materials, laundry products and minibar families). Keyed by code within its catalogue: a brand’s (material_at_brand, shared by the brand’s houses) or one house’s (material_at_property); define_material with a code the catalogue holds re-states it in place. Counted in its unit, which is fixed once any store holds it. A minibar product carries the sale_price a minibar task charges the in-house guest. active, or retired for good (the code stays taken). How much each store holds is its stock_level rows.

Authorizations

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

properties

required

object

code

required

The catalogue's code for it — unique within the catalogue

string

defined_at

required

When it was first put in the catalogue

string format: date-time

description

Notes on it

string

family

required

What kind of thing it is: spare_part, consumable, amenity, linen, minibar_product, laundry_item, cleaning_product, other

string

Allowed values: spare_part consumable amenity linen minibar_product laundry_item cleaning_product other

name

required

What it is, in words ("Cola 330 ml", "GU10 lamp 5 W")

string

retire_reason

Why it was retired — discontinued, replaced

string

retired_at

When it was retired

string format: date-time

sale_price

Material sale price

What one unit sells for — what a minibar task charges the guest per unit

object

amount

required

string format: decimal

currency

required

string format: iso-4217

status

required

active, or retired (final)

string

Allowed values: active retired

unit

required

The unit every quantity of it is counted in

string

Allowed values: each pack pair roll kg l m

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.material",
  "properties": {
    "family": "spare_part",
    "status": "active",
    "unit": "each"
  },
  "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).