Read Availability day

GET

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

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

Read an existing instance.

Inventory ledger entry per (property, room_type, business_date). The single source of truth for whether a room is sellable. physical is the underlying room count; sellable is the count exposed to channels after holds/walls; sold is occupancy as of the snapshot; oversell_limit is the operator’s declared headroom above sellable, which offsets cancellations and no-shows — declared by set_availability, moved by an applied sell-limit recommendation; declared_oversell_limit keeps the operator’s declaration (what a recommendation’s reset restores) and oversell_ceiling the most headroom a recommendation may set; out_of_order is the count of this type’s rooms blocked out of order this date (owned by the room_status_block verbs, never by set_availability); blocked is the count held by group blocks and not yet picked up (owned by the group-block verbs, likewise never by set_availability). The booking flow refuses at sellable - out_of_order - blocked + oversell_limit, and the validator on this type enforces 0 <= sold <= sellable + oversell_limit, sellable <= physical, 0 <= out_of_order <= physical, and 0 <= blocked <= physical on every write.

Authorizations

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

properties

required

object

blocked

Rooms held by group blocks and not yet picked up

integer

business_date

required

Business date

string format: date

committed_oversell

Room-nights accepted past the ceiling because a channel had already sold them

integer

declared_oversell_limit

Declared oversell limit

The oversell headroom the operator declared — what a sell-limit recommendation’s reset restores

integer

required

Availability id

string

notes

Notes

string

out_of_order

Rooms of this type blocked out of order this date

integer

oversell_ceiling

Oversell ceiling

The most oversell headroom a sell-limit recommendation may set (the operator’s guardrail; absent, the declared limit)

integer

oversell_limit

Oversell limit

integer

physical

required

Physical room count

integer

sellable

required

Sellable room count

integer

sold

required

Sold count

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