Choose a version:

productsCount

query

Requires read_products access scope.

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

Anchor to Arguments

Arguments

Anchor to limitlimit

•Int

Default:10000

The upper bound on count value before returning a result. Use null to have no limit.

Anchor to queryquery

•String

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 barcode •string: Filter by the product variant barcode field.
Anchor to bundles •boolean: Filter by a product bundle. A product bundle is a set of two or more related products, which are commonly offered at a discount.
Anchor to category_id •string: Filter by the product category ID (product.category.id). A product category is the category of a product from Shopify's Standard Product Taxonomy.
Anchor to collection_id •id: Filter by the collection id field.
Anchor to combined_listing_role •string: Filter by the role of the product in a combined listing.
Anchor to created_at •time: Filter by the date and time when the product was created.
Anchor to delivery_profile_id •id: Filter by the delivery profile id field.
Anchor to error_feedback •string: Filter by products with publishing errors.
Anchor to gift_card •boolean: Filter by the product isGiftCard field.
Anchor to handle •string: Filter by a comma-separated list of product handles.
Anchor to has_only_composites •boolean: Filter by products that have only composite variants.
Anchor to has_only_default_variant •boolean: Filter by products that have only a default variant. A default variant is the only variant if no other variants are specified.
Anchor to has_variant_with_components •boolean: Filter by products that have variants with associated components.
Anchor to id •id: Filter by id range.
Anchor to inventory_total •integer: Filter by inventory count.
Anchor to is_price_reduced •boolean: Filter by products that have a reduced price. For more information, refer to the CollectionRule object.
Anchor to metafields.{namespace}.{key} •mixed: Filters resources by metafield value. Format: metafields.{namespace}.{key}:{value}. Learn more about querying by metafield value.
Anchor to out_of_stock_somewhere •boolean: Filter by products that are out of stock in at least one location.
Anchor to price •bigdecimal: Filter by the product variant price field.
Anchor to product_configuration_owner •string: Filter by the app id field.
Anchor to product_publication_status •string: Filter by the publication 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 product_type •string: Filter by a comma-separated list of product types.
Anchor to publication_ids •string: Filter by a comma-separated list of publication IDs that are associated with the product.
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 product was published to the online store and other sales channels.
Anchor to published_status •string: Filter by the published status of the resource on a channel, such as the online store.
Anchor to sku •string: Filter by the product variant sku field. Learn more about SKUs.
Anchor to status •string: Filter by a comma-separated list of statuses. You can use statuses to manage inventory. Shopify only displays products with an ACTIVE status in online stores, sales channels, and apps.
Anchor to tag •string: Filter objects by the tag field.
Anchor to tag_not •string: Filter by objects that don’t have the specified tag.
Anchor to title •string: Filter by the product title field.
Anchor to updated_at •time: Filter by the date and time when the product was last updated.
Anchor to variant_id •id: Filter by the product variant id field.
Anchor to variant_title •string: Filter by the product variant title field.
Anchor to vendor •string: Filter by the origin or source of the product. Learn more about vendors and managing vendor information.

Anchor to savedSearchIdsavedSearchId

•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?

Examples

Retrieve a count of products

Query

query {
  productsCount(query: "id:>=1000") {
    count
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { productsCount(query: \"id:>=1000\") { count } }"
}'

Remix

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

const response = await admin.graphql(
  `#graphql
  query {
    productsCount(query: "id:>=1000") {
      count
    }
  }`,
);

const data = await response.json();

Ruby

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 {
    productsCount(query: "id:>=1000") {
      count
    }
  }
QUERY

response = client.query(query: query)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    productsCount(query: "id:>=1000") {
      count
    }
  }`,
});

Response

{
  "productsCount": {
    "count": 7
  }
}

Retrieve a count of products

Open in GraphiQL

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

const response = await admin.graphql(

`#graphql

query {

productsCount(query: "id:>=1000") {

count

}

}`,

);

const data = await response.json();

query {
  productsCount(query: "id:>=1000") {
    count
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "query { productsCount(query: \"id:>=1000\") { count } }"
}'

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

const response = await admin.graphql(
  `#graphql
  query {
    productsCount(query: "id:>=1000") {
      count
    }
  }`,
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: `query {
    productsCount(query: "id:>=1000") {
      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 {
    productsCount(query: "id:>=1000") {
      count
    }
  }
QUERY

response = client.query(query: query)

Response

JSON

{

"productsCount": {

"count": 7

}