List items

Everything we hold for you — stored, in fulfillment, or in flight — paginated and filterable. Items appear here the moment they complete intake; nothing exists until it is in the warehouse system.

GET/items

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

statusItemStatus

Allowed:receiveddigitizedavailablein_fulfillmentin_transitdeliveredpending_transferreleasedwithdrawn

skustring

Filter by SKU (partial match).

cert_numberstring

Exact grader certification number.

graderstring

manifest_idstring<uuid>

Only items matched to lines of this manifest.

searchstring

Free-text search over name and SKU.

intake_afterstring<date-time>

intake_beforestring<date-time>

sort_bystring

default: "intake_at"

Allowed:intake_atupdated_at

sort_dirstring

default: "desc"

Allowed:ascdesc

Responses

200Paginated items.

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

resultsItem[]required

Show properties

Array of Item

One of:

GradedSlabItem

active_fulfillment_idstring<uuid> | null

The fulfillment currently holding this item, if any.

categorystring

Item category.

external_refstring | null

Your identifier for this item, echoed from the manifest line when matched.

image_assetsImageAsset[]required

Per-item intake imagery for graded slabs or catalog imagery for product items.

Show properties

Array of ImageAsset

variantstringrequired

Which view of the slab this asset shows.

Allowed:frontbacklabel

urlstring<uri>required

Permanent CDN URL.

widthintegerrequired

Pixel width.

heightintegerrequired

Pixel height.

formatstringrequired

Allowed:webpjpegpng

intake_atstring<date-time>required

When the item completed intake and entered the system.

manifest_line_idstring<uuid> | null

The expected-manifest line this item matched at intake, if any.

model_3dstring<uri> | null

Reserved for future render assets and always null today so clients can keep a stable schema.

namestringrequired

Display name, clean enough to show to your end customers.

qidQIDrequired

Vault's canonical identifier for one physical item. It is assigned at intake and remains stable for the item's lifetime.

setstring | null

card_numberstring | null

skustringrequired

Warehouse SKU. Product items reference the partner catalog; graded slabs use their graded-item SKU.

statusItemStatusrequired

Custody lifecycle for one physical item. New statuses may be added compatibly within v1.

Allowed:receiveddigitizedavailablein_fulfillmentin_transitdeliveredpending_transferreleasedwithdrawn

typestringrequired

Allowed:graded_slab

updated_atstring<date-time>required

cert_numberstringrequired

Grader certification number.

gradestringrequired

graderstringrequired

Grading company.

ProductItem

active_fulfillment_idstring<uuid> | null

The fulfillment currently holding this item, if any.

categorystring

Item category.

external_refstring | null

Your identifier for this item, echoed from the manifest line when matched.

image_assetsImageAsset[]required

Per-item intake imagery for graded slabs or catalog imagery for product items.

Show properties

Array of ImageAsset

variantstringrequired

Which view of the slab this asset shows.

Allowed:frontbacklabel

urlstring<uri>required

Permanent CDN URL.

widthintegerrequired

Pixel width.

heightintegerrequired

Pixel height.

formatstringrequired

Allowed:webpjpegpng

intake_atstring<date-time>required

When the item completed intake and entered the system.

manifest_line_idstring<uuid> | null

The expected-manifest line this item matched at intake, if any.

model_3dstring<uri> | null

Reserved for future render assets and always null today so clients can keep a stable schema.

namestringrequired

Display name, clean enough to show to your end customers.

qidQIDrequired

Vault's canonical identifier for one physical item. It is assigned at intake and remains stable for the item's lifetime.

setstring | null

card_numberstring | null

skustringrequired

Warehouse SKU. Product items reference the partner catalog; graded slabs use their graded-item SKU.

statusItemStatusrequired

Custody lifecycle for one physical item. New statuses may be added compatibly within v1.

Allowed:receiveddigitizedavailablein_fulfillmentin_transitdeliveredpending_transferreleasedwithdrawn

typestringrequired

Allowed:product

updated_atstring<date-time>required

cert_numberstring | nullrequired

Allowed:null

gradestring | nullrequired

Allowed:null

graderstring | nullrequired

Allowed:null

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

Base URLCustom base URLOverrides the selected server when set.

Authorization

API keyRemember on this deviceInclude my values in samples

Parameters

pagequeryPage number (1-based).page_sizequeryItems per page.statusqueryskuqueryFilter by SKU (partial match).cert_numberqueryExact grader certification number.graderquerymanifest_idqueryOnly items matched to lines of this manifest.searchqueryFree-text search over name and SKU.intake_afterqueryintake_beforequerysort_byquerysort_dirquery

Request

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

const response = await fetch("https://api.vault.stashtab.gg/v1/items", {
  method: "GET",
  headers: {
    "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": [
    {
      "active_fulfillment_id": "bcb367cb-b94e-4e20-973d-e3de4f574083",
      "category": "sports-card",
      "external_ref": "string",
      "image_assets": [
        {
          "variant": "front",
          "url": "http://example.com",
          "width": 0,
          "height": 0,
          "format": "webp"
        }
      ],
      "intake_at": "2019-08-24T14:15:22Z",
      "manifest_line_id": "e1bcc1ed-284d-4866-b8d7-5633b41d43ea",
      "model_3d": "http://example.com",
      "name": "2018 Panini Prizm Luka Doncic",
      "qid": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "set": "2018-19 Panini Prizm",
      "card_number": "280",
      "sku": "string",
      "status": "available",
      "type": "graded_slab",
      "updated_at": "2019-08-24T14:15:22Z",
      "cert_number": "string",
      "grade": "string",
      "grader": "string"
    }
  ]
}

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

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

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