# Stockpilot for developers

> Build on Stockpilot. REST API, signed webhooks and a single-binary CLI for inventory, orders, shipping and analytics across every sales channel.
> Site: /
> API base URL: https://api.stockpilot.dev

## API reference

The full REST reference is generated from the live OpenAPI schema (74 operations, v1.1.0):

- [API index for LLMs](https://api.stockpilot.dev/llms.txt): compact list of every operation, grouped by tag.
- [Full API reference for LLMs](https://api.stockpilot.dev/llms-full.txt): every operation with parameters, request bodies and response examples.
- [OpenAPI schema](https://api.stockpilot.dev/openapi.json): machine-readable JSON.
- [ReDoc](https://api.stockpilot.dev/redoc): human-readable reference, rendered client-side.

Authentication: send `X-CLIENT-ID` and `X-CLIENT-SECRET` headers on every request.
Verify a credential pair with `GET https://api.stockpilot.dev/auth/who-is`.

## Tutorials

- [Quickstart: your first request](/build/quickstart/): Generate an API key, verify it, and read your first page of inventory, in about five minutes.
- [Receive your first webhook](/build/first-webhook/): Register an endpoint, fire a test delivery, and verify the HMAC signature correctly, including the mistake that breaks almost every first attempt.
- [Order to label: fulfil an order end to end](/build/order-to-label/): Pick an open order, choose a carrier, request a label, poll for the PDF and mark the order fulfilled, including the retry trap that can buy you two labels.
- [Build a low stock reorder bot](/build/reorder-bot/): Find items running out, ask Stockpilot for purchase order recommendations, and raise the PO. Covers the async task pattern and the heavy rate limit bucket.
- [Give an AI agent warehouse access](/build/ai-agents/): Point Claude, Cursor or Codex at llms.txt and the shipped SKILL.md, give it a read-only profile, and let it answer stock questions safely.
- [Sync offered stock to an ERP without double counting](/build/erp-stock-sync/): Consume inventory.stock_changed, read the right field across multiple warehouses, and avoid the inbound double count that skews every naive integration.

## Platform guides

- [Authentication](/docs/authentication/): How Stockpilot API credentials work: the two headers, what a 401 versus a 403 means, plan gating, and how to handle credentials when you serve many merchants.
- [API conventions](/docs/conventions/): Pagination, dates, identifiers, location and threshold formats, error shapes and async operations. The rules that apply across every endpoint.
- [Rate limits and idempotency](/docs/rate-limits/): The four rate limit buckets, what the response headers mean, and exactly which calls are safe to retry after a timeout.
- [The inventory model](/docs/inventory-model/): Why quantity, offered stock and incoming differ, how warehouses feed the offer, and which number to send to a channel or an ERP.
- [Orders and fulfilment](/docs/orders/): The order lifecycle: statuses, editing line items, backorders, cancellation requests, forwarding and book-back. What each state actually means and which transitions are safe to automate.
- [Shipping and labels](/docs/shipping/): Carriers, label templates including the virtual Bol.com and letter ones, the shipping rule suggestion, and the two step async label flow that must never be blindly retried.
- [Purchasing and inbound deliveries](/docs/purchasing/): Suppliers, forecast driven recommendations, and booking goods in with parcels. Includes the two fields that actually tell you whether stock arrived, and why status is not one of them.
- [Sales channels and returns](/docs/sales-channels/): Which marketplaces connect, what the API can and cannot do with them, and how returns are filtered and paginated differently from everything else.
- [Webhook delivery contract](/docs/webhooks/): Events, envelope, HMAC signature verification, the retry ladder, coalescing, auto deactivation and multi-tenant patterns. Everything a production consumer needs.

## Command line

- Install: `curl -fsSL /install | sh`
- Source: https://github.com/StockpilotHQ/stockpilot-cli