Read Outlet

GET

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

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

Read an existing instance.

A USALI-conformant revenue-bearing unit. Distinct from venue (the physical space) because outlets are revenue-reporting categories: the rooms outlet has no venue; a banquets-and-restaurant venue can host two revenue centers (one outlet each). usali_department is the chart-of-accounts classification; kind is the operational classification — orthogonal axes, since an outlet’s accounting schedule and its operational shape do not always coincide (a third-party-licensed restaurant books as other_operated but operates as restaurant).

Authorizations

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

properties

required

object

code

required

Outlet code

string

description

Description

string

kind

required

Operational kind

string

Allowed values: rooms restaurant bar lounge room_service banquet catering spa salon wellness_program gym pool golf parking minibar retail activity tour rental business_center laundry telecom package_aggregator other

meal_periods

Outlet meal periods

The outlet’s meal periods (Simphony’s serving periods, Toast’s services): each a daypart, 24-hour start_time and end_time on the house’s wall clock, and its days_of_week. open_check stamps a live check with the one in force. Written by set_outlet_meal_periods, which refuses an overlap.

Array<object>

object

daypart

required

string

Allowed values: breakfast brunch lunch dinner late_night drinks dessert room_service all_day

days_of_week

Array<string>

Allowed values: monday tuesday wednesday thursday friday saturday sunday

end_time

required

string

start_time

required

string

name

required

Outlet name

string

usali_department

required

USALI 12 department

string

Allowed values: rooms food_beverage health_club_spa golf parking minibar other_operated minor_operated miscellaneous_income it_services retail

usali_revenue_center_label

required

USALI revenue center label

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.outlet",
  "properties": {
    "kind": "rooms",
    "meal_periods": [
      {
        "daypart": "breakfast",
        "days_of_week": [
          "monday"
        ]
      }
    ],
    "usali_department": "rooms"
  },
  "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).