Guides
Platform guides
How Stockpilot behaves once you wire several endpoints together: credentials, rate limits, the inventory model, the order lifecycle, shipping, purchasing, channels and the webhook contract.
The API reference tells you what each endpoint accepts and returns. These explain the rest.
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.
ReadAPI conventions
The two pagination envelopes, sorting, dates, identifiers, location and threshold formats, error shapes and async operations. The rules that apply across every endpoint.
ReadRate limits and idempotency
The four rate limit buckets, what the response headers mean, which three endpoints take an Idempotency-Key, and exactly which calls are safe to retry after a timeout.
ReadThe 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.
ReadAssemblies
Items built from other items: how buildable_quantity is derived, what assemble and disassemble actually move, and how assemblies differ from bundles.
ReadOrders and fulfilment
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.
ReadShipping and labels
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.
ReadPurchasing and inbound deliveries
Suppliers, drafts and publishing, 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.
ReadSales channels and returns
Which marketplaces connect, what the API can and cannot do with them, and how returns are filtered and paginated differently from everything else.
ReadWebhook delivery contract
All eight events, the envelope, HMAC signature verification, the retry ladder, coalescing, auto deactivation and multi-tenant patterns. Everything a production consumer needs.
Read
Stuck on something
Ask a person, not a search box
The API surface is wide, and some of it only makes sense once someone explains why it works that way. If a payload is not doing what you expect, or you are weighing two approaches, say so and we will look at it with you.