Skip to main content

Start building a sales channel app

To build a sales channel app, you need to scaffold an app and turn it into a sales channel app.


After finishing this tutorial, you'll know how to do the following tasks:

  • Turn an app into a sales channel app
  • Add the channel config extension to your app
  • Define channel specifications for your app


Anchor to Step 1: Create a public appStep 1: Create a public app

Create a public app by scaffolding with Shopify CLI or creating an app in the Dev Dashboard.


Anchor to Step 2: Add the channel config extensionStep 2: Add the channel config extension

From your app's root directory, declare your app as a sales channel by adding the channel config extension using Shopify CLI:

Terminal

shopify app generate extension --template channel_config --name channel-config

This creates a channel-config extension in your app's extensions/ directory. The extension includes a shopify.extension.toml configuration file and a specifications/ folder where you define your channel specifications.

Deploy the extension to register your app as a sales channel:

Terminal

shopify app deploy

After deploying, you can install the app on your dev store through the CLI or the Dev Dashboard.

For more details on configuring the extension and writing channel specifications, refer to Channel config extension.


Anchor to Step 3: Define channel specificationsStep 3: Define channel specifications

After generating the extension, add one or more channel specifications to the specifications/ directory to describe your channel's supported countries, languages, currencies, and capabilities.

For details on writing specifications, refer to Channel config extension.

Note

If you're migrating an existing sales channel app that was previously declared through the Partner Dashboard, follow Migrating to a multi-channel app.


Was this page helpful?