For engineering teams and AI assistants
Use the SDK to build experiences on your team's existing stack. The CLI supports administration and automation, with structured inputs and outputs that AI assistants can work with directly.
Architecture
The integration layer separates the customer experience from the business logic behind it, so your team can redesign the interface or add channels without rebuilding the commerce system.
Setup
Create the store and load your data once. Then connect the project, build the experience layer with the SDK, and run the store from the admin or the CLI. Each new storefront, landing page or app reuses the same store and data, starting straight from the connect step.
Create a store in the dashboard and issue access keys for your project. The store gives you your own data and business scope on the shared backend; products and content are loaded in the next step.
Bring products, categories, prices, images and content pages into the store: imported from a file, loaded through the CLI, or entered in the admin.
Add the SDK to the Next.js starter or an existing project, authenticate with the access keys, then read catalog, content and prices straight from the store. Subscribe to order events if an external workflow needs to follow along.
Build listing, detail, cart and checkout screens from typed methods, and design everything else freely. No matter how often the interface changes, the same backend stays behind it.
Handle orders, stock, promotions and content in the admin. Repetitive work can run through the CLI, or be handed to an AI assistant within its permitted scope: where supported, the assistant runs a preview and asks for confirmation before writing data.
Toolkit
The SDK is the development kit for the experience layer. The CLI handles supported administration and automation workflows and is structured for AI assistants to use.
Build commerce experiences quickly and consistently.
Administration and automation, structured for AI assistants.
Technical examples
The examples below illustrate how to read data with the SDK and structure an operations workflow through the CLI.
npx @ecomweb/cli setup
ecomweb products list --status activeimport { createEcomwebSdk } from "@ecomweb/sdk";
import { http } from "./http"; // any IHttpClient: fetch, axios, ky...
const sdk = createEcomwebSdk({ publicHttp: http, authHttp: http });
const product = await sdk.products.getBySlug("cua-hang-mau", "ao-linen", {
include_variants: true
});ecomweb agent "publish the linen collection and raise prices 10%"
→ ecomweb products list --collection ao-linen --status draft
8 products · 24 variants
→ ecomweb products update --collection ao-linen --price +10% --dry-run
24 variants would change · 0 open orders affected
? Apply these changes? [y/N] y
✓ ecomweb products update --collection ao-linen --price +10%
✓ ecomweb products publish --collection ao-linen
Done · undo with: ecomweb runs revert run_8f21Coding assistants and automated tasks must state their scope, use a dry run where supported, review the impact and obtain confirmation before important actions.
Next step
Start for free, or talk to us about the integration before you commit to it.