Read Turnaway

GET

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

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

Read an existing instance.

A request for rooms the house refused — the lost-demand record. Not a reservation and not a waitlist entry: nothing traverses a turnaway, so it holds no inventory. Carries the night asked for, the stay length, the instant the guest asked (requested_at, business time), why the desk said no (reason), the minimum stay in force if one was, the segment and channel when known, for a guest who declined the rate (rate, a regret) the rate quoted, and the booking engine’s key for the browser that asked (visitor_id) when its tag read one. A revenue-management forecast reads turnaways beside sales to see the demand a full house or a restriction hid; without them it is forecasting from censored data. A regret’s quoted rate is how it reads its own price back out of what it saw, and the visitor key — on the reservation too — is how it tells one shopper’s earlier looks from a stranger’s.

Authorizations

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

properties

required

object

adults

Adults asked for

integer

arrival_date

required

The arrival night asked for

string format: date

external_ref

Replay key for the recording source (unique per tenant while present)

string

required

Turnaway id

string

market_segment

Market segment of the demand, when the desk could tell

string

Allowed values: transient group contract

min_stay_in_force

The minimum stay posted for the arrival when the request was refused

integer

nights

required

Nights asked for

integer

notes

What the desk noted

string

quoted_rate

Turnaway quoted rate

Rate quoted

object

amount

required

string format: decimal

currency

required

string format: iso-4217

reason

required

Why the request was refused

string

Allowed values: sold_out min_stay closed rate other

requested_at

required

When the guest asked (business time; defaults to now)

string format: date-time

source

Channel the request arrived through, when known

string

Allowed values: direct_web direct_call property_direct ota gds wholesale corporate walk_in group_block agent loyalty

visitor_id

Booking engine visitor

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.turnaway",
  "properties": {
    "market_segment": "transient",
    "reason": "sold_out",
    "source": "direct_web"
  },
  "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).