channels

Channels are defined in the registry and used throughout the system. Refer to Dimensions for more info.

Each channel must have a unique key that can only contain a-z 0-9 and _. And the first character has to be non-numeric.

Properties

Property	Type	Description
label	string or object	Display label for the channel. Can be a simple string or a localized object with locale keys (e.g., default, sv).
inventories	string[]	Inventory keys available for this channel. When set, only these inventories can be selected on deliveries for orders on this channel. If omitted or empty, all inventories are available.
countries	object	Map of ISO 3166-1 alpha-2 country codes (uppercase) to per-country data objects. When set, only these countries are shown in address forms for this channel. If omitted or empty, all countries are available. Each country value is an object for app-provided fields; use {} for a country with no custom fields.

Additional properties may be added by installed apps. Inside countries, all fields on the per-country object are app-provided.

Channels automatically provide enum values for channelKey fields on orders and tickets. The label is used as the dropdown display text. Custom graph fields may use channels too by specifying values: "channels".

Example

uri: /registry/channels/b2c
spec:
  value:
    label: B2C Webshop
    inventories:
      - warehouse-stockholm
      - warehouse-gothenburg
    countries:
      SE: {}
      NO: {}
      DK: {}

With localization:

uri: /registry/channels/b2b
spec:
  value:
    label:
      default: B2B Portal
      sv: B2B-portalen