Skip to content

Create Channel

Creates a new channel (storefront). The code must be unique. Top-level translatable scalars (name, description, the SEO fields, maintenanceModeText) are broadcast to every locale you assign, so a brand-new channel comes back with a translations entry per assigned locale.

Operation

OperationTypePurpose
createAdminSettingsChannel(input:)MutationCreate a channel

Required input

FieldMeaning
codeUnique channel code.
nameChannel display name (broadcast to every assigned locale).
localesNon-empty array of locale ids assigned to this channel.
currenciesNon-empty array of currency ids assigned to this channel.
inventorySourcesNon-empty array of inventory-source ids.
defaultLocaleIdDefault locale — must be one of locales.
baseCurrencyIdBase currency — must be one of currencies.
rootCategoryIdRoot category for the channel's catalog tree.

Optional: hostname, description, timezone, theme, allowedIps, and the SEO triplet seoTitle / seoDescription / seoKeywords (which is rolled into homeSeo).

Notes

  • The create mutation payload returns the channel's scalar fields, the SEO triplet (seoMetaTitle / seoMetaDescription / seoMetaKeywords + the homeSeo object). The nested connections (locales / currencies / inventorySources / translations) are not resolved in a mutation payload — re-query adminSettingsChannel(id:) with the returned _id to read them.

Logo / favicon upload deferred

The logo and favicon fields accept an already-uploaded path string only. Direct binary image upload is not yet supported over GraphQL.

Released under the MIT License.