Storefront API

List storefront catalogue

List active products and services published by a workspace.

GET/storefront/v1/{workspaceSlug}/catalogue/items

capability storefront.catalogue.list · v1public dataserver-scoped workspace

Request

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

workspaceSlugstringrequired
pathmin length 1max length 64
currencyCodestringrequired
querymin length 3max length 3
quantityinteger
querydefault 1min 1max 10000
atstring<date-time>
query
searchstring
querymin length 1max length 160
kind"product" | "service"
query
limitinteger
querydefault 100min 1max 200

Response

Successful responses use Dawn's data envelope.

dataStorefrontCatalogueItemListrequired
- idstring<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
- priceobject | nullrequired
  - priceIdstring<uuid>required
  - type"base" | "override" | "sale"required
  - currencyCodestringrequired
    min length 3max length 3
  - unitAmountintegerrequired
    min 0max 100000000000
  - originalPriceIdstring<uuid> | nullrequired
  - originalUnitAmountinteger | nullrequired
    min 0max 100000000000
metaobject

Errors

Error responses use the shared error envelope.

422The storefront query is invalid.
503The storefront is temporarily unavailable.

Request

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

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

const result = await dawn.capabilities["storefront.catalogue.list"]({
  "workspaceSlug": "string",
  "currencyCode": "<error-code>",
  "quantity": 1,
  "at": "2026-08-01T09:00:00.000Z",
  "search": "string",
  "kind": "product",
  "limit": 100,
});

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

Response

Successful response.

{
  "data": [
    {
      "id": "11111111-1111-4111-8111-111111111111",
      "kind": "product",
      "handle": "string",
      "name": "string",
      "description": null,
      "reference": null,
      "serviceDurationMinutes": 5,
      "price": {
        "priceId": "11111111-1111-4111-8111-111111111111",
        "type": "base",
        "currencyCode": "<error-code>",
        "unitAmount": 0,
        "originalPriceId": null,
        "originalUnitAmount": 0
      }
    }
  ],
  "meta": {}
}