# 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.
- [Account setup](https://developer.shelfcycle.com/guides/account-setup.md): Resolve references and create complete customer and supplier profiles with source-faithful records.
- [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.
- [Archive and restore](https://developer.shelfcycle.com/guides/archive-restore.md): Retire and restore selected company, contact, location, and product records safely.
- [Errors](https://developer.shelfcycle.com/guides/errors.md): The typed error envelope, repair metadata, and caller actions.
- [Entity Resolution](https://developer.shelfcycle.com/guides/entity-resolution.md): Match familiar business wording to an authorized ShelfCycle ID.
- [Tags](https://developer.shelfcycle.com/guides/tags.md): Maintain shared tags, organize records in batches, and verify current assignments.
- [Product Directory](https://developer.shelfcycle.com/guides/product-directory.md): Find products and product families by regulatory identity or one to 50 names.
- [Search](https://developer.shelfcycle.com/guides/search.md): Discover related records across several resource types.
- [Finders](https://developer.shelfcycle.com/guides/finders.md): Use narrowed root endpoints before exact detail reads.
- [Created records](https://developer.shelfcycle.com/guides/created-records.md): Find and group records by who entered them and when.
- [Opportunities](https://developer.shelfcycle.com/guides/opportunities.md): Create, maintain, close, and review customer and supplier opportunities.
- [Reference directory](https://developer.shelfcycle.com/guides/reference-directory.md): Page active customer and supplier matching hints for local caches.
- [Chart of Accounts](https://developer.shelfcycle.com/guides/chart-of-accounts.md): Find, create, and maintain accounts used by connected finance and supplier workflows.
- [Notes](https://developer.shelfcycle.com/guides/notes.md): List, read, create, and update notes for a selected record.
- [Note activity](https://developer.shelfcycle.com/guides/note-activity.md): Count, group, and review note activity across the organization.
- [Contacts](https://developer.shelfcycle.com/guides/contacts.md): Create, read, update, archive, and restore customer and supplier contacts.
- [Company profiles](https://developer.shelfcycle.com/guides/company-profiles.md): Create, update, archive, and restore 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): Build complete product records with packaging, attributes, relationships, identifiers, and documents.
- [Attached documents](https://developer.shelfcycle.com/guides/attached-documents.md): Upload, attach, and read files for selected products, customers, suppliers, and purchase orders.
- [Commercial documents](https://developer.shelfcycle.com/guides/commercial-documents.md): Find and read sales and purchase orders with fulfillment, receipt, line, and totals context.
- [Invoices, bills, and payments](https://developer.shelfcycle.com/guides/financial-records.md): Find and open receivables, payables, customer payments, and supplier payments.
- [Shipping Options](https://developer.shelfcycle.com/guides/shipping-options.md): Maintain freight terms, carriers, FOB terms, freight methods, and border crossing points.
- [Warehouses](https://developer.shelfcycle.com/guides/warehouses.md): Find, create, maintain, archive, and restore physical warehouses.
- [Inventory balances](https://developer.shelfcycle.com/guides/inventory-balances.md): Review current balances and exact stock-out counts by product and warehouse.
- [Lots](https://developer.shelfcycle.com/guides/lots.md): Find named lots, review exact quantities and COA readiness, and understand remaining-stock age.
- [Reorder status](https://developer.shelfcycle.com/guides/reorder-status.md): Set reorder points, then review status and the exact projected gap.
- [Certification Intelligence](https://developer.shelfcycle.com/guides/certifications.md): Find stored certification types, records, subjects, dates, and evidence filenames.
- [Purchase execution](https://developer.shelfcycle.com/guides/purchase-execution.md): Review open purchase lines by warehouse, receipt progress, receipt events, and purchase-order documents.
- [Reports](https://developer.shelfcycle.com/guides/reports.md): Review sales, purchasing, pipeline, and customer receivables intelligence.
- [Cost Book](https://developer.shelfcycle.com/guides/cost-book.md): Maintain cost schedules, corrections, mistaken-entry removal, approved batches, and Current Source.
- [Supplier History](https://developer.shelfcycle.com/guides/supplier-history.md): Review supplier products, purchase evidence, saved arrangements, and current cost context.
- [Price Book](https://developer.shelfcycle.com/guides/price-book.md): Review configured sale prices, schedules, history, and exact single-price updates.