Aggregate counts by status

Ops-dashboard rollup: how many items we hold for you in each lifecycle status.

GET/items/summary

Authorization

X-API-KeyAPI key · headerrequired

API key in format `sk_*`. Scoped to your partner account; server-side use only.

Responses

200Counts by status.

totalintegerrequired

by_statusobjectrequired

Show properties

receivedinteger

digitizedinteger

availableinteger

in_fulfillmentinteger

in_transitinteger

deliveredinteger

pending_transferinteger

releasedinteger

withdrawninteger

401Missing, invalid, expired, or environment-mismatched API key.

codeErrorCoderequired

Stable machine-readable error vocabulary for v1.

Allowed:validation_errorstate_conflictenvironment_mismatchunsupported_destinationinvalid_api_keynot_foundrate_limited

extraobjectrequired

Structured details such as field errors or SKU availability.

messagestringrequired

Human-readable summary.

429Rate limit exceeded for this API key.

codeErrorCoderequired

Stable machine-readable error vocabulary for v1.

Allowed:validation_errorstate_conflictenvironment_mismatchunsupported_destinationinvalid_api_keynot_foundrate_limited

extraobjectrequired

Structured details such as field errors or SKU availability.

messagestringrequired

Human-readable summary.

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

API keyRemember on this deviceInclude my values in samples

Request

curl -X GET "https://api.vault.stashtab.gg/v1/items/summary" \
  -H "X-API-Key: YOUR_API_KEY"

const response = await fetch("https://api.vault.stashtab.gg/v1/items/summary", {
  method: "GET",
  headers: {
    "X-API-Key": "YOUR_API_KEY"
  }
});

Response

{
  "total": 0,
  "by_status": {
    "received": 0,
    "digitized": 0,
    "available": 0,
    "in_fulfillment": 0,
    "in_transit": 0,
    "delivered": 0,
    "pending_transfer": 0,
    "released": 0,
    "withdrawn": 0
  }
}

{
  "code": "validation_error",
  "extra": {},
  "message": "string"
}

{
  "code": "validation_error",
  "extra": {},
  "message": "string"
}