Ecomiq Docs
Choose the API that matches your integration: Admin for internal operations, Storefront for shopping experiences, and Auth for identity and tokens. Each reference reflects the service's published contract.
APIs
The three APIs use different authentication, context, and pagination rules. Check each operation before choosing the token, headers, and parameters to send.
Storefront SDK
@ecomiq/storefront is our React micro-framework for building Ecomiq stores. It includes SSR routes, Storefront API access, cart, checkout, and deployment to Cloudflare Workers.
npm i @ecomiq/storefrontInstallationPackage, React, and the minimum project structure.ConfigurationDomain, API, theme, development, and deployment.CLIDevelopment, build, deployment, and generated files.Pages and routesFile routes, SSR loaders, layout, and serverApi.CartProvider, per-store session, and cart operations.DeploymentBuild and publishing to Cloudflare Workers.
Guides
These guides explain how to choose credentials, send the right context, and handle the differences between endpoints.
Set up an integrationCreate an OAuth application, request a token, and verify one call.AuthenticationChoose the flow and credentials for each API.Organization, store and sellerHow Admin and Storefront resolve a request's scope.PaginationCursor, page/pageSize, or limit depending on the operation.ErrorsError formats and conditions for a safe retry.Webhook eventsThe events, their models and your endpoint contract.