API Reference Overview

The Endpoint Explorer is generated from the canonical OpenAPI contract. It shows parameters, schemas, responses, and curl examples. Live browser requests are disabled during controlled Beta.

The API is rooted at /api/v1. The planned production origin is https://api.freshlycart.com; it is not publicly deployed.

Family	Operations
Merchant, locations	Read merchant; list/get granted locations
Catalog	List/get/create/update products and categories
Inventory	List levels and movements; get movement; create adjustment
Customers	List/get/create/update
Orders	List/get; create unpaid draft
Payments, suppliers, purchases, invoices	Read-only list/get
Events	Chronological reconciliation and bounded recent mode

Every operation declares its required scope in OpenAPI with x-required-scope.