Requires
write_collectionaccess scope. More access scope
The Delete Collection API allows users to delete a specific collection by providing its unique ID in the path parameter. This operation is irreversible and will remove the collection and its associated metadata from the system.#### Use Cases:
- Remove outdated or irrelevant collections.
- Manage and clean up collections for better organization.
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"["No Context"] } | 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 | Example | Description |
|---|---|---|---|---|
| id | string | Yes | a60fe556-43ad-4e07-9125-507ac1bf71f7 | Unique identifier of the collection. |
Response Explanation
Success Response
| Field | Type | Example | Description |
|---|---|---|---|
| empty_object | object | {} | Indicates the collection was successfully deleted. |
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 | [ "Collection not found"] | 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/collections/{id} \
--header 'accept: application/json' \
--header 'access-token: {your-access-token}'
Success Response Example
{}
Error Response Example
{
"errors": [
"Collection not found"
]
}
{
"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 | Collection Not Found | The Collection ID provided in the request does not exist. | { "errors": ["Collection not found"] } |
Invalid or empty collection_id | missing required collection_id or collection_id with incorrect UUID types | { "errors": [ "collection_id has an invalid UUID"]} |