Developers

Cartlynq API v1

Use scoped API keys to read business data for approved integrations. API v1 does not expose write operations.

Authentication

Business owners create keys in Settings → Developer. Send the key in the x-api-key header. Keys are business-scoped, permission-scoped, rate-limited, and can be revoked.

Endpoints

GET /api/v1/ordersGET /api/v1/customersGET /api/v1/productsGET /api/v1/inventoryGET /api/v1/branches

Use limit from 1–100 and the returned nextCursor value for pagination.

Machine-readable resources