collection
query

Choose a version:

Returns a Collection resource by ID.

Anchor to section titled 'Arguments'

Arguments

Anchor to id id ID! required: The ID of the Collection to return.

Was this section helpful?

Anchor to section titled 'Collection possible returns'

Collection possible returns

Anchor to Collection Collection Collection: Represents a group of products that can be displayed in online stores and other sales channels in categories, which makes it easy for customers to find them. For example, an athletics store might create different collections for running attire, shoes, and accessories.

Collections can be defined by conditions, such as whether they match certain product tags. These are called smart or automated collections.

Collections can also be created for a custom group of products. These are called custom or manual collections.

Was this section helpful?

Code examples for QUERY: collection

Query Reference for QUERY: collection

"{\n  collection(id) {\n    # Collection fields\n  }\n}"

Input Reference for QUERY: collection

Schema Reference for QUERY: collection

Display Examples for QUERY: collection

[
  {
    "example": {
      "type_name": "collection",
      "title": "Get a collection by ID",
      "description": "Returns the collection with the specified ID.\n",
      "query_string": "query {\n  collection(id: \"gid://shopify/Collection/841564295\") {\n    id\n    title\n    handle\n    updatedAt\n  }\n}",
      "response": {
        "data": {
          "collection": {
            "id": "gid://shopify/Collection/841564295",
            "title": "IPods",
            "handle": "ipods",
            "updatedAt": "2008-02-02T00:00:00Z"
          }
        }
      },
      "api_name": "admin",
      "minimum_api_version": "2023-10",
      "maximum_api_version": "unstable",
      "location": "/components/merchandising/test/unit/graph_api/admin/collection_test.rb",
      "curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query { collection(id: \\\"gid://shopify/Collection/841564295\\\") { id title handle updatedAt } }\"\n}'\n",
      "remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query {\n    collection(id: \"gid://shopify/Collection/841564295\") {\n      id\n      title\n      handle\n      updatedAt\n    }\n  }`,\n);\n\nconst data = await response.json();\n",
      "ruby_example": "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  query {\n    collection(id: \"gid://shopify/Collection/841564295\") {\n      id\n      title\n      handle\n      updatedAt\n    }\n  }\nQUERY\n\nresponse = client.query(query: query)\n",
      "node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `query {\n    collection(id: \"gid://shopify/Collection/841564295\") {\n      id\n      title\n      handle\n      updatedAt\n    }\n  }`,\n});\n",
      "php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  query {\n    collection(id: \"gid://shopify/Collection/841564295\") {\n      id\n      title\n      handle\n      updatedAt\n    }\n  }\nQUERY;\n\n$response = $client->query([\"query\" => $query]);\n"
    },
    "titleStringKey": "arguments",
    "inputVariableEntries": []
  },
  {
    "example": {
      "type_name": "collection",
      "title": "Returns null when collection is not found",
      "query_string": "query {\n  collection(id: \"gid://shopify/Collection/-1\") {\n    id\n    title\n  }\n}",
      "response": {
        "data": {
          "collection": null
        }
      },
      "api_name": "admin",
      "minimum_api_version": "2023-10",
      "maximum_api_version": "unstable",
      "location": "/components/merchandising/test/unit/graph_api/admin/collection_test.rb",
      "curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-04/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query { collection(id: \\\"gid://shopify/Collection/-1\\\") { id title } }\"\n}'\n",
      "remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  query {\n    collection(id: \"gid://shopify/Collection/-1\") {\n      id\n      title\n    }\n  }`,\n);\n\nconst data = await response.json();\n",
      "ruby_example": "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  query {\n    collection(id: \"gid://shopify/Collection/-1\") {\n      id\n      title\n    }\n  }\nQUERY\n\nresponse = client.query(query: query)\n",
      "node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: `query {\n    collection(id: \"gid://shopify/Collection/-1\") {\n      id\n      title\n    }\n  }`,\n});\n",
      "php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  query {\n    collection(id: \"gid://shopify/Collection/-1\") {\n      id\n      title\n    }\n  }\nQUERY;\n\n$response = $client->query([\"query\" => $query]);\n"
    },
    "titleStringKey": "arguments",
    "inputVariableEntries": []
  }
]

collectionquery

Arguments

Collection possible returns

collection
query