Read Channel

GET

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

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

Read an existing instance.

A distribution channel: direct booking, an OTA, a GDS, a tour operator, etc. Channels carry their own credentials/state and are connected to rate plans they distribute via the channel_distributes_rate_plan link, replacing the prior single-channel enum on RatePlan.

Authorizations

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

properties

required

object

code

required

Channel code

string

commission_flat_amount

Channel commission flat amount

Per-booking flat commission

object

amount

required

string format: decimal

currency

required

string format: iso-4217

commission_kind

Commission kind

string

Allowed values: percent_of_revenue per_booking_flat per_booking_plus_percent none

commission_rate

Current commission rate

string format: decimal

external_code

External / partner code

string

kind

required

Channel kind

string

Allowed values: direct_web direct_call direct_walk_in ota gds wholesale tour_operator corporate metasearch social other

name

required

Channel name

string

status

required

Status

string

Allowed values: active paused closed

target_share

Operational target share

string format: decimal

target_share_basis

Target share basis

string

Allowed values: bookings revenue room_nights

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.channel",
  "properties": {
    "commission_kind": "percent_of_revenue",
    "kind": "direct_web",
    "status": "active",
    "target_share_basis": "bookings"
  },
  "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).