SDKs

SDKs

Use Aeolian SDKs to call the Storefront API with typed helpers instead of writing HTTP requests by hand.

Available SDKs

TypeScript SDKUse typed storefront API calls in browser, Node.js, Next.js, and other TypeScript or JavaScript runtimes.View setup
More SDKs coming soonAdditional language SDKs can be added from the same API contract without changing the API itself.Planned

Using the reference with an SDK

Every endpoint page includes a TypeScript example when the reference is switched to SDK mode. Use that example for the function name and request shape.

The rest of the endpoint page still applies. Parameters, response fields, pagination, localization, caching, and errors are the same whether you use the SDK or call the API directly.

In SDK examples, request values are grouped by where they belong in the HTTP request:

  • query for query string parameters
  • path for path parameters
  • body for JSON request bodies
  • headers for per-request headers
const { data, error } = await listProducts({
  query: {
    limit: 20,
  },
})

Before calling endpoints

Install and configure the SDK once, then use the endpoint examples for each call.

See TypeScript SDK for setup.