Build on Stockpilot on Stockpilot for developers

Quickstart: your first request

Thu, 03 Sep 2026 00:00:00 +0000

Everything in this tutorial runs against the live API at https://api.stockpilot.dev. You need a Stockpilot account on the Growth tier or higher, because API access is gated to those plans.

Get a credential pair

Stockpilot authenticates with a static client ID and secret, not OAuth. In the Stockpilot app, open Settings → API and generate a pair. You get two values:

X-CLIENT-ID:     sp_live_a1b2c3d4e5f6
X-CLIENT-SECRET: sk_live_9f8e7d6c5b4a3210

The secret is shown once. Store it the way you would store a database password.

Receive your first webhook

Thu, 03 Sep 2026 00:00:00 +0000

Polling /inventory on a timer works until you have a few thousand SKUs. Webhooks invert it: Stockpilot pushes to an HTTPS endpoint you control, within seconds of the change.

By the end of this page you will have a local endpoint receiving signed, verified deliveries.

GET /webhooks/events

curl -s https://api.stockpilot.dev/webhooks/events \
  -H "X-CLIENT-ID: $SP_CLIENT_ID" \
  -H "X-CLIENT-SECRET: $SP_CLIENT_SECRET"

Today that returns two event types:

Event	Fires when
`orders.completed`	An order reaches the completed state, either by transitioning to it or by arriving already completed (a bol.com import, say). Once per order.
`inventory.stock_changed`	A product’s stock quantity changes in any warehouse.

Call this endpoint at runtime rather than hardcoding the list, so new event types appear without a redeploy on your side.

Order to label: fulfil an order end to end

Thu, 03 Sep 2026 00:00:00 +0000

This is the path most integrations end up walking: find work, ship it, record it. Six calls, one of which is asynchronous and one of which you must never blindly retry.

1. Find open orders

GET /orders

curl -s "https://api.stockpilot.dev/orders?status=open&page_size=20" \
  -H "X-CLIENT-ID: $SP_CLIENT_ID" \
  -H "X-CLIENT-SECRET: $SP_CLIENT_SECRET"

Order statuses are open, pending, on-hold, completed and cancelled.

2. Read the whole order

The list gives you a summary. Before shipping, pull the full record with line items, addresses and channel:

Build a low stock reorder bot

Thu, 03 Sep 2026 00:00:00 +0000

Stockpilot already knows your sales velocity, lead times and inbound stock. Rather than reimplementing that maths, you can ask it for recommendations and turn the answer into a purchase order.

Find what is running low

Start with the inventory list. Thresholds are expressed as either units (5u) or weeks of cover (33w), so an item is “low” relative to its own threshold rather than a global number.

GET /inventory

def low_stock(client, page_size=1000):
    page, out = 1, []
    while True:
        data = client.get("/inventory", params={"page": page, "page_size": page_size}).json()
        out.extend(i for i in data["results"] if i["quantity"] <= threshold_units(i))
        if len(data["results"]) < page_size:
            return out
        page += 1

One paginated call at page_size=1000 costs a single read-list request. Looping \/inventory\/get per SKU would cost hundreds of read-single requests for the same data, so prefer the list.

Give an AI agent warehouse access

Thu, 03 Sep 2026 00:00:00 +0000

Most APIs make an agent guess. Stockpilot publishes two machine-readable surfaces that are regenerated from the OpenAPI schema on every request, so they cannot fall out of date with the API they describe.

The two files that matter

File	What it is	When to use it
llms.txt	Compact index: auth rules, conventions, and one line per operation grouped by tag	Cheap to load. Start here in a coding session.
llms-full.txt	Every operation with parameters, request bodies, response codes and real example payloads	When the agent needs to construct an exact request.

Both are plain text. No SDK, no MCP server, no tool definitions to maintain. If your assistant can fetch a URL, it can use the Stockpilot API.

Sync offered stock to an ERP without double counting

Thu, 03 Sep 2026 00:00:00 +0000

Pushing stock into an ERP looks trivial until the seller adds a second warehouse. This tutorial builds a consumer that stays correct across warehouses, buffers and inbound purchase orders.

Read Receive your first webhook first if you have not set up a verified endpoint yet.

POST /webhooks/create

curl -s -X POST https://api.stockpilot.dev/webhooks/create \
  -H "X-CLIENT-ID: $SP_CLIENT_ID" \
  -H "X-CLIENT-SECRET: $SP_CLIENT_SECRET" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "erp stock sync",
    "url": "https://erp-bridge.example.com/hooks/stock",
    "event": "inventory.stock_changed",
    "secret": "'"$WEBHOOK_SECRET"'"
  }'

Leave warehouse_id off so you receive every change. Scoping to one warehouse filters which changes fire a delivery, but the body you receive is the full product payload either way.

Build on Stockpilot on Stockpilot for developers

Quickstart: your first request

Get a credential pair

Receive your first webhook

What you can subscribe to

Order to label: fulfil an order end to end

1. Find open orders

2. Read the whole order

Build a low stock reorder bot

Find what is running low

Give an AI agent warehouse access

The two files that matter

Sync offered stock to an ERP without double counting

Subscribe