Read Channel mapping

GET

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

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

Read an existing instance.

Binds one of our room types or rate plans to the code a partner knows it by. Codes are per-connection — the same room type is DBL to one partner and RT-004 to the next — and nothing can be published or accepted under a code with no mapping row. That refusal is not defensive programming: ‘unmapped space code’ and ‘unmapped rate code’ are named, required tests in the Mews certification suite, and an unmapped code is the single most common cause of a booking that never reaches the PMS.

Authorizations

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

properties

required

object

effective_from

required

First date this binding applies

string format: date

effective_to

Last date this binding applies (null = currently in effect)

string format: date

external_code

required

The partner's code for this room type / rate plan

string

external_name

The partner's display name for it (drift check against their config)

string

required

Mapping id

string

included_occupancy

Adult occupancy the partner's price is quoted for (occupancy-based pricing)

integer

mapping_kind

required

What this row binds

string

Allowed values: room_type rate_plan room_rate age_category extra

notes

Free-form operator notes

string

publish_rates

required

Publish rate amounts for this binding

boolean

publish_restrictions

required

Publish restrictions for this binding

boolean

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_mapping",
  "properties": {
    "mapping_kind": "room_type"
  },
  "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).