# ShelfCycle Developer API Guides

Markdown mirrors for the ShelfCycle Developer API guide pages.

Reference markdown: https://developer.shelfcycle.com/reference.md
OpenAPI JSON: https://developer.shelfcycle.com/openapi.json
llms.txt: https://developer.shelfcycle.com/llms.txt

- [Quickstart](https://developer.shelfcycle.com/guides/quickstart.md): Verify a key, resolve records, preflight, and execute a supported write.
- [Authentication](https://developer.shelfcycle.com/guides/authentication.md): Bearer keys, required headers, and key verification.
- [Scopes](https://developer.shelfcycle.com/guides/scopes.md): Capability ceilings, effective access, and live permission checks.
- [Idempotency](https://developer.shelfcycle.com/guides/idempotency.md): Stable write keys for safe retries.
- [Write readiness](https://developer.shelfcycle.com/guides/write-readiness.md): Use optional dryRun checks before supported writes.
- [Errors](https://developer.shelfcycle.com/guides/errors.md): The typed error envelope, repair metadata, and caller actions.
- [Search](https://developer.shelfcycle.com/guides/search.md): Resolve ambiguous records into typed candidate cards.
- [Finders](https://developer.shelfcycle.com/guides/finders.md): Use narrowed root endpoints before exact detail reads.
- [Reference directory](https://developer.shelfcycle.com/guides/reference-directory.md): Page active customer and supplier matching hints for local caches.
- [Notes](https://developer.shelfcycle.com/guides/notes.md): List, read, create, and update CRM notes.
- [Contacts](https://developer.shelfcycle.com/guides/contacts.md): Create, read, and update customer and supplier contacts.
- [Company profiles](https://developer.shelfcycle.com/guides/company-profiles.md): Create and update bounded customer and supplier profiles.
- [Locations and addresses](https://developer.shelfcycle.com/guides/location-addresses.md): Manage customer locations, customer addresses, and supplier ship-from locations.
- [Product setup](https://developer.shelfcycle.com/guides/product-setup.md): Use setup references and bounded product catalog writes safely.
- [Attached documents](https://developer.shelfcycle.com/guides/attached-documents.md): List and attach parent-scoped document links for selected records.
- [Commercial documents](https://developer.shelfcycle.com/guides/commercial-documents.md): Read order headers, lines, totals, costs, and permitted margin details.
- [Reports](https://developer.shelfcycle.com/guides/reports.md): Discover and run governed sales, purchasing, and open-order rollups.
- [Cost Book](https://developer.shelfcycle.com/guides/cost-book.md): Read, compare, and maintain direct and constructed product costs.