Bulk-deletes collections. Deleted ids are returned in data; per-item failures in errors.
- API family: Management API
- Best for: Trusted back-office workflows that create, update, organize, or delete merchant-owned data.
- Do not use from: Browser-only storefront code or public clients.
- Guide route: /apis/management/latest
The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation.
- Method:
DELETE
- Path:
/api/v2/\{team_slug\}/\{app_slug\}/collections
- Summary: Delete collections
- Description: Bulk-deletes collections. Deleted ids are returned in data; per-item failures in errors.
- OpenAPI contract: management-api
- Operation ID: deleteCollections
Parameters2 parameters
| Name | In | Required | Type | Description |
|---|
| Not documented in the OpenAPI contract. | Not documented in the OpenAPI contract. | No | any | Not documented in the OpenAPI contract. |
| Not documented in the OpenAPI contract. | Not documented in the OpenAPI contract. | No | any | Not documented in the OpenAPI contract. |
Request bodyNo documented body
- Required: Yes
- Description: Not documented in the OpenAPI contract.
- Content: application/json (object)
| Property | Type | Required | Details |
|---|
collections | object[] | Yes | minItems: 1, maxItems: 20 |
| Property | Type | Required | Details |
|---|
id | string | Yes | - |
Generated example (synthetic):
{
"collections": [
{
"id": "string"
}
]
}
Responses5 statuses
| Status | Description | Content |
|---|
| 200 | OK (partial success possible) | application/json (object) |
| 400 | Request-level failure | application/json (object) |
| 401 | Request-level failure | application/json (object) |
| 403 | Request-level failure | application/json (object) |
| 500 | Request-level failure | application/json (object) |
| Property | Type | Required | Details |
|---|
data | object[] | Yes | - |
errors | object[] | Yes | - |
| Property | Type | Required | Details |
|---|
id | string (uuid) | Yes | format: uuid |
| Property | Type | Required | Details |
|---|
id | string | No | - |
slug | string | No | - |
message | string | Yes | - |
Generated example (synthetic):
{
"data": [
{
"id": "00000000-0000-0000-0000-000000000000"
}
],
"errors": [
{
"id": "string",
"slug": "string",
"message": "string"
}
]
}
| Property | Type | Required | Details |
|---|
error | object | Yes | - |
| Property | Type | Required | Details |
|---|
message | string | Yes | - |
details | string[] | Yes | - |
Generated example (synthetic):
{
"error": {
"message": "string",
"details": [
"string"
]
}
}
| Property | Type | Required | Details |
|---|
error | object | Yes | - |
| Property | Type | Required | Details |
|---|
message | string | Yes | - |
details | string[] | Yes | - |
Generated example (synthetic):
{
"error": {
"message": "string",
"details": [
"string"
]
}
}
| Property | Type | Required | Details |
|---|
error | object | Yes | - |
| Property | Type | Required | Details |
|---|
message | string | Yes | - |
details | string[] | Yes | - |
Generated example (synthetic):
{
"error": {
"message": "string",
"details": [
"string"
]
}
}
| Property | Type | Required | Details |
|---|
error | object | Yes | - |
| Property | Type | Required | Details |
|---|
message | string | Yes | - |
details | string[] | Yes | - |
Generated example (synthetic):
{
"error": {
"message": "string",
"details": [
"string"
]
}
}
Use these fields to confirm you are implementing the intended endpoint contract.
- API family: Management API
- Method:
DELETE
- Path:
/api/v2/\{team_slug\}/\{app_slug\}/collections
- Operation ID: deleteCollections
- OpenAPI tag: Collections V2
- OpenAPI summary: Delete collections