What are you building?

Every path starts with a call that works. Choose by what you want to do, not by the API name.

Sell in your own storePages, catalog, cart and checkout with the Storefront SDK.Storefront SDK Connect your system or ERPProducts, inventory, orders and fulfillment from your backend.Admin API Authenticate users and appsRegistration, sessions and OAuth 2.0 tokens.Auth API Sell through agentsDiscovery, cart and checkout for shopping assistants.UCP API

Your first call

An application token and one catalog read. That is all it takes to be in.

# 1. Application token (Auth API)
curl -X POST https://auth.ecomiq.pe/connect/token \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=client_credentials" \
  -d "client_id=$ECOMIQ_CLIENT_ID" \
  -d "client_secret=$ECOMIQ_CLIENT_SECRET" \
  -d "scope=api_admin"

# 2. First catalog read (Admin API)
curl "https://api.ecomiq.pe/api/v1/catalog/products?limit=25" \
  -H "Authorization: Bearer $ECOMIQ_TOKEN"

Get credentials How pagination works Errors

Reference

v1Changes

Admin API413 operationsCatalog, inventory, customers, orders, fulfillment and payments.Storefront API71 operationsPublic catalog, carts, checkout and customer accounts.Auth API17 operationsUser registration, sessions and token issuance.UCP API15 operationsProfiles, catalog, carts, and checkout for agents.

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.

InstallationPackage, 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.

Explore the SDK

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.