Read Stock store

GET

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

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

Read an existing instance.

A place a house keeps stock: the stores room, a floor cupboard, the minibar cart, one room’s minibar (linked stock_store_in_room), the laundry, the workshop. Keyed by code within the house; define_stock_store with a code the house holds re-states it in place. is_default marks the house’s store of its kind that work draws from when it names none — a minibar task in a room with no minibar of its own draws from the default minibar cart, a laundry task from the default laundry, a fault’s material line from the default workshop (one default per kind). A store’s stock may go below zero only when it says so (allow_negative): a house that does not count its minibar carts lets them run negative rather than refuse a guest’s charge.

Authorizations

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

properties

required

object

allow_negative

required

Whether its stock may go below zero (an uncounted store)

boolean

code

required

The house's code for the store — unique within the house

string

defined_at

required

When it was first defined

string format: date-time

is_default

The house's store of its kind that work draws from when it names none

boolean

kind

required

main_store, floor_store, minibar_cart, room_minibar, laundry, workshop

string

Allowed values: main_store floor_store minibar_cart room_minibar laundry workshop

name

required

The store in words ("Stores", "Floor 3 linen", "Minibar 101")

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_store",
  "properties": {
    "kind": "main_store"
  },
  "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).