🔒

Requires write_collection access scope. More access scope

The Create Collect API associates a product with a collection by creating a collect object. For every single product in a collection there's a collect that tracks the ID of both the product and collection. This enables users to organize products into collections for easier management and display.This API is especially useful for:

1. Add a product to a specific collection.
2. Organize products for marketing, inventory, or categorization purposes.

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

Body Parameters

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 POST \
     --url https://{shopdomain}.myshoplazza.com/openapi/2022-01/collects \
     --header 'accept: application/json' \
     --header 'access-token: {your-access-token}' \
     --header 'content-type: application/json' \
     --data '{
       "collect": {
         "collection_id": "a60fe556-43ad-4e07-9125-507ac1bf71f7",
         "product_id": "c34da7b1-26af-4c2b-8a7b-3474d73cdab1"
       }
     }'
    

Success Response Example

{
  "collect": {
    "id": "c0bcd1a9-8a42-4b8d-b2eb-b8a11b742da6",
    "collection_id": "a60fe556-43ad-4e07-9125-507ac1bf71f7",
    "product_id": "ea8f38ba-a152-4c64-a12c-50ea77ac4245",
    "position": 2,
    "created_at": "2024-04-16T11:34:32Z",
    "updated_at": "2024-04-16T11:34:32Z"
  }
}

Error Response Example

{
  "errors": [
    "ProductId is required"
  ]
}

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

Error Details