Read Restriction recommendation

GET

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

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

Read an existing instance.

A typed sell-restriction recommendation issued by an agent against a scope (room type, rate plan, or the pair) over a date range: a closure, closed-to-arrival / departure, or a length-of- stay bound, with the reading that motivated it — the rooms left, the protection level, the demand and sell-up the recommender believes — frozen at issue time. Applying it authors a rate_restriction row through the same path a hand-posted restriction takes; a lift recommendation (the re-open) constrains nothing and its apply lifts the rows standing in its scope over its range, keeping them as history. The decision_* fields mutate exactly once on the transition out of suggested.

Authorizations

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

properties

required

object

closed

required

Hard stop-sell recommended

boolean

closed_to_arrival

required

Closed to arrival recommended

boolean

closed_to_departure

required

Closed to departure recommended

boolean

confidence

required

Operator-facing confidence ordinal

string

Allowed values: low medium high

confidence_score

Calibrated probability (0..=1) — set when the model emits one

string format: decimal

decided_at

When the recommendation transitioned out of suggested

string format: date-time

decision_status

required

Lifecycle state

string

Allowed values: suggested applied modified_and_applied rejected expired superseded

demand_forecast_rooms

Unconstrained higher-rate demand the recommender believes for the first night, in rooms

string format: decimal

end_date

required

Last night the restriction would cover (inclusive)

string format: date

expires_at

required

After this, decision_status moves to expired

string format: date-time

expires_on

The house business day this lapses after. When set, the house's open business date decides expiry (not the wall clock) and expires_at is the nominal end of that day in the house's timezone

string format: date

factors_considered

required

Signals the recommendation conditioned on (the strategy that fired)

Array<string>

Allowed values: pickup_pace booking_curve competitive_set event_calendar historical_pattern segment_mix channel_mix length_of_stay_distribution cancellation_rate no_show_rate package_attachment group_displacement weather other

forecast_snapshot

Restriction recommendation forecast snapshot

Forecast snapshot frozen at issue time (per §B.2)

object

ari_score

string format: decimal

as_of

required

string format: date-time

competitive_set_adr

object

amount

required

string format: decimal

currency

required

string format: iso-4217

competitive_set_occupancy_pct

string format: decimal

event_calendar_signal

string

forecast_kind

required

string

Allowed values: internal_pms external_rms external_str_compset hybrid other

mpi_score

string format: decimal

on_books_revenue

object

amount

required

string format: decimal

currency

required

string format: iso-4217

on_books_rooms

integer

pickup_last_24h

integer

pickup_last_7d

integer

rgi_score

string format: decimal

transient_adr_forecast

object

amount

required

string format: decimal

currency

required

string format: iso-4217

transient_rooms_forecast

integer

required

Recommendation id

string

issued_at

required

When the agent emitted the recommendation

string format: date-time

lift

Recommend lifting what stands in the scope over the range (the re-open)

boolean

max_length_of_stay

Maximum length of stay recommended (nights)

integer

min_length_of_stay

Minimum length of stay recommended (nights)

integer

protection_level

Rooms the recommender wants kept for the higher rate (the protection level the restriction enforces)

integer

rationale_text

Human-readable explanation surfaced to operators

string

rejection_reason

Free-text reason set on reject

string

rooms_remaining

Rooms left to sell on the first night, at issue time

integer

sell_up_rate

Share of fenced-rate buyers believed to pay the higher rate once the fence closes (0..=1)

string format: decimal

start_date

required

First night the restriction would cover

string format: date

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.restriction_recommendation",
  "properties": {
    "confidence": "low",
    "decision_status": "suggested",
    "factors_considered": [
      "pickup_pace"
    ],
    "forecast_snapshot": {
      "forecast_kind": "internal_pms"
    }
  },
  "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).