Requires read_collection access 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.
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.
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"]}
API Structure Overview
Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!
