Storefront API

Calculate a storefront quote

Calculate contextual prices for active storefront items.

POST/storefront/v1/{workspaceSlug}/quotes

capability storefront.pricing.quote · v1public dataserver-scoped workspace

Request

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

workspaceSlugstringrequired
pathmin length 1max length 64
currencyCodestringrequired
bodymin length 3max length 3
linesobject[]required
bodymin items 1max items 100
- itemIdstring<uuid>required
- quantityintegerrequired
  min 1max 10000
contextobject
bodydefault {}
atstring<date-time>
body

Response

Successful responses use Dawn's data envelope.

dataStorefrontQuoterequired
- currencyCodestringrequired
  min length 3max length 3
- linesobject[]required
  - itemIdstring<uuid>required
  - handlestringrequired
  - namestringrequired
  - quantityintegerrequired
    min 0max 9007199254740991
  - priceobjectrequired
  - subtotalintegerrequired
    min 0max 9007199254740991
- totalintegerrequired
  min 0max 9007199254740991
- calculatedAtstring<date-time>required
metaobject

Errors

Error responses use the shared error envelope.

404A storefront item could not be found.
409An applicable price is not available.
422The storefront quote is invalid.
503The storefront 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["storefront.pricing.quote"]({
  "workspaceSlug": "string",
  "quote": {
    "currencyCode": "<error-code>",
    "lines": [{
        "itemId": catalogueItemIdSchema.parse("11111111-1111-4111-8111-111111111111"),
        "quantity": 1,
      }],
    "context": {},
    "at": "2026-08-01T09:00:00.000Z",
  },
});

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

Response

Successful response.

{
  "data": {
    "currencyCode": "<error-code>",
    "lines": [
      {
        "itemId": "11111111-1111-4111-8111-111111111111",
        "handle": "string",
        "name": "string",
        "quantity": 0,
        "price": {
          "priceId": "11111111-1111-4111-8111-111111111111",
          "type": "base",
          "currencyCode": "<error-code>",
          "unitAmount": 0,
          "originalPriceId": null,
          "originalUnitAmount": 0
        },
        "subtotal": 0
      }
    ],
    "total": 0,
    "calculatedAt": "2026-08-01T09:00:00.000Z"
  },
  "meta": {}
}