collectionByHandle - storefront - QUERY

Version: 2024-04

Description:

Find a collection by its handle.

Access Scopes

Arguments

• handle: String! - The handle of the collection.

Returns

• description: String! Stripped description of the collection, single line with HTML tags removed.
• descriptionHtml: HTML! The description of the collection, complete with HTML formatting.
• handle: String! A human-friendly unique string for the collection automatically generated from its title. Limit of 255 characters.
• id: ID! A globally-unique ID.
• image: Image Image associated with the collection.
• metafield: Metafield Returns a metafield found by namespace and key.
• metafields: Metafield! The metafields associated with the resource matching the supplied list of namespaces and keys.
• onlineStoreUrl: 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.
• seo: SEO! The collection's SEO information.
• title: String! The collection’s name. Limit of 255 characters.
• trackingParameters: String URL parameters to be added to a page URL to track the origin of on-site search traffic for [analytics reporting](https://help.shopify.com/manual/reports-and-analytics/shopify-reports/report-types/default-reports/behaviour-reports). Returns a result when accessed through the [search](https://shopify.dev/docs/api/storefront/current/queries/search) or [predictiveSearch](https://shopify.dev/docs/api/storefront/current/queries/predictiveSearch) queries, otherwise returns null.
• updatedAt: DateTime! The date and time when the collection was last modified.

Examples