Interface GraphQLMissingRoleOnChannelError

Returned when one of the following states occur:

- [Channel](ctp:api:type:Channel) is added or set on a [Store](ctp:api:type:Store) with missing Channel `roles`.
- [Standalone Price](/../api/projects/standalone-prices#create-standaloneprice) references a Channel that does not contain the `ProductDistribution` role.

The error is returned as a failed response to:

- [Add Distribution Channel](ctp:api:type:StoreAddDistributionChannelAction), [Set Distribution Channel](ctp:api:type:StoreSetDistributionChannelsAction), [Add Supply Channel](ctp:api:type:StoreAddSupplyChannelAction), and [Set Supply Channel](ctp:api:type:StoreSetSupplyChannelsAction) update actions.
- [Create a Standalone Price](/../api/projects/standalone-prices#create-standaloneprice) request.
interface GraphQLMissingRoleOnChannelError {
    channel?: ChannelResourceIdentifier;
    code: "MissingRoleOnChannel";
    missingRole: string;
    [key: string]: any;
}

Indexable

[key: string]: any

Properties

channel? code missingRole

Properties

Optional Readonly channel

channel?: ChannelResourceIdentifier

ResourceIdentifier to a given Channel.

Readonly code

code: "MissingRoleOnChannel"

Readonly missingRole

missingRole: string
  • ProductDistribution for Product Distribution Channels allowed for the Store. Also required for Standalone Prices.
    • InventorySupply for Inventory Supply Channels allowed for the Store.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc