post
https://{shopdomain}.myshoplaza.com/openapi/2022-01/collects
Requireswrite_collectionaccess 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:
- Add a product to a specific collection.
- 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.
Request Parameters
Public Request Parameters
Body Parameters
| Field | Type | Required | Example | Description |
|---|---|---|---|---|
| collect.collection_id | string | Yes | a60fe556-43ad-4e07-9125-507ac1bf71f7 | Unique identifier of the collection. |
| collect.product_id | string | Yes | c34da7b1-26af-4c2b-8a7b-3474d73cdab1 | Unique identifier of the product. |
Response Explanation
Public Response Parameters
Success Response
| Field | Type | Example | Description |
|---|---|---|---|
| collect.id | string | f12ab34c-98af-4e76-9b11-05a1dc14bf33 | Unique identifier of the collect. |
| collect.collection_id | string | a60fe556-43ad-4e07-9125-507ac1bf71f7 | Identifier of the associated collection. |
| collect.product_id | string | c34da7b1-26af-4c2b-8a7b-3474d73cdab1 | Identifier of the associated product. |
| collect.position | integer | 1 | Position of the product in the collection. |
| collect.created_at | string | 2024-04-16T10:31:12Z | Timestamp when the collect was created. |
| collect.updated_at | string | 2024-04-16T10:31:12Z | Timestamp when the collect was last updated. |
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 is required"] | 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 | missing required product_id or product_id with incorrect UUID types | { "errors": [ "productId has an invalid UUID"]} |
product_id is already linked to the collection. | Product is already included in current collection. | { "errors": ["Product is already included in current collection."] } | |
| Product not found | The product ID provided in the request does not exist. | { "errors": ["Product not found."] } | |
| 404 | Record Not Found | The database query for retrieving the collect returned no result. | { "errors": ["Record not found"] } |