Skip to main content
Documentation

Inventory

inventory.purchase_orders

List the purchase orders bringing new rolls and stock in
Read-onlyRead budget

REST

Shipping
POST /api/v1/inventory/purchase_orders

MCP tool

Live
inventory.purchase_orders

Exposed on: REST API · Shop MCP server · Claude connector · Dash (in-app copilot) · Zapier. Part of the Inventory domain.

Operating contract

What the shop has on order, with the vendor, what it is worth, when it is expected and how far along it is.

status is DERIVED from the order's own timestamps and its lines rather than typed in: a draft that has not been sent, a sent order waiting, a partially received one, or a complete one. That derivation is shared with the screen, so this and /inventory/purchase-orders cannot disagree.

expected_on versus today is the useful comparison, and a sent order past its expected date with nothing received is the finding worth raising — that is a vendor to chase, and nothing else in the product will mention it.

lines names what was ordered and how much of each has actually arrived. A line with received_quantity below quantity is a short shipment.

READ ONLY. Raising, sending, receiving and cancelling an order are all absent: sending one commits the shop to buy from a vendor, and receiving one asserts that boxes physically arrived.

TRUNCATION: total is the exact number of matching orders and omitted is how many are not here. When omitted is not 0, call again with offset set to next_offset.

Who may call it

Permission
inventory.accessThe caller must hold Inventory at the ACT level. A read-only dashboard grant on the same section is refused.
Plan
Every planNo plan gate. Available on every Service VIN plan.
Retries
naturalNaturally idempotent — running it twice leaves the same world as running it once. A retrying integration needs no key.
Rate class
readCounted against the read budget — the widest of the four.

Partial answers

omitted is how many matching records are not in the response, and 0 is a real answer meaning you have all of them. Continue with next_offset.

Do not summarise from a truncated response

When `omitted` is not 0 there are more purchase orders. Call again with `offset` set to `next_offset`.

Input

FieldTypeDescription
open_onlyboolean

True returns only orders that are not fully received or cancelled.

limitinteger1–100

How many orders to return, 1-100. Defaults to 25.

Default: 25
offsetintegermin 0

How many to skip. Pass the previous response's next_offset to continue.

Default: 0

Output

FieldTypeDescription
itemsobject[]

items[].idstring

items[].po_numbernumber

items[].vendorstring

items[].statusstring

items[].subtotalnumber

items[].totalnumber

items[].expected_onstring | null

items[].sent_atstring | null

items[].received_atstring | null

items[].created_atstring

items[].linesobject[]

items[].lines[].descriptionstring

items[].lines[].quantitynumber

items[].lines[].received_quantitynumber

items[].lines[].unit_costnumber

totalnumber

omittednumber

next_offsetnumber | null

Examples

Built from this capability's own schema — required fields and the ones carrying a default, and nothing invented. Paste one and it validates.

curl
export SERVICEVIN_API_KEY=svk_live_…

curl -X POST https://www.servicevin.com/api/v1/inventory/purchase_orders \
  -H "Authorization: Bearer $SERVICEVIN_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"limit":25,"offset":0}'

TypeScript (fetch)
const res = await fetch("https://www.servicevin.com/api/v1/inventory/purchase_orders", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.SERVICEVIN_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "limit": 25,
    "offset": 0
  }),
});

// Success and failure are both envelopes. Switch on error.code, never
// on error.message — the codes are stable, the messages are for people.
const payload = await res.json();
if (!res.ok) throw new Error(payload.error.code);
const data = payload.data;

Python (requests)
import os, requests

res = requests.post(
    "https://www.servicevin.com/api/v1/inventory/purchase_orders",
    headers={"Authorization": f"Bearer {os.environ['SERVICEVIN_API_KEY']}"},
    json={
    "limit": 25,
    "offset": 0
},
    timeout=30,
)
payload = res.json()
if not res.ok:
    raise RuntimeError(payload["error"]["code"])
data = payload["data"]

MCP tools/call — https://www.servicevin.com/api/mcp
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "inventory.purchase_orders",
    "arguments": {
      "limit": 25,
      "offset": 0
    }
  }
}

Refusals

The four gates run in this order on every surface, and the order is not arbitrary — see Authentication.

StatusCodeWhen
404not_foundThe id is unknown, or the feature is not enabled for this account. Deliberately the same answer for both.
403forbiddenThis login does not hold inventory.access.
422validation_errorAn argument was wrong. The message names the field.
429rate_limitedToo many read calls. Back off and retry.
500internal_errorSomething failed on our side. Nothing was changed.