Avvyr API

Build for
Commerce.Storefronts.Point of Sale.Integrations.Automation.

REST APIs, image CDN, and AI-powered tools for building on Avvyr.

Get started Explore APIs

APIs

Storefront API

Product search, cart, checkout, and order tracking.

RESTPublic

Management API

Products, inventory, orders, and platform config.

RESTAuthenticated

Assets API

Image rendering, transforms, and CDN delivery.

CDNImages

MCP Server

AI Tool

Real-time API docs for your AI assistant.

Storefront Flow

storefront flow
// Authenticate with a Storefront Token (JWT)
const headers = {
  'x-api-key': STOREFRONT_TOKEN
}

// Token payload — scopes + tenant baked in
{
  "tenantId": "676140c4...",
  "scopes":   ["storefront"]
}

Token Authentication

One JWT Storefront Token per tenant. Embeds tenant ID and scopes — no server needed for reads.

Full-text Search

Elasticsearch-backed product search with sorting, pagination, and faceted filtering.

Cart with Access Tokens

Carts return a one-time access token. Store it server-side as an httpOnly cookie for security.

CDN Image Transforms

Pipe any product image through Assets API — resize, crop, convert, and optimize via query params.

Guides & references

Storefront API Reference

Interactive explorer — try requests live

Cart & Checkout

Create carts, add items, apply discounts

Management API Reference

Products, orders, inventory, customers

Image Transforms

Resize, crop, format — via URL params

MCP Setup — VS Code

Connect your AI assistant in minutes

MCP Examples

Explore an API, build features, review code

Best Practices

Performance tips & responsive images

Nuxt Integration

Drop-in image component for Nuxt

Custom Domains

Serve assets from your own domain

Code examples

See the APIs in action

Authenticated with a Storefront Token, no server needed for reads. Pipe images through the Assets CDN for instant transforms.

product.ts
// Get a product by its URL handle
const res = await fetch(
  'https://api.avvyr.com/v1/storefront/se/products/handle/lounge-chair-uno',
  { headers: { 'x-api-key': STOREFRONT_TOKEN } }
)
const product = await res.json()

// Optimized thumbnail via Assets API
const thumb = product.primaryImage
  + '?width=400&fit=contain&fm=webp&q=80'
Copyright © 2026