Delete collections

Bulk-deletes collections. Deleted ids are returned in data; per-item failures in errors.

DELETE/api/v2/{team_slug}/{app_slug}/collections
API
Management
Updated
Apr 26, 2026

management-api:DELETE:/api/v2/{team_slug}/{app_slug}/collections

Bulk-deletes collections. Deleted ids are returned in data; per-item failures in errors.

API ownership

  • 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.

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
NameInRequiredTypeDescription
Not documented in the OpenAPI contract.Not documented in the OpenAPI contract.NoanyNot documented in the OpenAPI contract.
Not documented in the OpenAPI contract.Not documented in the OpenAPI contract.NoanyNot documented in the OpenAPI contract.
Request bodyNo documented body
  • Required: Yes
  • Description: Not documented in the OpenAPI contract.
  • Content: application/json (object)

Delete Collections Request

PropertyTypeRequiredDetails
collectionsobject[]YesminItems: 1, maxItems: 20

Delete Collection Item

PropertyTypeRequiredDetails
idstringYes-

Generated example (synthetic):

{
  "collections": [
    {
      "id": "string"
    }
  ]
}
Responses5 statuses
StatusDescriptionContent
200OK (partial success possible)application/json (object)
400Request-level failureapplication/json (object)
401Request-level failureapplication/json (object)
403Request-level failureapplication/json (object)
500Request-level failureapplication/json (object)

200 - object

Collection Refs Bulk

PropertyTypeRequiredDetails
dataobject[]Yes-
errorsobject[]Yes-
Collection Ref
PropertyTypeRequiredDetails
idstring (uuid)Yesformat: uuid
Collection Error
PropertyTypeRequiredDetails
idstringNo-
slugstringNo-
messagestringYes-

Generated example (synthetic):

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000"
    }
  ],
  "errors": [
    {
      "id": "string",
      "slug": "string",
      "message": "string"
    }
  ]
}

400 - object

Error

PropertyTypeRequiredDetails
errorobjectYes-
Error Body
PropertyTypeRequiredDetails
messagestringYes-
detailsstring[]Yes-

Generated example (synthetic):

{
  "error": {
    "message": "string",
    "details": [
      "string"
    ]
  }
}

401 - object

Error

PropertyTypeRequiredDetails
errorobjectYes-
Error Body
PropertyTypeRequiredDetails
messagestringYes-
detailsstring[]Yes-

Generated example (synthetic):

{
  "error": {
    "message": "string",
    "details": [
      "string"
    ]
  }
}

403 - object

Error

PropertyTypeRequiredDetails
errorobjectYes-
Error Body
PropertyTypeRequiredDetails
messagestringYes-
detailsstring[]Yes-

Generated example (synthetic):

{
  "error": {
    "message": "string",
    "details": [
      "string"
    ]
  }
}

500 - object

Error

PropertyTypeRequiredDetails
errorobjectYes-
Error Body
PropertyTypeRequiredDetails
messagestringYes-
detailsstring[]Yes-

Generated example (synthetic):

{
  "error": {
    "message": "string",
    "details": [
      "string"
    ]
  }
}

Contract identity

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

Delete collections

# Delete collections Bulk-deletes collections. Deleted ids are returned in data; per-item failures in errors.
DELETE /api/v2/{team_slug}/{app_slug}/collections
Purpose

Bulk-deletes collections.

Required inputs

None documented

Primary response

200 ยท OK (partial success possible)

Operation key

management-api:DELETE:/api/v2/{team_slug}/{app_slug}/collections

## API ownership - 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](/apis/management/latest) The OpenAPI contract defines the method, path, parameters, request body, and responses for this operation. ## 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 - Stable operation key: `management-api:DELETE:/api/v2/{team_slug}/{app_slug}/collections` ## 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 body - Required: Yes - Description: Not documented in the OpenAPI contract. - Content: application/json (object) ### Delete Collections Request | Property | Type | Required | Details | | --- | --- | --- | --- | | `collections` | object[] | Yes | minItems: 1, maxItems: 20 | #### Delete Collection Item | Property | Type | Required | Details | | --- | --- | --- | --- | | `id` | string | Yes | - | **Generated example (synthetic):** ```json { "collections": [ { "id": "string" } ] } ``` ## Responses | 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) | ### 200 - object #### Collection Refs Bulk | Property | Type | Required | Details | | --- | --- | --- | --- | | `data` | object[] | Yes | - | | `errors` | object[] | Yes | - | ##### Collection Ref | Property | Type | Required | Details | | --- | --- | --- | --- | | `id` | string (uuid) | Yes | format: uuid | ##### Collection Error | Property | Type | Required | Details | | --- | --- | --- | --- | | `id` | string | No | - | | `slug` | string | No | - | | `message` | string | Yes | - | **Generated example (synthetic):** ```json { "data": [ { "id": "00000000-0000-0000-0000-000000000000" } ], "errors": [ { "id": "string", "slug": "string", "message": "string" } ] } ``` ### 400 - object #### Error | Property | Type | Required | Details | | --- | --- | --- | --- | | `error` | object | Yes | - | ##### Error Body | Property | Type | Required | Details | | --- | --- | --- | --- | | `message` | string | Yes | - | | `details` | string[] | Yes | - | **Generated example (synthetic):** ```json { "error": { "message": "string", "details": [ "string" ] } } ``` ### 401 - object #### Error | Property | Type | Required | Details | | --- | --- | --- | --- | | `error` | object | Yes | - | ##### Error Body | Property | Type | Required | Details | | --- | --- | --- | --- | | `message` | string | Yes | - | | `details` | string[] | Yes | - | **Generated example (synthetic):** ```json { "error": { "message": "string", "details": [ "string" ] } } ``` ### 403 - object #### Error | Property | Type | Required | Details | | --- | --- | --- | --- | | `error` | object | Yes | - | ##### Error Body | Property | Type | Required | Details | | --- | --- | --- | --- | | `message` | string | Yes | - | | `details` | string[] | Yes | - | **Generated example (synthetic):** ```json { "error": { "message": "string", "details": [ "string" ] } } ``` ### 500 - object #### Error | Property | Type | Required | Details | | --- | --- | --- | --- | | `error` | object | Yes | - | ##### Error Body | Property | Type | Required | Details | | --- | --- | --- | --- | | `message` | string | Yes | - | | `details` | string[] | Yes | - | **Generated example (synthetic):** ```json { "error": { "message": "string", "details": [ "string" ] } } ``` ## Contract identity 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 - Stable operation key: `management-api:DELETE:/api/v2/{team_slug}/{app_slug}/collections` - OpenAPI tag: Collections V2 - OpenAPI summary: Delete collections