Catalogue API

List catalogue prices

List the contextual prices configured for a catalogue item.

GET/v1/catalogue/items/{itemId}/prices

capability catalogue.prices.list · 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.

dataCataloguePriceListrequired
- idstring<uuid>required
- workspaceIdstring<uuid>required
- catalogueItemIdstring<uuid>required
- type"base" | "override" | "sale"required
- currencyCodestringrequired
  min length 3max length 3
- amountintegerrequired
  min 0max 100000000000
- minQuantityintegerrequired
  min 1max 10000
- maxQuantityinteger | nullrequired
  min 1max 10000
- rulesobject[]required
  max items 20
  - attributestringrequired
    min length 1max length 120
  - operator"eq" | "neq" | "in" | "not_in" | "gt" | "gte" | "lt" | "lte"required
  - valuestring | number | boolean | string | number | boolean[]required
- priorityintegerrequired
  min -1000max 1000
- startsAtstring<date-time> | nullrequired
- endsAtstring<date-time> | nullrequired
- 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 is temporarily unavailable.

Request

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

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

const result = await dawn.capabilities["catalogue.prices.list"]({
  "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",
      "catalogueItemId": "11111111-1111-4111-8111-111111111111",
      "type": "base",
      "currencyCode": "<error-code>",
      "amount": 0,
      "minQuantity": 1,
      "maxQuantity": 1,
      "rules": [
        {
          "attribute": "string",
          "operator": "eq",
          "value": "Circle Berlin"
        }
      ],
      "priority": -1000,
      "startsAt": null,
      "endsAt": null,
      "createdAt": "2026-08-01T09:00:00.000Z",
      "updatedAt": "2026-08-01T09:00:00.000Z"
    }
  ],
  "meta": {}
}