Skip to main content

Channels

A channel is where a sale or a change comes from: the website, the mobile app, the contact centre, the advisor portal, the onboard point of sale. In the order engine a channel is a code in the orchestration configuration. Every quotation and purchase order records its channel, and the configuration uses channels to decide what can be sold where and which fields are required.

Registering a channel​

Add the code to channels in the orchestration configuration and publish a new version:

  1. GET /order-orchestration/config to read the current document and version.
  2. POST /order-orchestration/config/validate with the new document to check it.
  3. PUT /order-orchestration/config with the document, expectedVersion, actor and reason.

The channel registration guide shows the calls with captured responses. A quotation or purchase order on a code that is not registered is refused with 422 unknown_channel.

What a channel controls​

SettingWhere in the configurationEffect
Required quotation fieldsquotations.required_fields.by_channelFor example the agency channel requires agencyRef; a quotation without it gets 422 missing_fields.
Products sold on the channelline_availabilityA product type listed there is sold only on its channels; elsewhere 422 not_available_on_channel.
Execution ownershipownership_rules[].when.channelA rule can route a channel's lines to a specific system.
Connected-system channelssystems[].channelsWhich channels a connected system serves.

Channels and identity​

The channel is a business attribute, not an authentication boundary. Each channel application or integration calls the API with a tenant token (see Authentication) and states its channel on each record.

Not available

There is no channel resource with its own credentials or capability flags; registration is a configuration change. See Availability.