delete
https://{shopdomain}.myshoplaza.com/openapi/2022-01/collects/
Requireswrite_collectionaccess scope. More access scope
The Delete Collect API removes an association between a product and a collection by deleting a collect object. This operation ensures the product is no longer part of the specified collection.This API is especially useful for:
- Removing products from collections no longer relevant for marketing or categorization.
- Cleaning up collections during inventory updates or reorganization.
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
Path Parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| id | string | Yes | Unique identifier of the collect to delete. Must be a valid UUID. | "123e4567-e89b-12d3-a456-426614174000" |
Response Explanation
Public Response Parameters
Success Response
| Field | Type | Description | Example |
|---|---|---|---|
{} | object | Empty object indicating successful deletion. | {} |
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 | [ "Smart collection can't be updated."] | 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 collect_id | missing required collect_id or collect_id with incorrect UUID types | { "errors": [ "ID must be a valid UUID"]} |
| Record not found | The Record ID provided in the request does not exist. | { "errors": ["Record not found."] } | |
| Smart collection can't be delete | The collection you are attempting to update is a smart collection | { "errors": ["Smart collection can't be updated."] } |