Read Stay offer

GET

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

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

Read an existing instance.

One room type on one rate plan the house quoted a shopper and kept: the stay (arrival_date, departure_date), the party (adults), the published arrival-night rate (quoted_rate) and stay total the admission gate priced, when it was quoted (offered_at, business time), the channel the shopper came through, the shopping session the house issued (session_id) and the visitor key it issued for the browser (visitor_id). A search stays the read quote_stay is; the offer is the room and rate a shopper opened. A reservation made in the session links to its first offer (reservation_booked_in_session), and a session that booked nothing is a regret, derived — regret_record — never recorded. Holds no inventory.

Authorizations

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

properties

required

object

adults

required

Adults — the occupancy the grid priced

integer

arrival_date

required

Arrival night

string format: date

departure_date

required

Departure date

string format: date

required

Offer id

string

offered_at

required

When the house quoted it (business time; defaults to now)

string format: date-time

quoted_rate

required

Stay offer quoted rate

Rate quoted

object

amount

required

string format: decimal

currency

required

string format: iso-4217

session_id

required

Shopping session

string

source

required

Channel the shopper came through

string

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

total

required

Stay offer total

Stay total quoted

object

amount

required

string format: decimal

currency

required

string format: iso-4217

visitor_id

Visitor key the house issued

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.stay_offer",
  "properties": {
    "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).