Requires
read_collectionaccess scope. More access scope
The Get Collect Count API retrieves the total number of collect objects that associate products with a collection. This enables users to determine the count of products within a collection or the number of collections that include a specific product.This API is especially useful for:
1.Calculating the number of products in a collection for inventory analysis.
2.Determining how many collections a specific product is associated with.
3.Streamlining reporting and data analysis for collections and products.
Request Parameters
Public Request Parameters
Query Parameters
| Parameter | Type | Required | Example | Description |
|---|---|---|---|---|
| collection_id | string | No | a60fe556-43ad-4e07-9125-507ac1bf71f7 | The UUID of the collection to filter collects. |
| product_id | string | No | b60fe556-12bc-3e07-9125-507ac1bf71c3 | The UUID of the product to filter collects. |
Response Explanation
Public Response Parameters
Success Response
| Field | Type | Example | Description |
|---|---|---|---|
| count | integer | 42 | Total number of collects retrieved. |
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 | ["ProductID must be a valid UUID"] | 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 | Invalid or empty product_id or collection_id | The product_id or collection_id is missing, empty, or not in a valid UUID format. | { "errors": [ "CollectionID must be a valid UUID", "ProductID must be a valid UUID"]} |