Skip to main content
Anchor to collection

collection

query

Fetch a specific Collection by one of its unique attributes.

Anchor to Arguments

Arguments

Anchor to handlehandle
•String

The handle of the Collection.

Anchor to idid
•ID

The ID of the Collection.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to CollectionCollection
•Collection

A collection represents a grouping of products that a shop owner can create to organize them or make their shops easier to browse.

Anchor to descriptiondescription
•String!
non-null

Stripped description of the collection, single line with HTML tags removed.

Arguments

Anchor to truncateAttruncateAt
•Int

Truncates a string after the given length.

Anchor to descriptionHtmldescriptionHtml
•HTML!
non-null

The description of the collection, complete with HTML formatting.

Anchor to handlehandle
•String!
non-null

A human-friendly unique string for the collection automatically generated from its title. Limit of 255 characters.

Anchor to idid
•ID!
non-null

A globally-unique ID.

Anchor to imageimage
•Image

Image associated with the collection.

Anchor to metafieldmetafield
•Metafield

A custom field, including its namespace and key, that's associated with a Shopify resource for the purposes of adding and storing additional information.

Arguments

Anchor to namespacenamespace
•String

The container the metafield belongs to. If omitted, the app-reserved namespace will be used.

Anchor to keykey
•String!
required

The identifier for the metafield.

Anchor to metafieldsmetafields
•[Metafield]!
non-null

A list of custom fields that a merchant associates with a Shopify resource.

Arguments

Anchor to identifiersidentifiers
•[HasMetafieldsIdentifier!]!
required

The list of metafields to retrieve by namespace and key.

The input must not contain more than 250 values.

Anchor to onlineStoreUrlonlineStoreUrl
•URL

The URL used for viewing the resource on the shop's Online Store. Returns null if the resource is currently not published to the Online Store sales channel.

Anchor to productsproducts
•ProductConnection!
non-null

List of products in the collection.

Arguments

Anchor to firstfirst
•Int

Returns up to the first n elements from the list.

Anchor to afterafter
•String

Returns the elements that come after the specified cursor.

Anchor to lastlast
•Int

Returns up to the last n elements from the list.

Anchor to beforebefore
•String

Returns the elements that come before the specified cursor.

Anchor to reversereverse
•Boolean
Default:false

Reverse the order of the underlying list.

Anchor to sortKeysortKey
•ProductCollectionSortKeys
Default:COLLECTION_DEFAULT

Sort the underlying list by the given key.

Anchor to filtersfilters
•[ProductFilter!]

Returns a subset of products matching all product filters.

The input must not contain more than 250 values.

Anchor to seoseo
•SEO!
non-null

The collection's SEO information.

Anchor to titletitle
•String!
non-null

The collection’s name. Limit of 255 characters.

Anchor to trackingParameterstrackingParameters
•String

URL parameters to be added to a page URL to track the origin of on-site search traffic for analytics reporting. Returns a result when accessed through the search or predictiveSearch queries, otherwise returns null.

Anchor to updatedAtupdatedAt
•DateTime!
non-null

The date and time when the collection was last modified.

Was this section helpful?