Skip to content
← Back to Index

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

PropertyTypeDescription
labelstring or objectDisplay label for the channel. Can be a simple string or a localized object with locale keys (e.g., default, sv).

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

yaml
uri: /registry/channels/b2c
spec:
  value:
    label: B2C Webshop

With localization:

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

© 2024 Hantera AB. All rights reserved.