collections

Returns a paginated list of the shop's collections. Each Collection object includes a nested connection to its products.

Use it in a workflow

Add a step and choose the Shopify Storefront 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) {
  collections(
    first: $first
    after: $after
    last: $last
    before: $before
    reverse: $reverse
    sortKey: $sortKey
    query: $query
  ) {
    edges {
      cursor
      node {
        descriptionHtml
        handle
        id
        image
        onlineStoreUrl
        seo
        title
        trackingParameters
        updatedAt
      }
    }
    nodes {
      descriptionHtml
      handle
      id
      image {
        altText
        height
        id
        originalSrc
        src
        thumbhash
        width
      }
      onlineStoreUrl
      seo {
        description
        title
      }
      title
      trackingParameters
      updatedAt
    }
    pageInfo {
      endCursor
      hasNextPage
      hasPreviousPage
      startCursor
    }
    totalCount
  }
}

Variables

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

firstnumber

Returns up to the first `n` elements from the list.

afterstring

Returns the elements that come after the specified cursor.

lastnumber

Returns up to the last `n` elements from the list.

beforestring

Returns the elements that come before the specified cursor.

reverseboolean

Reverse the order of the underlying list.

sortKeystring

Sort the underlying list by the given key.

One ofTITLEUPDATED_ATIDRELEVANCE

querystring

Apply one or multiple filters to the query. | name | description | acceptable_values | default_value | example_use | | ---- | ---- | ---- | ---- | ---- | | collection_type | | title | | updated_at | Refer to the detailed [search syntax](https://shopify.dev/api/usage/search-syntax) for more information about using filters.

json

{
  "first": 0,
  "after": "string",
  "last": 0,
  "before": "string",
  "reverse": false,
  "sortKey": "TITLE",
  "query": "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>

descriptionHtmlobject

handleobject

idobject

imageobject

onlineStoreUrlobject

seoobject

titleobject

trackingParametersobject

updatedAtobject

pageInfoobject

endCursorstring

hasNextPageboolean

hasPreviousPageboolean

startCursorstring

totalCountstring

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

Was this page helpful?