# OpenAPI documents

Machine-readable descriptions of the Factory Sales API v1, served byte-for-byte as they are generated from the contract. Each service below is a complete OpenAPI 3.0 document on its own — its paths, every schema they reference, bearer auth, servers, and the full API conventions text — sized to hand to an LLM (~5k–66k tokens) where the whole API (~160k tokens) is not.

## The whole API

- [factory_api_v1.openapi3.json](https://developer.factory.app/openapi/factory_api_v1.openapi3.json): the entire v1 contract as one OpenAPI 3.0 document (~160k tokens). Also served at https://developer.factory.app/openapi.json.
- [factory_api_v1.swagger.json](https://developer.factory.app/openapi/factory_api_v1.swagger.json): the same contract as a Swagger 2.0 document.

## One document per service

| Service | Description | Operations | Approx. tokens | Updated | File |
|---|---|---|---|---|---|
| Catalogue | Your product catalogue — the products, kits, and flashings you sell. | 6 | ~18k | 2026-09-16 | [catalogue.openapi3.json](https://developer.factory.app/openapi/services/catalogue.openapi3.json) |
| Company | Your company's settings and custom-field definitions — identity, currency and locale, the measurement system quantities are expressed in, tax context, and… | 2 | ~10k | 2026-09-16 | [company.openapi3.json](https://developer.factory.app/openapi/services/company.openapi3.json) |
| Customers | Your company's customers — the businesses you quote and sell to. | 3 | ~12k | 2026-09-16 | [customer.openapi3.json](https://developer.factory.app/openapi/services/customer.openapi3.json) |
| Inventory | Read and update stock levels for your catalogue products. Stock is tracked per product variant row, optionally split by colour. Each entry carries on-hand,… | 3 | ~10k | 2026-09-16 | [inventory.openapi3.json](https://developer.factory.app/openapi/services/inventory.openapi3.json) |
| Labels | The labels your company uses to tag orders. | 1 | ~5k | 2026-09-16 | [label.openapi3.json](https://developer.factory.app/openapi/services/label.openapi3.json) |
| Order statuses | The workflow statuses your company's orders move through. | 1 | ~5k | 2026-09-16 | [order-status.openapi3.json](https://developer.factory.app/openapi/services/order-status.openapi3.json) |
| Orders | Create sales orders, read and list them, upload flashing-drawing SVGs, and work with each order's conversation (messages and file attachments) — the order… | 15 | ~66k | 2026-09-17 | [order.openapi3.json](https://developer.factory.app/openapi/services/order.openapi3.json) |
| Quotes | Create quotes, read them, add, update, and remove their line items, upload flashing-drawing SVGs, and work with each quote's conversation (messages and file… | 15 | ~62k | 2026-09-17 | [quote.openapi3.json](https://developer.factory.app/openapi/services/quote.openapi3.json) |
| Search | Preview: free-text search across your catalogue. This service is in preview — published for early use, not yet covered by the compatibility guarantees in… | 1 | ~6k | 2026-09-16 | [search.openapi3.json](https://developer.factory.app/openapi/services/search.openapi3.json) |
| Suppliers | List your company's suppliers. Suppliers are managed in the Factory purchasing UI — this read-only surface lets API consumers discover supplier ids for use… | 2 | ~7k | 2026-09-16 | [supplier.openapi3.json](https://developer.factory.app/openapi/services/supplier.openapi3.json) |
| Users | The people in your company, for assigning work to. | 2 | ~7k | 2026-09-16 | [user.openapi3.json](https://developer.factory.app/openapi/services/user.openapi3.json) |
| Webhooks | Register HTTPS endpoints to be notified when orders and quotes change, and inspect what was delivered. | 8 | ~18k | 2026-09-16 | [webhook.openapi3.json](https://developer.factory.app/openapi/services/webhook.openapi3.json) |

This table is generated from the manifest at [https://developer.factory.app/openapi/services/index.json](https://developer.factory.app/openapi/services/index.json) — fetch that to enumerate the documents programmatically.

Every document carries the same operational contract in `info.description` — rendered once at [API conventions](https://developer.factory.app/conventions.md).

---

Source: https://developer.factory.app/openapi-documents · Factory Sales API v1