collection - storefront - QUERY

Version: 2024-04

Description:

Fetch a specific `Collection` by one of its unique attributes.

Access Scopes

Arguments

• handle: String - The handle of the `Collection`.
• id: ID - The ID 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

• Retrieve a single collection by ID

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/api/2024-04/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Storefront-Access-Token: {storefront_access_token}' \\\n-d '{\n\"query\": \"query getCollectionById($id: ID!) { collection(id: $id) { title } }\"\n}'\n"
          Node example: "const client = new shopify.clients.Storefront({\n  domain: 'your-development-store.myshopify.com',\n  storefrontAccessToken,\n});\nconst data = await client.query({\n  data: `query getCollectionById($id: ID!) {\n    collection(id: $id) {\n      title\n    }\n  }`,\n});\n"
          Ruby example: null
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new ShopifyClientsStorefront(\"your-development-store.myshopify.com\", $storefrontAccessToken);\n$query = <<query([\"query\" => $query]);\n"
          Remix example: "const { storefront } = await unauthenticated.storefront(\n  'your-development-store.myshopify.com'\n);\n\nconst response = await storefront.graphql(\n  `#graphql\n  query getCollectionById($id: ID!) {\n    collection(id: $id) {\n      title\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
          Graphql query: "query getCollectionById($id: ID!) {\n  collection(id: $id) {\n    title\n  }\n}"
        

  input: null

  response: {
    "data": {
      "collection": {
        "title": "FrontPage"
      }
    }
  }

  Retrieve a single collection by handle

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/api/2024-04/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Storefront-Access-Token: {storefront_access_token}' \\\n-d '{\n\"query\": \"query getCollectionByHandle($handle: String!) { collection(handle: $handle) { title } }\"\n}'\n"
          Node example: "const client = new shopify.clients.Storefront({\n  domain: 'your-development-store.myshopify.com',\n  storefrontAccessToken,\n});\nconst data = await client.query({\n  data: `query getCollectionByHandle($handle: String!) {\n    collection(handle: $handle) {\n      title\n    }\n  }`,\n});\n"
          Ruby example: null
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new ShopifyClientsStorefront(\"your-development-store.myshopify.com\", $storefrontAccessToken);\n$query = <<query([\"query\" => $query]);\n"
          Remix example: "const { storefront } = await unauthenticated.storefront(\n  'your-development-store.myshopify.com'\n);\n\nconst response = await storefront.graphql(\n  `#graphql\n  query getCollectionByHandle($handle: String!) {\n    collection(handle: $handle) {\n      title\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
          Graphql query: "query getCollectionByHandle($handle: String!) {\n  collection(handle: $handle) {\n    title\n  }\n}"
        

  input: null

  response: {
    "data": {
      "collection": {
        "title": "FrontPage"
      }
    }
  }