Get Collect Count

Retrieves the total number of collect objects that associate products with a collection.

🔒

Requires read_collection access 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

ParameterTypeRequiredExampleDescription
collection_idstringNoa60fe556-43ad-4e07-9125-507ac1bf71f7The UUID of the collection to filter collects.
product_idstringNob60fe556-12bc-3e07-9125-507ac1bf71c3The UUID of the product to filter collects.

Response Explanation

Public Response Parameters

📘

Successful Response

ParameterTypeExampleDescription
codestring200Error code (200 indicates success)
messagestringSuccessError message
dataobject{...}Contains the collects data
data.countint3242Total number of collects retrieved.

Error Response

FieldTypeExampleDescription
codestringInvalidParameterError http message
messagestring``Error message

API Structure Overview

Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!