Choose a version:

channelCreate

mutation

Creates a Channel representing a connection between the shop and an external selling platform account. Use this mutation after a merchant authenticates with an external platform to establish the publishing destination for product syndication and, for order-generating channels, order import.

The platform resolves the channel specification identified by specificationHandle, determines its country coverage, intersects with the shop's available region markets, and establishes product feeds for all matching regions. Product feeds immediately begin emitting events to the application's webhook or event subscription.

If the specification sets expects_online_store_parity and no matching region markets exist, the mutation returns an error. If the specification doesn't require online store parity and no matching region markets exist, a channel subordinate to shop defaults is created automatically.

Anchor to Arguments

Arguments

Anchor to inputinput

•ChannelCreateInput!

required

The input fields for creating the channel.

Was this section helpful?

Anchor to ChannelCreatePayload returnsChannelCreatePayload returns

Anchor to channelchannel •Channel: The channel that was created.
Anchor to userErrorsuserErrors •[ChannelCreateUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

channelCreate reference

Mutation Reference

mutation channelCreate($input: ChannelCreateInput!) {

channelCreate(input: $input) {

channel {

# Channel fields

}

userErrors {

field

message

}

Input

{

"input": {

"accountId": "<your-accountId>",

"accountName": "<your-accountName>",

"handle": "<your-handle>",

"specificationHandle": "<your-specificationHandle>"

}

Variables

{
  "input": {
    "accountId": "<your-accountId>",
    "accountName": "<your-accountName>",
    "handle": "<your-handle>",
    "specificationHandle": "<your-specificationHandle>"
  }
}

Schema

input ChannelCreateInput {
  accountId: String!
  accountName: String!
  handle: String
  specificationHandle: String!
}