Choose a version:

collectionsCount

query

Requires read_products access scope.

Count of collections. Limited to a maximum of 10000 by default.

Arguments

query

A filter made up of terms, connectives, modifiers, and comparators. You can apply one or more filters to a query. Learn more about Shopify API search syntax.

Anchor to default •string: Filter by a case-insensitive search of multiple fields in a document.
Anchor to collection_type •string
Anchor to handle •string
Anchor to id •id: Filter by id range.
Anchor to product_id •id: Filter by collections containing a product by its ID.
Anchor to 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 (Channel.app.id) and one of the valid values.
Anchor to 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 (Channel.app.id) or channel name and one of the valid values.
Anchor to published_at •time: Filter by the date and time when the collection was published to the Online Store.
Anchor to published_status •string: Filter by the published status of the resource on a channel, such as the online store.
Anchor to title •string
Anchor to updated_at •time

savedSearchId

•ID

The ID of an existing saved search. The search’s query string is used as the query argument. Refer to the SavedSearch object.

Was this section helpful?

Anchor to Possible returnsPossible returns

Anchor to CountCount •Count: Details for count of elements.

Was this section helpful?

Retrieves a count of custom collections
Retrieves a count of smart collections

Examples

Open in GraphiQL

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

query CollectionsCount {

collectionsCount(query: "collection_type:custom") {

count

}

}`,

);

const data = await response.json();

query CollectionsCount {
  collectionsCount(query: "collection_type:custom") {
    count
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query CollectionsCount { collectionsCount(query: \"collection_type:custom\") { count } }"
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  query CollectionsCount {
    collectionsCount(query: "collection_type:custom") {
      count
    }
  }`,
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query CollectionsCount {
    collectionsCount(query: "collection_type:custom") {
      count
    }
  }`,
});

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  query CollectionsCount {
    collectionsCount(query: "collection_type:custom") {
      count
    }
  }
QUERY

response = client.query(query: query)

Response

JSON

{

"collectionsCount": {

"count": 8

}