Skip to main content
Shopify.devShopify.devDocs
Log inSign up
Anchor to collections

collections

query

Returns a list of collections.

Anchor to Arguments

CollectionConnection arguments

•CollectionConnection!
Anchor to afterafter
•
String

The elements that come after the specified cursor.

Anchor to beforebefore
•
String

The elements that come before the specified cursor.

Anchor to firstfirst
•
Int

The first n elements from the paginated list.

Anchor to lastlast
•
Int

The last n elements from the paginated list.

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 collection_type
•
string

Valid values:

  • custom
  • smart
Anchor to handle
•
string
Anchor to id
•
id

Filter by id range.

Example:

  • id:1234
  • id:>=1234
  • id:<=1234
Anchor to product_id
•
id

Filter by collections containing a product by its ID.

Anchor to product_publication_status
•
string

Filter by the publishable 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.

Valid values:

  • approved
  • rejected
  • needs_action
  • awaiting_review
  • published
  • demoted
  • scheduled
  • provisionally_published

Example:

  • publishable_status:189769876-approved
Anchor to publishable_status
•
string

Filter by the publishable status of the resource on a channel, such as the online store. The value is a composite of either the channel app ID (Channel.app.id) or channel name and one of the valid values.

Valid values:

  • online_store_channel
  • published
  • unpublished
  • visible
  • unavailable
  • hidden
  • intended
  • visible

Example:

  • publishable_status:published
  • publishable_status:189769876:visible
  • publishable_status:pos:hidden
Anchor to published_at
•
time

Filter by the date and time when the collection was published to the Online Store.

Anchor to published_status
•
string

Filter by the published status of the resource on a channel, such as the online store.

Valid values:

  • unset
  • pending
  • approved
  • not approved

Example:

  • published_status:approved
Anchor to title
•
string
Anchor to updated_at
•
time
Anchor to reversereverse
•
BooleanDefault:false

Reverse the order of the underlying list.

Anchor to savedSearchIdsavedSearchId
•
ID

The ID of a saved search. The search’s query string is used as the query argument.

Anchor to sortKeysortKey
•
CollectionSortKeysDefault:ID

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.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to edgesedges
•
[CollectionEdge!]!non-null

The connection between the node and its parent. Each edge contains a minimum of the edge's cursor and the node.

Anchor to nodesnodes
•
[Collection!]!non-null

A list of nodes that are contained in CollectionEdge. You can fetch data about an individual node, or you can follow the edges to fetch data about a collection of related nodes. At each node, you specify the fields that you want to retrieve.

Anchor to pageInfopageInfo
•
PageInfo!non-null

An object that’s used to retrieve cursor information about the current page.

Was this section helpful?