collections

Retrieves a list of collections in a store. Collections are groups of products that merchants can organize for display in their online store and other sales channels.

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the collections action (under Collections).
Fill in the fields below, then reference the result from later steps as {{collections.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 Collections($first: Int, $after: String, $last: Int, $before: String, $reverse: Boolean, $sortKey: CollectionSortKeys, $query: String, $savedSearchId: ID) {
  collections(
    first: $first
    after: $after
    last: $last
    before: $before
    reverse: $reverse
    sortKey: $sortKey
    query: $query
    savedSearchId: $savedSearchId
  ) {
    edges {
      cursor
      node {
        activeOperations
        availablePublicationsCount
        descriptionHtml
        feedback
        handle
        id
        legacyResourceId
        productsCount
        publishedOnCurrentChannel
        publishedOnCurrentPublication
        ruleSet
        seo
        sortOrder
        sources
        storefrontId
        subCollectionEligibility
        templateSuffix
        title
        updatedAt
      }
    }
    nodes {
      activeOperations {
        duplicate
      }
      availablePublicationsCount {
        count
        precision
      }
      descriptionHtml
      feedback {
        appFeedback
        details
        summary
      }
      handle
      id
      legacyResourceId
      productsCount {
        count
        precision
      }
      publishedOnCurrentChannel
      publishedOnCurrentPublication
      ruleSet {
        appliedDisjunctively
        rules
      }
      seo {
        description
        title
      }
      sortOrder
      sources {
        app
        description
        id
        title
      }
      storefrontId
      subCollectionEligibility {
        exclusion
        inclusion
      }
      templateSuffix
      title
      updatedAt
    }
    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.

sortKeystring

Sort the underlying list using a key. If your query is slow or returns an error, then [try specifying a sort key that matches the field used in the search](https://shopify.dev/api/usage/pagination-graphql#search-performance-considerations).

One ofIDRELEVANCETITLEUPDATED_AT

querystring

A filter made up of terms, connectives, modifiers, and comparators. | name | type | description | acceptable_values | default_value | example_use | | ---- | ---- | ---- | ---- | ---- | ---- | | default | string | Filter by a case-insensitive search of multiple fields in a document. | | | - `query=Bob Norman` - `query=title:green hoodie` | | collection_type | string | | - `custom` - `smart` | | handle | string | | id | id | Filter by `id` range. | | | - `id:1234` - `id:>=1234` - `id:<=1234` | | product_id | id | Filter by collections containing a product by its ID. | | 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](https://shopify.dev/api/admin-graphql/latest/objects/Channel#field-Channel.fields.app) (`Channel.app.id`) and one of the valid values. For simple visibility checks, use [published_status](https://shopify.dev/api/admin-graphql/latest/queries/products#argument-query-filter-published_status) instead. | - `* {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` | | - `product_publication_status:189769876-approved` | | publishable_status | string | **Deprecated:** This parameter is deprecated as of 2025-12 and will be removed in a future API version. Use [published_status](https://shopify.dev/api/admin-graphql/latest/queries/products#argument-query-filter-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](https://shopify.dev/api/admin-graphql/latest/objects/Channel#field-Channel.fields.app) (`Channel.app.id`) and one of the valid status values. | - `* {channel_app_id}-unset` - `* {channel_app_id}-pending` - `* {channel_app_id}-approved` - `* {channel_app_id}-not_approved` | | - `publishable_status:580111-unset` - `publishable_status:580111-pending` | | published_at | time | Filter by the date and time when the collection was published to the Online Store. | | 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](https://shopify.dev/api/admin-graphql/latest/objects/Channel#field-Channel.fields.app) (`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. The `online_store_channel` value applies only to the online store; other channels use the suffix format above. For example, the Point of Sale channel has the app handle `pos` and the `Channel.app.id` `129785`, so `pos-published` and `129785-published` both return resources published to Point of Sale. Other: - `unavailable`: Returns resources not published to any channel. | - `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` | | - `published_status:online_store_channel` - `published_status:published` - `published_status:580111-published` - `published_status:580111-hidden` - `published_status:pos-published` - `published_status:129785-published` - `published_status:my-channel-handle-published` - `published_status:unavailable` | | title | string | | updated_at | time | You can apply one or more filters to a query. Learn more about [Shopify API search syntax](https://shopify.dev/api/usage/search-syntax).

savedSearchIdstring

The ID of a [saved search](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch#field-id). The search’s query string is used as the query argument.

json

{
  "first": 0,
  "after": "string",
  "last": 0,
  "before": "string",
  "reverse": false,
  "sortKey": "ID",
  "query": "string",
  "savedSearchId": "string"
}

Response

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

edgesarray<object>

cursorobject

nodeobject

nodesarray<object>

activeOperationsobject

availablePublicationsCountobject

descriptionHtmlobject

feedbackobject

handleobject

idobject

legacyResourceIdobject

productsCountobject

publishedOnCurrentChannelobject

publishedOnCurrentPublicationobject

ruleSetobject

seoobject

sortOrderobject

sourcesobject

storefrontIdobject

subCollectionEligibilityobject

templateSuffixobject

titleobject

updatedAtobject

pageInfoobject

endCursorstring

hasNextPageboolean

hasPreviousPageboolean

startCursorstring

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

Was this page helpful?