Skip to content
aerandil.com
GitHub

Read Channel connection

GET
/v1/object-types/hospitality.channel_connection/objects/{id}
curl --request GET \
  --url https://api.aerandil.com/v1/object-types/hospitality.channel_connection/objects/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

Read an existing instance.

One conduit between a property and a distribution partner — a channel manager, an OTA switch, or a partner that subscribed to our ARI. Identity, wire dialect and lifecycle only: credentials live in the secret store (secret_ref is a name, never a value), the per-date publication outbox lives in Postgres, and the demand channels the conduit carries are linked, not inlined. A conduit is not a channel — one connection fronts Booking.com, Expedia and dozens more, each of which stays its own channel row with its own commission period.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string format: uuid

Object id (UUID v7, server-generated at create time).

Query Parameters

Section titled “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

Section titled “Responses”

200

Section titled “200”

Object found.

Media typeapplication/json
object
created_at
required
string format: date-time
id
required
string format: uuid
object_type
required
Allowed value: hospitality.channel_connection
properties
required
object
ari_endpoint_url
HTTPS endpoint we publish ARI into
string
display_name
required
Human-readable name shown in the Explorer
string
horizon_days
required
Days forward from today that ARI is published for
integer
id
required
Connection id
string
last_full_publication_at
When a full (non-delta) publication last ran — gates the next one
string format: date-time
notes
Free-form operator notes
string
owner_client_ref
Client that registered this subscription (subscription provisioning only)
string
partner_code
The partner's identifier for our system (SiteMinder RequestorID / pmsCode)
string
paused_reason
Why publication is stopped (required while status = paused or suspended)
string
price_basis
required
Whether published amounts are gross, net, or both
string
Allowed values: gross net gross_and_net
property_code
The partner's identifier for this property (SiteMinder HotelCode)
string
protocol
required
Wire dialect this conduit speaks
string
Allowed values: pmsx_ota_2003_05 mews_chm_v1 aerandil_ari_v1 other
provider
required
Partner identifier (siteminder / d_edge / derbysoft / …)
string
provisioning
required
Who stood the conduit up (we call them, or they subscribed to us)
string
Allowed values: partner_hosted subscription
rate_model
required
Published rate model — fixed per conduit, never per property
string
Allowed values: per_day occupancy_based
registered_at
required
When the connection was opened
string format: date-time
registered_by
required
Principal::stable_id() of the registering principal
string
reservation_delivery
required
How reservations reach us from the partner
string
Allowed values: partner_push we_pull none
secret_ref
Name of the credential in the external secret store (never the value)
string
status
required
Connection lifecycle status
string
Allowed values: pending_mapping active paused suspended closed
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_connection",
  "properties": {
    "price_basis": "gross",
    "protocol": "pmsx_ota_2003_05",
    "provisioning": "partner_hosted",
    "rate_model": "per_day",
    "reservation_delivery": "partner_push",
    "status": "pending_mapping"
  },
  "scope": {
    "level": "tenant"
  }
}

Headers

Section titled “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

Section titled “404”

No object with that id (or soft-deleted).