channels

The list of Channel objects on the shop. When the calling application supports multi-channel, only channels established by the calling application are returned.

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the channels action (under Channels).
Fill in the fields below, then reference the result from later steps as {{channels.response.data}}.

Query

This is the query the action sends by default. Edit it in the step's Query field to change which fields come back.

graphql

query Channels($first: Int, $after: String, $last: Int, $before: String, $reverse: Boolean) {
  channels(
    first: $first
    after: $after
    last: $last
    before: $before
    reverse: $reverse
  ) {
    edges {
      cursor
      node {
        accountId
        accountName
        activeRegions
        app
        handle
        id
        marketsCount
        name
        navigationItems
        overviewPath
        resourceFeedback
        specificationHandle
        supportsFuturePublishing
      }
    }
    nodes {
      accountId
      accountName
      activeRegions
      app {
        apiKey
        appStoreAppUrl
        appStoreDeveloperUrl
        availableAccessScopes
        banner
        description
        developerName
        developerType
        developerUrl
        embedded
        failedRequirements
        features
        feedback
        handle
        icon
        id
        installUrl
        installation
        isPostPurchaseAppInUse
        launchUrl
        navigationItems
        optionalAccessScopes
        previouslyInstalled
        pricingDetails
        pricingDetailsSummary
        privacyPolicyUrl
        publicCategory
        published
        requestedAccessScopes
        screenshots
        shopifyDeveloped
        title
        uninstallMessage
        uninstallUrl
        webhookApiVersion
      }
      handle
      id
      marketsCount {
        count
        precision
      }
      name
      navigationItems {
        id
        title
        url
      }
      overviewPath
      resourceFeedback {
        app
        channel
        feedbackGeneratedAt
        link
        messages
        state
      }
      specificationHandle
      supportsFuturePublishing
    }
    pageInfo {
      endCursor
      hasNextPage
      hasPreviousPage
      startCursor
    }
  }
}

Variables

Pass these as a JSON object in the step's Variables field.

firstnumber

The first `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).

afterstring

The elements that come after the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).

lastnumber

The last `n` elements from the [paginated list](https://shopify.dev/api/usage/pagination-graphql).

beforestring

The elements that come before the specified [cursor](https://shopify.dev/api/usage/pagination-graphql).

reverseboolean

Reverse the order of the underlying list.

json

{
  "first": 0,
  "after": "string",
  "last": 0,
  "before": "string",
  "reverse": false
}

Response

Read the result with {{channels.response.data.data.channels}}. If the API returns errors, the step fails and they are at {{channels.response.data.errors}}.

edgesarray<object>

cursorobject

nodeobject

nodesarray<object>

accountIdobject

accountNameobject

activeRegionsobject

appobject

handleobject

idobject

marketsCountobject

nameobject

navigationItemsobject

overviewPathobject

resourceFeedbackobject

specificationHandleobject

supportsFuturePublishingobject

pageInfoobject

endCursorstring

hasNextPageboolean

hasPreviousPageboolean

startCursorstring

Need more? See the Shopify guide for connection setup and behaviour shared by every action.

Was this page helpful?