collections - storefront - QUERY

Version: 2024-07

Description:

List of the shop’s collections.

Access Scopes

Arguments

• after: String - Returns the elements that come after the specified cursor.
• before: String - Returns the elements that come before the specified cursor.
• first: Int - Returns up to the first `n` elements from the list.
• last: Int - Returns up to the last `n` elements from the list.
• query: String - 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.
• reverse: Boolean - Reverse the order of the underlying list.
• sortKey: CollectionSortKeys - Sort the underlying list by the given key.

Returns

• edges: CollectionEdge! A list of edges.
• nodes: Collection! A list of the nodes contained in CollectionEdge.
• pageInfo: PageInfo! Information to aid in pagination.
• totalCount: UnsignedInt64! The total count of Collections.

Examples

• Retrieve collections

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Storefront-Access-Token: {storefront_access_token}' \\\n-d '{\n\"query\": \"query { collections(first: 2) { edges { node { id products(first: 5) { edges { node { id } } } } } } }\"\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 {\n    collections(first: 2) {\n      edges {\n        node {\n          id\n          products(first: 5) {\n            edges {\n              node {\n                id\n              }\n            }\n          }\n        }\n      }\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\n  query {\n    collections(first: 2) {\n      edges {\n        node {\n          id\n          products(first: 5) {\n            edges {\n              node {\n                id\n              }\n            }\n          }\n        }\n      }\n    }\n  }\nQUERY;\n\n$response = $client->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 {\n    collections(first: 2) {\n      edges {\n        node {\n          id\n          products(first: 5) {\n            edges {\n              node {\n                id\n              }\n            }\n          }\n        }\n      }\n    }\n  }`,\n);\n\nconst data = await response.json();\n"
          Graphql query: "query {\n  collections(first: 2) {\n    edges {\n      node {\n        id\n        products(first: 5) {\n          edges {\n            node {\n              id\n            }\n          }\n        }\n      }\n    }\n  }\n}"
        

  input: null

  response: {
    "data": {
      "collections": {
        "edges": [
          {
            "node": {
              "id": "gid://shopify/Collection/547751128",
              "products": {
                "edges": [
                  {
                    "node": {
                      "id": "gid://shopify/Product/929898465"
                    }
                  },
                  {
                    "node": {
                      "id": "gid://shopify/Product/538825261"
                    }
                  }
                ]
              }
            }
          },
          {
            "node": {
              "id": "gid://shopify/Collection/585546552",
              "products": {
                "edges": []
              }
            }
          }
        ]
      }
    }
  }