# collectionsCount - admin-graphql - QUERY Version: 2024-10 ## Description Count of collections. Limited to a maximum of 10000. ### Access Scopes `read_products` access scope. ## Arguments * [query](/docs/api/admin-graphql/2024-10/scalars/String): String - A filter made up of terms, connectives, modifiers, and comparators. | name | type | description | acceptable_values | default_value | example_use | | ---- | ---- | ---- | ---- | ---- | ---- | | default | string | Filter by a case-insensitive search of multiple fields in a document. | | | - `query=Bob Norman`
- `query=title:green hoodie` | | collection_type | string | | - `custom`
- `smart` | | handle | string | | id | id | Filter by `id` range. | | | - `id:1234`
- `id:>=1234`
- `id:<=1234` | | product_id | id | Filter by collections containing a product by its ID. | | product_publication_status | string | Filter by the publishable status of the resource on a channel, such as the online store. The value is a composite of the [channel `app` ID](https://shopify.dev/api/admin-graphql/latest/objects/Channel#app-price) (`Channel.app.id`) and one of the valid values. | - `approved`
- `rejected`
- `needs_action`
- `awaiting_review`
- `published`
- `demoted`
- `scheduled`
- `provisionally_published` | | - `publishable_status:189769876-approved` | | publishable_status | string | Filter by the publishable status of the resource on a channel, such as the online store. The value is a composite of either the [channel `app` ID](https://shopify.dev/api/admin-graphql/latest/objects/Channel#app-price) (`Channel.app.id`) or [channel `name`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Channel#field-name) and one of the valid values. | - `online_store_channel`
- `published`
- `unpublished`
- `visible`
- `unavailable`
- `hidden`
- `intended`
- `visible` | | - `publishable_status:published`
- `publishable_status:189769876:visible`
- `publishable_status:pos:hidden` | | published_at | time | Filter by the date and time when the collection was published to the Online Store. | | published_status | string | Filter by the published status of the resource on a channel, such as the online store. | - `unset`
- `pending`
- `approved`
- `not approved` | | - `published_status:approved` | | title | string | | updated_at | time | You can apply one or more filters to a query. Learn more about [Shopify API search syntax](https://shopify.dev/api/usage/search-syntax). * [savedSearchId](/docs/api/admin-graphql/2024-10/scalars/ID): ID - The ID of an existing saved search. The search’s query string is used as the query argument. Refer to the [`SavedSearch`](https://shopify.dev/api/admin-graphql/latest/objects/savedsearch) object. ## Returns * [count](/docs/api/admin-graphql/2024-10/scalars/Int): Int! The count of elements. * [precision](/docs/api/admin-graphql/2024-10/enums/CountPrecision): CountPrecision! The count's precision, or the exactness of the value. ## Examples ### Retrieves a count of custom collections Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query CollectionsCount { collectionsCount(query: \\\"collection_type:custom\\\") { count } }\"\n}'\n" Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: `query CollectionsCount {\n collectionsCount(query: \"collection_type:custom\") {\n count\n }\n }`,\n});\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 CollectionsCount {\n collectionsCount(query: \"collection_type:custom\") {\n count\n }\n }\nQUERY\n\nresponse = client.query(query: query)\n" Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n query CollectionsCount {\n collectionsCount(query: \"collection_type:custom\") {\n count\n }\n }`,\n);\n\nconst data = await response.json();\n" Graphql query: "query CollectionsCount {\n collectionsCount(query: \"collection_type:custom\") {\n count\n }\n}" #### Graphql Input null #### Graphql Response { "data": { "collectionsCount": { "count": 8 } } } ### Retrieves a count of smart collections Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"query CollectionsCount { collectionsCount(query: \\\"collection_type:smart\\\") { count } }\"\n}'\n" Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: `query CollectionsCount {\n collectionsCount(query: \"collection_type:smart\") {\n count\n }\n }`,\n});\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 CollectionsCount {\n collectionsCount(query: \"collection_type:smart\") {\n count\n }\n }\nQUERY\n\nresponse = client.query(query: query)\n" Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n query CollectionsCount {\n collectionsCount(query: \"collection_type:smart\") {\n count\n }\n }`,\n);\n\nconst data = await response.json();\n" Graphql query: "query CollectionsCount {\n collectionsCount(query: \"collection_type:smart\") {\n count\n }\n}" #### Graphql Input null #### Graphql Response { "data": { "collectionsCount": { "count": 10 } } }