APIs
The Avvyr platform exposes several APIs, each designed for a specific use case. Pick the one that fits your integration scenario.
Management API
The primary API for back-office operations
Complete control over the Avvyr commerce platform. Manage products, inventory, orders, customers, business units, registers, automation rules, integrations, and more. This is the API you'll use for most server-side integrations, admin tooling, and data synchronization.
Authentication
Bearer token (JWT) with tenant-scoped access
Use cases
Storefront API
Public-facing, read-heavy API for customer experiences
Designed for frontend applications — e-commerce sites, mobile apps, and kiosks. Handles product search, category browsing, cart management, checkout flows, and order tracking. Authenticated with a lightweight Storefront Token that embeds tenant ID and scopes.
Authentication
Storefront Token via x-api-key header
Use cases
Assets API
On-the-fly image rendering, transformation, and CDN delivery
Resize, crop, convert, and optimize images by simply adding query parameters to any image URL. No pre-processing or build step required — transformations happen at the edge and are cached globally.
Authentication
Public — images served via CDN
Use cases
Integrations API
Separate licenseManaged integration platform with transaction tracking
Event-driven platform for connecting Avvyr to external systems. Handles outbound event routing to pre-built connectors and provides a custom inbound endpoint for pushing data into Avvyr. Includes transaction tracking, automatic retries, manual resubmission, and detailed logging.
Authentication
Bearer token for config; API key for custom inbound
Use cases
Events API
Subscribe to domain events and receive real-time delivery
Register subscriptions for domain events — order created, product updated, cart completed, and more. When a matching event fires, Avvyr delivers it to your endpoint with configurable authentication (none, basic, bearer, or HMAC) and optional retries with exponential backoff.
Authentication
Bearer token for subscription management
Use cases
MCP Server
AI-powered API discovery for coding assistants
Give your AI coding assistant real-time access to Avvyr API documentation. Exposes tools for searching endpoints, inspecting schemas, and reading documentation — all from within your editor.
Authentication
Avvyr API key
Use cases