getProductsCount

Get the count of all products with optional filters.

Description

This method retrieves the total count of products based on the provided filter parameters (body). It returns a Promise that resolves to an IProductsCount object containing various counts of products.

Products.getProductsCount( body );

Parameters schema

Schema

body(required): any[]
Body parameters for filter. Deault: []
example:

[
  {
    "attributeMarker": "price",
    "conditionMarker": "in",
    "statusMarker": "status_1",
    "conditionValue": {},
    "pageUrls": [
      "23-laminat-floorwood-maxima"
    ],
    "title": "Iphone 17 Pro"
  }
]

Examples

Minimal example

  const response = await Products.getProductsCount();

Use filters to find specific products count:

attributeMarker: The text identifier of the indexed attribute by which values are filtered. conditionMarker: The type of condition to apply to the attribute value.

Marker	Meaning	Example
eq	Equal	statusId = 1 (active only)
neq	Not equal	category ≠ "archived"
in	Contains (one of)	category in ["electronics", "books"]
nin	Not contains	brand not in ["fake_brand"]
mth	More than	price > 100
lth	Less than	price < 50
exs	Exists (has value)	Has description
nexs	Does not exist	No image

conditionValue: The value to compare against.

Example response

{
  "totalAll": 3,
  "totalInCategory": 0,
  "totalInCategoryWithNested": 0
}

Response schema

Schema: IProductsCount

totalAll: number
The total number of products found.
example: 100

totalInCategory: number
The total number of products found in category.
example: 50

totalInCategoryWithNested: number
The total number of products found in nested category.
example: 10

---