Keychain OS API

The Keychain OS API gives you read-only access to the data inside your Keychain OS manufacturing ERP — product formulations, raw-material pricing, inventory movements, supplier records, production costs, and order history. Use it to build internal reports, cost calculators, dashboards, and integrations with your existing tools.

The API is organized around REST. It returns JSON-encoded responses, uses standard HTTP response codes, and authenticates via an API key passed in the X-API-Key header. Every response is scoped to your organization — the API key determines which manufacturer's data you can access.

All list endpoints return paginated results. Control page size with limit (max 100) and navigate with offset. Each response includes a pagination object with the total record count.

Domains

Domain	What it covers
SKUs	All information on finished-product definitions — including recipes with ingredient quantities and units, step-by-step production instructions, batch sizes, allergen restrictions, nutritional information, item type classification, and version history. Each SKU is an immutable versioned snapshot so work orders always reference the exact spec they were produced against.
Items	All information on raw materials, ingredients, and packaging — including default pricing, unit of measure, shelf life, perishable flags, storage requirements, allergen declarations, category classification, reorder thresholds, linked vendor details with vendor-specific codes and pricing, recipe usage across SKUs, and full purchasing and cost history over time.
Vendors	All information on supplier accounts — including company details, contacts, shipping and billing addresses, tax identification numbers, payment terms, vendor status, item catalogs with vendor-specific codes, pricing, and minimum order quantities, purchase order history, and vendor performance stats such as total PO count, total spend, average lead time, and on-time delivery percentage.
Customers	All information on customer accounts — including company details, contacts, shipping and billing addresses, payment terms, linked SKUs they order, and complete sales order history with order statuses and financial summaries.
Inventory	All information on inventory movements — the full movement ledger tracking every intake, outtake, adjustment, transfer, and return, each referencing its source record (purchase order, work order, sales order) for complete traceability. Includes lot and batch details, quantities, units, facility and storage-level tracking, and timestamps.
Work Orders	All information on production runs — including scheduling, priority, batch counts, batch volume, SKU version being produced, work order status, expected vs. actual costing breakdowns for materials, labor, and overhead, per-material variance analysis, loss and waste metrics, and detailed material consumption records down to the lot level.
Purchase Orders	All information on procurement transactions — including line items with quantities, unit pricing, and tax, receiving status per line (pending / partially received / fully received), shipping and billing addresses, payment terms, currency, and complete financial totals with subtotal, tax amount, discounts, shipping cost, and grand total.
Sales Orders	All information on customer orders — including line items with SKU references, quantities, and pricing, delivery dates, order status, payment terms, and complete financial totals with subtotal, tax, discounts, and grand total for customer fulfillment tracking.