Catalogue API

Delete a catalogue item

Delete a product or service from the current workspace catalogue.

DELETE/v1/catalogue/items/{itemId}

capability catalogue.items.delete · v1operational dataserver-scoped workspace

Request

Path, query, and JSON body fields accepted by this operation.

itemIdstring<uuid>required
path

Response

Successful responses use Dawn's data envelope.

dataCatalogueItemrequired
- idstring<uuid>required
- workspaceIdstring<uuid>required
- kind"product" | "service"required
- handlestringrequired
  min length 1max length 120
- namestringrequired
  min length 1max length 160
- descriptionstring | nullrequired
  max length 5000
- referencestring | nullrequired
  min length 1max length 120
- serviceDurationMinutesinteger | nullrequired
  min 5max 1440
- status"draft" | "active" | "archived"required
- createdAtstring<date-time>required
- updatedAtstring<date-time>required
metaobject

Errors

Error responses use the shared error envelope.

404The catalogue item could not be found.
422The catalogue item ID is invalid.
503The catalogue item could not be deleted.

Request

import { createDawnClient } from "@dawn/api";
import { catalogueItemIdSchema } from "@dawn/domain";

const dawn = createDawnClient({
  baseUrl: "http://localhost:6400",
});

const result = await dawn.capabilities["catalogue.items.delete"]({
  "itemId": catalogueItemIdSchema.parse("11111111-1111-4111-8111-111111111111"),
});

if (result.isErr()) throw result.error;
console.log(result.value);

Response

Successful response.

{
  "data": {
    "id": "11111111-1111-4111-8111-111111111111",
    "workspaceId": "22222222-2222-4222-8222-222222222222",
    "kind": "product",
    "handle": "string",
    "name": "string",
    "description": null,
    "reference": null,
    "serviceDurationMinutes": 5,
    "status": "draft",
    "createdAt": "2026-08-01T09:00:00.000Z",
    "updatedAt": "2026-08-01T09:00:00.000Z"
  },
  "meta": {}
}