Skip to main content
Anchor to channel

channel

query

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

Anchor to Arguments

Arguments

Anchor to idid
•ID!
required

The ID of the Channel to return.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to ChannelChannel
•Channel

A connection between a Shopify shop and an external selling platform that supports product syndication and optionally order ingestion. Each channel binds a merchant's account on a specific platform — such as Amazon, eBay, Google, or a point-of-sale system — to the shop, establishing the publishing destination for product feeds.

Sales Channel applications use channelCreate to establish channels after merchant authentication, and can manage multiple channel connections per app. Each channel is bound to a channel specification that declares the platform's regional coverage, capabilities, and requirements.

Use channels to manage where catalog items are syndicated, track publication status across platforms, and control Product visibility for different selling destinations.

Anchor to accountIdaccountId
•String

The unique account ID for the merchant on the external platform. This value is opaque to Shopify — its format is determined by the channel, such as an Amazon Seller ID or Google Merchant Center ID.

Anchor to accountNameaccountName
•String

The merchant-facing name for the external account. Displayed in Shopify Admin wherever the channel connection is referenced, such as in Markets and order attribution.

Anchor to appapp
•App!
non-null

The underlying app used by the channel.

Anchor to collectionPublicationsV3collectionPublicationsV3
•ResourcePublicationConnection!
non-null

The list of collection publications. Each record represents information about the publication of a collection.

Arguments

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to collectionscollections
•CollectionConnection!
non-null

The list of collections published to the channel.

Arguments

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to handlehandle
•String!
non-null

A unique, human-readable identifier for the channel within the shop. Set during channelCreate or auto-generated from the specification handle and account ID. Use with channelByHandle for lookups.

Anchor to hasCollectionhasCollection
•Boolean!
non-null

Whether the collection is available to the channel.

Arguments

Anchor to idid
•ID!
required

The collection ID to check.

Anchor to idid
•ID!
non-null

A globally-unique ID.

Anchor to namename
•String!
non-null

The name of the channel.

Anchor to productPublicationsV3productPublicationsV3
•ResourcePublicationConnection!
non-null

The list of product publication records for products published to this channel.

Arguments

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to productsproducts
•ProductConnection!
non-null

The list of products published to the channel.

Arguments

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to productsCountproductsCount
•Count

Retrieves the total count of products published to a specific sales channel. Limited to a maximum of 10000 by default.

Arguments

Anchor to queryquery
•String

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default
•string

Filter by a case-insensitive search of multiple fields in a document.

Example:

  • query=Bob Norman
  • query=title:green hoodie
Anchor to barcode
•string

Filter by the product variant barcode field.

Example:

  • barcode:ABC-abc-1234
Anchor to bundles
•boolean

Filter by a product bundle. A product bundle is a set of two or more related products, which are commonly offered at a discount.

Example:

  • bundles:true
Anchor to category_id
•string

Filter by the product category ID (product.category.id). A product category is the category of a product from Shopify's Standard Product Taxonomy.

Example:

  • category_id:sg-4-17-2-17
Anchor to collection_id
•id

Filter by the collection id field.

Example:

  • collection_id:108179161409
Anchor to combined_listing_role
•string

Filter by the role of the product in a combined listing.

Valid values:

  • parent
  • child
  • no_role

Example:

  • combined_listing_role:parent
Anchor to created_at
•time

Filter by the date and time when the product was created.

Example:

  • created_at:>'2020-10-21T23:39:20Z'
  • created_at:<now
  • created_at:<='2024'
Anchor to delivery_profile_id
•id

Filter by the delivery profile id field.

Example:

  • delivery_profile_id:108179161409
Anchor to error_feedback
•string

Filter by products with publishing errors.

Anchor to gift_card
•boolean

Filter by the product isGiftCard field.

Example:

  • gift_card:true
Anchor to handle
•string

Filter by a comma-separated list of product handles.

Example:

  • handle:the-minimal-snowboard
Anchor to has_only_composites
•boolean

Filter by products that have only composite variants.

Example:

  • has_only_composites:true
Anchor to has_only_default_variant
•boolean

Filter by products that have only a default variant. A default variant is the only variant if no other variants are specified.

Example:

  • has_only_default_variant:true
Anchor to has_variant_with_components
•boolean

Filter by products that have variants with associated components.

Example:

  • has_variant_with_components:true
Anchor to id
•id

Filter by id range.

Example:

  • id:1234
  • id:>=1234
  • id:<=1234
Anchor to inventory_total
•integer

Filter by inventory count.

Example:

  • inventory_total:0
  • inventory_total:>150
  • inventory_total:>=200
Anchor to is_price_reduced
•boolean

Filter by products that have a reduced price. For more information, refer to the CollectionRule object.

Example:

  • is_price_reduced:true
Anchor to metafields.{namespace}.{key}
•mixed

Filters resources by metafield value. Format: metafields.{namespace}.{key}:{value}. Learn more about querying by metafield value.

Example:

  • metafields.custom.on_sale:true
  • metafields.product.material:"gid://shopify/Metaobject/43458085"
Anchor to out_of_stock_somewhere
•boolean

Filter by products that are out of stock in at least one location.

Example:

  • out_of_stock_somewhere:true
Anchor to price
•bigdecimal

Filter by the product variant price field.

Example:

  • price:100.57
Anchor to product_configuration_owner
•string

Filter by the app id field.

Example:

  • product_configuration_owner:10001
Anchor to product_publication_status
•string

Filter by channel approval process status of the resource on a channel, such as the online store. The value is a composite of the channel app ID (Channel.app.id) and one of the valid values. For simple visibility checks, use published_status instead.

Valid values:

  • * {channel_app_id}-approved
  • * {channel_app_id}-rejected
  • * {channel_app_id}-needs_action
  • * {channel_app_id}-awaiting_review
  • * {channel_app_id}-published
  • * {channel_app_id}-demoted
  • * {channel_app_id}-scheduled
  • * {channel_app_id}-provisionally_published

Example:

  • product_publication_status:189769876-approved
Anchor to product_type
•string

Filter by a comma-separated list of product types.

Example:

  • product_type:snowboard
Anchor to publication_ids
•string

Filter by a comma-separated list of publication IDs that are associated with the product.

Example:

  • publication_ids:184111530305,184111694145
Anchor to publishable_status
•string

Deprecated: This parameter is deprecated as of 2025-12 and will be removed in a future API version. Use published_status for visibility checks. Filter by the publishable status of the resource on a channel. The value is a composite of the channel app ID (Channel.app.id) and one of the valid status values.

Valid values:

  • * {channel_app_id}-unset
  • * {channel_app_id}-pending
  • * {channel_app_id}-approved
  • * {channel_app_id}-not_approved

Example:

  • publishable_status:580111-unset
  • publishable_status:580111-pending
Anchor to published_at
•time

Filter by the date and time when the product was published to the online store and other sales channels.

Example:

  • published_at:>2020-10-21T23:39:20Z
  • published_at:<now
  • published_at:<=2024
Anchor to published_status
•string

Filter resources by their visibility and publication state on a channel. Online store channel filtering: - online_store_channel: Returns all resources in the online store channel, regardless of publication status. - published/visible: Returns resources that are published to the online store. - unpublished: Returns resources that are not published to the online store. Channel-specific filtering using a channel ID, channel handle, channel app ID (Channel.app.id), or app handle with suffixes: - {id_or_handle}-published: Returns resources published to the specified channel. - {id_or_handle}-visible: Same as {id_or_handle}-published (kept for backwards compatibility). - {id_or_handle}-intended: Returns resources added to the channel but not yet published. - {id_or_handle}-hidden: Returns resources not added to the channel or not published. Other: - unavailable: Returns resources not published to any channel.

Valid values:

  • online_store_channel
  • published
  • visible
  • unpublished
  • * {channel_id_or_handle}-published
  • * {channel_id_or_handle}-visible
  • * {channel_id_or_handle}-intended
  • * {channel_id_or_handle}-hidden
  • * {channel_app_id_or_handle}-published
  • * {channel_app_id_or_handle}-visible
  • * {channel_app_id_or_handle}-intended
  • * {channel_app_id_or_handle}-hidden
  • unavailable

Example:

  • published_status:online_store_channel
  • published_status:published
  • published_status:580111-published
  • published_status:580111-hidden
  • published_status:my-channel-handle-published
  • published_status:unavailable
Anchor to sku
•string

Filter by the product variant sku field. Learn more about SKUs.

Example:

  • sku:XYZ-12345
Anchor to status
•string

Filter by a comma-separated list of statuses. You can use statuses to manage inventory. Shopify only displays products with an ACTIVE status in online stores, sales channels, and apps.

Valid values:

  • active Default
  • archived
  • draft

Example:

  • status:active,draft
Anchor to tag
•string

Filter objects by the tag field.

Example:

  • tag:my_tag
Anchor to tag_not
•string

Filter by objects that don’t have the specified tag.

Example:

  • tag_not:my_tag
Anchor to title
•string

Filter by the product title field.

Example:

  • title:The Minimal Snowboard
Anchor to tracks_inventory
•boolean

Filter by products that have inventory tracking enabled.

Example:

  • tracks_inventory:true
Anchor to updated_at
•time

Filter by the date and time when the product was last updated.

Example:

  • updated_at:>'2020-10-21T23:39:20Z'
  • updated_at:<now
  • updated_at:<='2024'
Anchor to variant_id
•id

Filter by the product variant id field.

Example:

  • variant_id:45779434701121
Anchor to variant_title
•string

Filter by the product variant title field.

Example:

  • variant_title:'Special ski wax'
Anchor to vendor
•string

Filter by the origin or source of the product. Learn more about vendors and managing vendor information.

Example:

  • vendor:Snowdevil
  • vendor:Snowdevil OR vendor:Icedevil
Anchor to limitlimit
•Int
Default:10000

The upper bound on count value before returning a result. Use null to have no limit.

Anchor to resourceFeedbackresourceFeedback
•AppFeedback

The resource feedback for the channel. Returns null when no active feedback exists—for example, after shopResourceFeedbackCreate is called with state: ACCEPTED, which clears the feedback signal. A null result is expected and means the channel has no outstanding feedback.

Anchor to specificationHandlespecificationHandle
•String

The handle of the channel specification bound to this channel. The specification declares the channel's regional coverage, capabilities, and requirements, and is deployed by the Sales Channel application via shopify app deploy.

Anchor to supportsFuturePublishingsupportsFuturePublishing
•Boolean!
non-null

Whether the channel supports future publishing.

Anchor to navigationItemsnavigationItems
•[NavigationItem!]!
non-nullDeprecated
Anchor to overviewPathoverviewPath
•URL
Deprecated
Anchor to productPublicationsproductPublications
•ProductPublicationConnection!
non-nullDeprecated

Arguments

Anchor to firstfirst
•Int

The first n elements from the paginated list.

Anchor to afterafter
•String

The elements that come after the specified cursor.

Anchor to lastlast
•Int

The last n elements from the paginated list.

Anchor to beforebefore
•String

The elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Was this section helpful?