Skip to main content
View Markdown

ChannelCreateInput Input Type

No description

input ChannelCreateInput {
  isActive: Boolean
  stockSettings: StockSettingsInput
  addShippingZones: [ID!]
  addWarehouses: [ID!]
  orderSettings: OrderSettingsInput
  metadata: [MetadataInput!]
  privateMetadata: [MetadataInput!]
  checkoutSettings: CheckoutSettingsInput
  paymentSettings: PaymentSettingsInput
  name: String!
  slug: String!
  currencyCode: String!
  defaultCountry: CountryCode!
}

Fields​

isActive ● Boolean​

Determine if channel will be set active or not.

stockSettings ● StockSettingsInput​

The channel stock settings.

addShippingZones ● [ID!]​

List of shipping zones to assign to the channel.

addWarehouses ● [ID!]​

List of warehouses to assign to the channel.

orderSettings ● OrderSettingsInput​

The channel order settings

metadata ● [MetadataInput!]​

Channel public metadata. Can be read by any API client authorized to read the object it's attached to.

Warning: never store sensitive information, including financial data such as credit card details.

privateMetadata ● [MetadataInput!]​

Channel private metadata. Requires permissions to modify and to read the metadata of the object it's attached to.

Warning: never store sensitive information, including financial data such as credit card details.

checkoutSettings ● CheckoutSettingsInput​

The channel checkout settings

paymentSettings ● PaymentSettingsInput​

The channel payment settings

name ● String!​

Name of the channel.

slug ● String!​

Slug of the channel.

currencyCode ● String!​

Currency of the channel.

defaultCountry ● CountryCode!​

Default country for the channel. Default country can be used in checkout to determine the stock quantities or calculate taxes when the country was not explicitly provided.

Member Of​

channelCreate mutation