API resources

Every resource group exposed by the Fulkruma API, with a link to its per-resource page. Each per-resource page documents every endpoint with method, path, parameters, response shape, and error codes.

If you're new to the API, read Authentication and the API overview first — the per-resource pages assume you know them.

Fulfilment

Resource What
Warehouses Stock locations. Stock levels and shipments hang off these.
Products Items you sell, with variants, SKUs, and physical/digital/license type.
Stock Per-variant per-warehouse quantity, reservations, and the audit-trail of movements.
Shipments Physical orders routed through Biteship couriers.
Shipping Rate quotes, courier catalog, origin config, label fetch, tracking.
Deliveries Time-limited download grants for digital products.
Licenses License keys with activation/deactivation and validation.
Addresses Saved buyer destination addresses.

Identity & access

Resource What
API keys HMAC credentials for server-to-server auth.
Webhooks Where Fulkruma POSTs event notifications.
Audit log Read-only history of every workspace mutation.

Operations

Resource What
Billing Plan, subscription, usage, and Plugipay-checkout for your Fulkruma subscription.
Integrations Aggregated runtime signals for connected systems (Biteship, Plugipay, Storlaunch).

Reading these pages

Each resource page follows the same shape:

  1. Overview — what the resource is, how it relates to others.
  2. Endpoints — one section per method.
  3. Per-endpoint — method + path, request parameters table, response example, error codes specific to this operation.
  4. The object — the full field reference for the resource.
  5. Events — which webhook events this resource produces.

Where to find things

  • Webhook event types? Webhooks has the full catalog.
  • Status codes and error codes? The API overview lists the common ones; per-endpoint errors live on each resource page.
  • HMAC signing recipe? Authentication.
  • Pattern 2 partner billing? Each endpoint mentions whether X-Fulkruma-On-Behalf-Of is honored.

Coverage notes

Some endpoints exist in the backend but aren't documented here because they're internal:

  • /api/v1/webhooks/biteship — inbound tracking events from Biteship.
  • /api/v1/webhooks/plugipay — inbound subscription/payment events from Plugipay.
  • /api/v1/webhooks/storlaunch — inbound product-sync events from Storlaunch.
  • /api/v1/admin/* — Pattern 2 partner provisioning (used by Storlaunch's CI; partner-side reference only).
  • /api/v1/stats/* — dashboard counters; same data is available by listing the underlying resources.

If you need access to one of these, email hello@fulkruma.com.