storefront

Real-time inventory check (cart pre-checkout)

Real-time inventory check used by storefront carts before checkout.

"available" means onHand (net-of-reservations) >= qty. The on-hand number is max(0, available + buildable - reserved) — an assembly a storefront can still have built counts as sellable — the same effective-available number the admin UI shows and the outbound sync layer pushes to other channels. Untracked variants (trackInventory = false) are always available, with onHand set to Number.MAX_SAFE_INTEGER so storefronts can render an "in stock" badge without special-casing the sentinel.

No caching: cart-time inventory must reflect any race-window reservations from concurrent orders.

post/api/v1/storefront/inventory/check

Request

  • Base URL: https://api.foundryims.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.foundryims.com/api/v1/storefront/inventory/check
  • Auth: HTTP bearer

Request body

Response

Example response

{
  "items": [
    {
      "onHand": 14
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.