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.
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"["ProductId is required"] } | 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 |
|---|---|---|---|---|
| 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
Successful 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. |
Request Examples
curl --request GET \
--url https://yourshopdomain.myshoplazza.com/openapi/2022-01/collects/count?collection_id=a60fe556-43ad-4e07-9125-507ac1bf71f7 \
--header 'accept: application/json' \
--header 'access-token: {ACCESS_TOKEN}'
Success Response Example
{
"collects": [
{
"id": "dec4897f-2537-44a7-91fb-9854f643ad1e",
"collection_id": "a60fe556-43ad-4e07-9125-507ac1bf71f7",
"product_id": "636a07da-39eb-4829-bde9-b65fae1c28b0",
"position": 1,
"created_at": "2024-04-16T10:31:13Z",
"updated_at": "2024-04-16T10:31:13Z"
}
]
}
Error Response Example
{
"count": 2
}
{
"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 | 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"]} |