Introduction

Use the Amber Public API to read your brand’s catalog, sourcing, purchasing, logistics, finance, partners, documents, and reference libraries. Business endpoints are read-only and require an API key. Each request reads one brand.

Make your first request

Ask your Amber system administrator for an API key and your brand slug. Set AMBER_API_KEY and AMBER_BRAND in your server environment, then run:

curl --fail-with-body \
  -H "Authorization: Bearer $AMBER_API_KEY" \
  "https://app.amber.ai/api/public/v1/brands/$AMBER_BRAND"

The response identifies the authorized brand, even when its catalog is empty:

{"id":"00000000-0000-4000-8000-000000000001","slug":"acme","name":"Acme"}

Use the returned id for brand relationships and document subjects; use slug in request paths. Then read /brands/{brand}/products?limit=25. Collections return items, nextCursor, and totalItems, with a Link header when there is another page. The base URL is https://app.amber.ai/api/public/v1. The OpenAPI specification is the source for the API Reference tab and client generation. The brand is the slug from your Amber URL, for example acme in /b/acme. Use the key’s authorized brand. A successful first request returns HTTP 200; this check does not need any existing products or orders. If you receive 401, check the key and brand with your administrator. See Authentication for access and rate limits.

Build an integration

Choose a tutorial based on the result you need. Each includes runnable Node.js examples and explains how to retrieve records beyond the first page.

Your goal	Tutorial
Populate an ERP, PIM, or warehouse with products and sellable variations	Export Parent Products, Product Options, and SKUs
Assemble specifications with versions, BOMs, measurements, and related data	Read a complete product graph
Compare supplier offers by revision, SKU, quantity, and currency	Compare quotes and price breaks
Follow purchase orders through production, shipments, receipts, and payments	Track orders and fulfillment
Retrieve product files or supplier documents attached to an order	Download documents and images

Find the data you need

Area	Resources
Catalog	Parent Products, Product Options, SKUs, versions, BOMs, components, measurement tables, assignments, images
Sourcing and purchasing	Quotes, quote revisions/items/price bands, samples and rounds, orders/items/amendments, production runs and revisions
Logistics	Shipments/items/cartons/charges, legs, bookings, packing lists, allocations, inventory, goods receipts
Finance	Payment agreements, milestones, obligations, settlements, receipts, invoices and lines
Partners and shared data	Partners, Suppliers, contacts, locations, documents, notes, custom fields and reference libraries

Start with Product graphs, Entity relationships, and Pagination and errors. Every collection’s filters and exact response fields appear in the API Reference tab. For AI assistants and automation platforms that speak MCP, see Model Context Protocol (MCP). API-key MCP is available on the deployed API; browser OAuth connectors are documented there when they ship. Find known records with business identifier lookups, then use direct Quote navigation or productGraph() to retrieve their related data.

Get started

Tutorials

Read your data

Make your first request

Build an integration

Find the data you need

​Make your first request

​Build an integration

​Find the data you need

Make your first request

Build an integration

Find the data you need