channel

Returns a Channel by ID. The channel must belong to the calling application.

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the channel action (under Channel).
Fill in the fields below, then reference the result from later steps as {{channel.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 Channel($id: ID!) {
  channel(id: $id) {
    accountId
    accountName
    activeRegions
    app {
      apiKey
      appStoreAppUrl
      appStoreDeveloperUrl
      availableAccessScopes {
        description
        handle
      }
      banner {
        altText
        height
        id
        originalSrc
        src
        thumbhash
        width
      }
      description
      developerName
      developerType
      developerUrl
      embedded
      failedRequirements {
        action
        message
      }
      features
      feedback {
        app
        channel
        feedbackGeneratedAt
        link
        messages
        state
      }
      handle
      icon {
        altText
        height
        id
        originalSrc
        src
        thumbhash
        width
      }
      id
      installUrl
      installation {
        accessScopes
        activeSubscriptions
        app
        channel
        id
        launchUrl
        publication
        subscriptions
        uninstallUrl
      }
      isPostPurchaseAppInUse
      launchUrl
      navigationItems {
        id
        title
        url
      }
      optionalAccessScopes {
        description
        handle
      }
      previouslyInstalled
      pricingDetails
      pricingDetailsSummary
      privacyPolicyUrl
      publicCategory
      published
      requestedAccessScopes {
        description
        handle
      }
      screenshots {
        altText
        height
        id
        originalSrc
        src
        thumbhash
        width
      }
      shopifyDeveloped
      title
      uninstallMessage
      uninstallUrl
      webhookApiVersion
    }
    handle
    id
    marketsCount {
      count
      precision
    }
    name
    navigationItems {
      id
      title
      url
    }
    overviewPath
    resourceFeedback {
      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
      }
      channel
      feedbackGeneratedAt
      link {
        label
        url
      }
      messages {
        field
        message
      }
      state
    }
    specificationHandle
    supportsFuturePublishing
  }
}

Variables

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

idstringrequired

The ID of the [`Channel`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Channel) to return.

json

{
  "id": "string"
}

Response

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

accountIdstring

accountNamestring

activeRegionsarray<string>

appobject

apiKeystring

appStoreAppUrlstring

appStoreDeveloperUrlstring

availableAccessScopesarray<object>

bannerobject7 fields

descriptionstring

developerNamestring

developerTypestring

One ofSHOPIFYPARTNERMERCHANTUNKNOWN

developerUrlstring

embeddedboolean

failedRequirementsarray<object>

featuresarray<object>

feedbackobject6 fields

handlestring

iconobject7 fields

idstring

installUrlstring

installationobject9 fields

isPostPurchaseAppInUseboolean

launchUrlstring

navigationItemsarray<object>

optionalAccessScopesarray<object>

previouslyInstalledboolean

pricingDetailsstring

pricingDetailsSummarystring

privacyPolicyUrlstring

publicCategorystring

One ofPRIVATEPUBLICCUSTOMOTHER

publishedboolean

requestedAccessScopesarray<object>

screenshotsarray<object>

shopifyDevelopedboolean

titlestring

uninstallMessagestring

uninstallUrlstring

webhookApiVersionstring

handlestring

idstring

marketsCountobject

countnumber

precisionstring

One ofEXACTAT_LEAST

namestring

navigationItemsarray<object>

idobject

titleobject

urlobject

overviewPathstring

resourceFeedbackobject

appobject35 fields

channelobject

Recursive reference to Channel, not further expanded.

feedbackGeneratedAtstring

linkobject2 fields

messagesarray<object>

statestring

One ofACCEPTEDREQUIRES_ACTION

specificationHandlestring

supportsFuturePublishingboolean

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

Was this page helpful?