</> Developers

Anything you do in EcomWeb, you can do through the API.

The admin runs on this same API. Use it to build a storefront with the SDK, hand day-to-day operations to AI agents through the CLI, and deploy your theme with one command.

Start for free Read the API docs

Admin

for merchants

Storefront

@ecomweb/sdk

AI agents, CI

@ecomweb/cli

EcomWeb API

REST, described with OpenAPI. Access keys with scopes.

ProductsInventoryOrdersCustomersPromotionsContentThemesReports

One API for the whole store.

A storefront API and an admin API, both described with OpenAPI. Included in every plan, Free too.

Catalog

Products, variants, attributes, collections and inventory.

Sales

Orders, customers, promotions and shipping rates.

Content

Pages, blog posts, menus, banners and custom data.

Website and reports

Themes, domains, revenue and Google Analytics.

Every access key has its own scope: which data, read only or not, allowed IP addresses and an expiry date.

Read the API docs →

Storefront

Build your storefront with the SDK.

Drop it into any Next.js or JavaScript project. The SDK ships TypeScript types for everything a store needs.

Catalog, search, cart, checkout and customer accounts
Content pages, menus, blog, SEO and redirect rules
Use fetch, axios or ky. The SDK does not force an HTTP library on you
ecomweb storefront init sets up a Next.js project already connected to your store

Fetch a product

import { createEcomwebSdk } from "@ecomweb/sdk";
import { http } from "./http"; // your own fetch, axios, ky...

const sdk = createEcomwebSdk({
  publicHttp: http,
  authHttp: http,
});

const product = await sdk.products.getBySlug(
  "723e6d4a", // store ID
  "ao-thun-basic",
  { include_variants: true },
);

Operations with AI agents

The agent does the work. You approve.

The CLI is built for AI agents. Claude Code, Codex or your own automations use it to add stock, change prices, process orders and read reports.

Output as JSON, CSV or a table, with only the fields the agent needs
ecomweb describe shows the agent the shape of the data before it writes
Every write command can run as a test first with --dry-run
A plugin for Claude Code and a skill for Codex
Each key can only do the work it was granted

Guide for AI agents See the commands

Terminal

# Products running low, as JSON for the agent
$ ecomweb products list \
    --inventory-status low_stock --output json

# The agent checks the data shape before writing
$ ecomweb describe products --operation update

# Test run. Nothing is written to the store yet
$ ecomweb products batch-update \
    --file new-prices.json --dry-run

$ ecomweb deployDeploying

Upload the source codeupload
EcomWeb builds the new versionnext build
Preview is readypreview
Go live--allow-live

A preview for every pull request

Check it before you publish

Open the preview →

Deploy with the CLIFrom the Growth plan

From your laptop to live with one command.

Write the storefront on your machine and EcomWeb builds and runs it. No servers to look after.

ecomweb deploy creates a preview that lasts 24 hours. Put it live once it looks right
Add it to CI: every pull request gets a preview, and a push to main goes live
ecomweb logs follows the build, deployments rollback goes back to the last version
Manage environment variables with ecomweb env

On your own servers, any plan works. Compare plans →

Get started from the terminal.

The admin is still there whenever you want it.

Step 1
Sign in
ecomweb auth login --email. A sign-in code arrives by email, no password needed.
Step 2
Create a store
ecomweb init creates a store and an API key for your project.
Step 3
Get a storefront
ecomweb storefront init creates a Next.js project already connected to your store.
Step 4
Go live
ecomweb deploy, or run it on your own servers.

Start building on real data.

Create a free store, get an access key and make your first API call in the same afternoon.