delete
https://{subdomain}.myshoplaza.com/openapi/2025-06/collections/
Allows users to delete a specific collection by providing its unique ID in the path parameter.
Requireswrite_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.
- Retrieve specific metadata and settings for a collection.
Request Parameters
Public Request Parameters
Path Parameters
| Field | Type | Required | Example | Description |
|---|---|---|---|---|
| id | string | Yes | a60fe556-43ad-4e07-9125-507ac1bf71f7 | Unique identifier of the collection. Must be a valid UUID. |
Response Explanation
Public Response Parameters
Successful Response
| Parameter | Type | Example | Description |
|---|---|---|---|
code | string | 200 | Error code (200 indicates success) |
message | string | Success | Error message |
data | object | {...} |
Error Response
| Field | Type | Example | Description |
|---|---|---|---|
code | string | InvalidParameter | Error http message |
message | string | `` | Error message |