get
https://{subdomain}.myshoplaza.com/openapi/2025-06/collections/count
Retrieve the total number of collections that match specific criteria.
Requiresread_collectionaccess scope. More access scope
The Get Collection Count API allows you to retrieve the total number of collections that match specific criteria. This endpoint supports filtering by collection IDs and update timestamps, enabling fine-grained control over the count retrieval.This API is especially useful for:
- Quickly determine the number of collections available in your store.
- Filter collections by update time or specific IDs to get a precise count.
Request Parameters
Public Request Parameters
Query Parameters
| Parameter | Type | Required | Example | Description |
|---|---|---|---|---|
| updated_at_min | string | No | updated_at_min=2024-01-01T00:00:00Z | ISO 8601 timestamp. Only include collections updated after this time. |
| updated_at_max | string | No | updated_at_max=2024-12-31T23:59:59Z | ISO 8601 timestamp. Only include collections updated before this time. |
Response Explanation
Public Response Parameters
Successful Response
| Parameter | Type | Example | Description |
|---|---|---|---|
code | string | 200 | Error code (200 indicates success) |
message | string | Success | Error message |
data | object | {...} | Contains the collects data |
data.count | int32 | 15 | Total number of collections matching the filters. |
Error Response
| Field | Type | Example | Description |
|---|---|---|---|
code | string | InvalidParameter | Error http message |
message | string | `` | Error message |