Skip to content
Stashtab Vault API
Esc
↑↓navigate↵open⌘Jpreview

List SKU inventory levels

Computed SKU stock levels with no warehouse dimension.

GET/inventory
Authorization
X-API-KeyAPI key · headerrequired
API key in format `sk_*`. Scoped to your partner account; server-side use only.
Query parameters
pageinteger
Page number (1-based).
min 1 · default: 1
page_sizeinteger
Items per page.
min 1 · max 250 · default: 25
skustring
Responses
200Paginated SKU inventory levels.
page_sizeintegerrequired
Requested page size.
countintegerrequired
Items in this page.
totalintegerrequired
Total items across all pages.
current_page_numberintegerrequired
next_page_numberinteger | null
nextstring<uri> | null
URL of the next page.
previousstring<uri> | null
previous_page_numberinteger | null
resultsInventoryLevel[]required
Show properties
Array of InventoryLevel
allocatedintegerrequired
min 0
availableintegerrequired
min 0
on_handintegerrequired
min 0
skustringrequired
400Validation failed.
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.
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
Authorization
Parameters
Request
curl -X GET "https://api.vault.stashtab.gg/v1/inventory" \
  -H "X-API-Key: YOUR_API_KEY"
Response
{
  "page_size": 0,
  "count": 0,
  "total": 0,
  "current_page_number": 0,
  "next_page_number": 0,
  "next": "http://example.com",
  "previous": "http://example.com",
  "previous_page_number": 0,
  "results": [
    {
      "allocated": 0,
      "available": 0,
      "on_hand": 0,
      "sku": "string"
    }
  ]
}