get
https://{subdomain}.myshoplaza.com/openapi/2025-06/products/count
Count the number of products based on the provided filters.
Requiresread_productaccess scope. For more access scope
The Product Count API retrieves the total number of products that match specific filter criteria. It allows you to query the product catalog using various parameters, such as creation date, update date, published status, or collection ID, providing a count of products without fetching their full details.This API is especially useful for:
-
Analytics and Reporting: Obtain a count of products for detailed insights and reporting purposes.
-
Pagination Optimization: Use the count to calculate total pages or optimize data retrieval processes.
Request Parameters
Public Request Parameters
Query Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
ids | array of strings | No | Filter by specific product IDs | ["prod_123", "prod_456"] |
title | string | No | Filter by product title | "Wireless Headphones" |
collection_id | string | No | Filter by collection ID | "9e79ca1f-9ff2-409b-976f-98be343d38a3" |
created_at_min | string | No | Filter products created after date (ISO 8601) | "2025-01-01T00:00:00Z" |
created_at_max | string | No | Filter products created before date (ISO 8601) | "2025-06-01T00:00:00Z" |
updated_at_min | string | No | Filter products updated after date (ISO 8601) | "2025-05-01T00:00:00Z" |
updated_at_max | string | No | Filter products updated before date (ISO 8601) | "2025-06-01T00:00:00Z" |
published_at_min | string | No | Filter products published after date (ISO 8601) | "2025-05-15T00:00:00Z" |
published_at_max | string | No | Filter products published before date (ISO 8601) | "2025-06-15T00:00:00Z" |
published_status | string | No | Filter by publish status | "published" |
Response Explanation
Public Response Parameters
Successful Response
| Parameter | Type | Example | Description |
|---|---|---|---|
code | string | "200" | HTTP status code |
message | string | "Success" | Operation result message |
data.count | string | - | Total products matching filters |
Error Response
| Field | Type | Example | Description |
|---|---|---|---|
code | string | InvalidParameter | Error http message |
message | string | `` | Error message |