Skip to content

Get product statistics

GET
/stores/{storeRef}/products/stats
curl --request GET \
--url https://apibase.ecomweb.app/api/v1/stores/example/products/stats \
--header 'x-api-key: <x-api-key>'

Returns store-wide counts: all products, active products, products with variants and products with low stock.

Required scopes: read:products

storeRef
required
string

The store’s ref, as returned by GET /stores.

Media typeapplication/json
object
total
required

Number of products.

number
active
required

Number of active products.

number
withVariants
required

Number of products that have more than one variant.

number
lowStock
required

Number of products with a variant at or below its low-stock threshold.

number

Example generated

{
"total": 1,
"active": 1,
"withVariants": 1,
"lowStock": 1
}

The key is missing, invalid, revoked or expired.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}

The key may not do this: a missing scope, a readonly key, a publishable key on a Store API route, or a disallowed origin.

Media typeapplication/json
One of:
object
statusCode
required

The HTTP status code.

number
message
required

What went wrong; validation failures list one message per problem.

One of:
string
error

The HTTP status text, such as Bad Request.

string

Example generated

{
"statusCode": 1,
"message": [
"example"
],
"error": "example"
}