Skip to content
aerandil.com
GitHub

Read Package component

GET
/v1/object-types/hospitality.package_component/objects/{id}
curl --request GET \
  --url https://api.aerandil.com/v1/object-types/hospitality.package_component/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Read an existing instance.

One amenity inside a package: dinner-for-two, daily breakfast, an arrival massage, a $50 spa credit. Promoted to a first-class object (not link-metadata) because allocation rules, frequencies, allowances, and alternate-outlet routings don’t fit on a link’s edge metadata without violating Aerandil’s links-carry-no-payload principle.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid

Object id (UUID v7, server-generated at create time).

Query Parameters

Section titled “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

Section titled “Responses”

200

Section titled “200”

Object found.

Media typeapplication/json
object
created_at
required
string format: date-time
id
required
string format: uuid
object_type
required
Allowed value: hospitality.package_component
properties
required
object
allocation_kind
required
How the allowance scales
string
Allowed values: per_adult per_room flat
allowance_amount
Package component allowance amount

Notional contribution per occurrence

object
amount
required
string format: decimal
currency
required
string format: iso-4217
daypart
Meal period the allowance is eaten in

Set, the component is an F&B allowance: a room charge at one of its alternate outlets (any outlet of the house when it names none) consumes it from a check in this meal period — all_day is a credit for any meal. Absent, it is not food (a spa credit, parking) and the till never touches it. A breakfast or brunch allowance is eaten the morning after its night (OPERA’s Post Next Day): the breakfast roster, the till and the night audit’s allowance sweep all read it on the day after the night that carries it.

string
Allowed values: breakfast brunch lunch dinner late_night drinks dessert room_service all_day
frequency
required
When during the stay the component is available
string
Allowed values: every_night first_night final_night once
id
required
Component id
string
sort_order
Display order within package
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.package_component",
  "properties": {
    "allocation_kind": "per_adult",
    "daypart": "breakfast",
    "frequency": "every_night"
  },
  "scope": {
    "level": "tenant"
  }
}

Headers

Section titled “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

Section titled “404”

No object with that id (or soft-deleted).