🔒

Requires read_collection access scope. More access scope

The Get Collect List API retrieves a list of collect objects, representing the associations between products and collections. This enables users to efficiently manage and display product categorization within collections.This API is especially useful for:

1.Fetching all products within a specific collection.

2.Retrieving collections a specific product belongs to.

3.Managing inventory or marketing strategies based on product categorization.

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

Public Response Parameters

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

Important Note on Query Parameters

Both collection_id and product_id are optional query parameters. It is essential to clarify the query logic when:

1. Both Parameters Are Provided:

   • The API will prioritize filtering the results based on both collection_id and product_id. This means that only products belonging to the specified collection and matching the given product ID will be returned.

2. Neither Parameter Is Provided:

   • If neither collection_id nor product_id is provided, the API will return results based on the default query logic (e.g., all products or collections depending on the endpoint's default behavior). Ensure developers understand this fallback behavior to avoid confusion.

3. Only One Parameter Is Provided:

   • If only collection_id is provided, the API will return all products within the specified collection.
   • If only product_id is provided, the API will return details or results specific to that product.

Example Scenarios

Response Explanation

Successful Response

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.

Request Examples

curl --request GET \
     --url https://yourshopdomain.myshoplaza.com/openapi/2022-01/collects \
     --header 'accept: application/json' \
     --header 'access-token: <your-access-token>' \
     --data '{
       "collection_id": "a60fe556-43ad-4e07-9125-507ac1bf71f7",
       "product_id": "9de53f9726576696b318a8d95c0946cb",
       "page": 1,
       "limit": 20
     }'
    

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

{
  "errors": [
    "ProductID must be a valid UUID"
  ]
}

{
  "error": "store is not active"
}

Error Details

API Structure Overview