Requires
write_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.
Public Request Parameters
| Parameter Name | Type | Required | Parameter Location | Parameter Value | Description |
|---|---|---|---|---|---|
| Access-Token | String | Yes | Header | Bx-_5aV eXNwl-4AB98s5xLV yg0fNzGf MuTpqtlBA | Used to authenticate API requests. Obtain an access token from the Access Token Guide. Pass it in the Authorization header for every request. |
| Content-Type | String | Yes | Header | application/json | Indicates the media type of the request body. It tells the server how to parse the request and the client how to interpret the response. For more details, visit Content-Type. |
Public Response Parameters
| Parameter Name | Type | Mandatory | Parameter Location | Example Value | Description |
|---|---|---|---|---|---|
| error | String | No | Response Body | { "error": "store is not active" } | Indicates an error encountered during the process. This field typically appears when the Access Token is missing or invalid. Example: { "error": "store is not active" }. |
| errors | Array | No | Response Body | { "errors"["ProductId is required"] } | A list of errors that occurred during the request processing. Example: { "errors": [ "No Context" ] }. |
| Request-Id | String | Yes | Header | Bx-_5aV eXNwl-4AB98s5xLV yg0fNzGf MuTpqtlBA | A unique identifier for each request. It helps in identifying and debugging specific requests. |
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
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
Successful 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. |
Request Examples
curl --request DELETE \
--url https://{shopdomain}.myshoplazza.com/openapi/2022-01/collects/{id} \
--header 'accept: application/json' \
--header 'access-token: {your-access-token}'
Success Response Example
{}
Error Response Example
{
"errors": [
"Smart collection can't be updated."
]
}
{
"error": "store is not active"
}
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."] } |