Requires
read_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.
Note: The operation is scoped to a specific shop, identified by its unique domain prefix (shopdomain), ensuring all updates are applied to the correct store.
Public Request Parameters
| Parameter Name | Type | Required | Parameter Location | Parameter Value | Description |
|---|---|---|---|---|---|
| Access-Token | String | Yes | Header | Bx-_5aV eXNwl-4AB98s5xLV yg0fNzGf MuTpqtlBA | Used to authenticate API requests. Obtain an access token from the Access Token Guide. Pass it in the Authorization header for every request. |
| Content-Type | String | Yes | Header | application/json | Indicates the media type of the request body. It tells the server how to parse the request and the client how to interpret the response. For more details, visit Content-Type. |
Public Response Parameters
| Parameter Name | Type | Mandatory | Parameter Location | Example Value | Description |
|---|---|---|---|---|---|
| error | String | No | Response Body | { "error": "store is not active" } | Indicates an error encountered during the process. This field typically appears when the Access Token is missing or invalid. Example: { "error": "store is not active" }. |
| errors | Array | No | Response Body | { "errors"["No Context"] } | A list of errors that occurred during the request processing. Example: { "errors": [ "No Context" ] }. |
| Request-Id | String | Yes | Header | Bx-_5aV eXNwl-4AB98s5xLV yg0fNzGf MuTpqtlBA | A unique identifier for each request. It helps in identifying and debugging specific requests. |
Error and Errors Clarification:
Added explanation that the error and errors fields are currently dependent on the API implementation, with plans for future unification.
Request Parameters
Query Parameters
| Parameter | Type | Required | Example | Description |
|---|---|---|---|---|
| ids | string | No | ids=a60fe556-43ad-4e07-9125-507ac1bf71f7,b12f6556-43ad-4e07-9125-507ac1bf71e2 | Comma-separated list of collection IDs to filter by. |
| 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
Successful Response
| Field | Type | Example | Description |
|---|---|---|---|
| count | integer | 15 | Total number of collections matching the filters. |
Error Response
Error responses in the API can be represented using two different fields: errors and error. Both fields provide details about issues encountered during request processing. Below is an explanation of the fields with their respective examples and descriptions.
| Field | Type | Example | Description |
|---|---|---|---|
errors | Array | [ "UpdatedAtMin time format error"] | A list of errors encountered during the request processing. |
| Field | Type | Example | Description |
|---|---|---|---|
error | Array | "store is not active" | Indicates an error encountered during the process. |
Request Examples
curl --request GET \
--url "https://<shopdomain>.myshoplazza.com/openapi/2022-01/collections/count?ids=a60fe556-43ad-4e07-9125-507ac1bf71f7&updated_at_min=2024-01-01T00:00:00Z&updated_at_max=2024-12-31T23:59:59Z" \
--header 'accept: application/json' \
--header 'access-token: <your-access-token>'
Success Response Example
{
"count": 1
}
Error Response Example
{
"errors": [
"UpdatedAtMin time format error"
]
}
{
"error": "store is not active"
}
Error Details
| Status Code | Message | Possible Reason | Example Response |
|---|---|---|---|
| 400 | Bad Request | Invalid input format or request structure (e.g., missing required fields or incorrect data types). | Bad Request |
| Unauthorized | The request is missing valid authentication credentials or the credentials provided are invalid. | Unauthorized | |
| 422 | update_at_min time format error | The update_at_min field is not in a valid time format.(e.g., not ISO8601). | {"errors": ["update_at_min time format error"]} |
update_at_max time format error | The update_at_max field is not in a valid time format.(e.g., not ISO8601). | {"errors": ["update_at_min time format error"]} | |
| 404 | store is not active | The store name provided is not activate. | {"errors": ["store is not active"]} |
| 500 | no context | Missing Context | {"errors": ["No context"]} |