List fulfillments

Filterable, paginated fulfillment history. Look up by QID (single or bulk via qids), by your own external_ref, by status, or by date — this doubles as the bulk status endpoint.

GET/fulfillments

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

statusFulfillmentStatus

Allowed:pendingprocessingshippeddeliveredcancelledexceptionreturned

qidQID

Fulfillments containing this item.

qidsstring

Comma-separated QIDs for bulk status lookup.

external_refstring

Exact match on your reference.

created_afterstring<date-time>

created_beforestring<date-time>

Responses

200Paginated fulfillments, newest first.

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

resultsFulfillment[]required

Show properties

Array of Fulfillment

idstring<uuid>required

qidsQID[]required

statusFulfillmentStatusrequired

Fulfillment lifecycle. Returned means custody has resumed and the item will repeat intake.

Allowed:pendingprocessingshippeddeliveredcancelledexceptionreturned

processing_stageProcessingStage | null

Warehouse sub-stage while status is processing. It may be null when granular telemetry is unavailable; status is always authoritative.

Allowed:pickedpackedverifiedlabeledqueued_for_carrier

shipping_addressShippingAddress | any

Show properties

Any of:

ShippingAddress

recipient_namestringrequired

streetstringrequired

street_2string | null

citystringrequired

statestringrequired

zipstringrequired

countrystringrequired

any

any

carrierstring | null

Carrier code once the label exists.

servicestring | null

Service code once the label exists.

tracking_numberstring | null

tracking_urlstring<uri> | null

issueFulfillmentIssue | any

Show properties

Any of:

FulfillmentIssue

codestringrequired

Machine-readable issue type.

messagestringrequired

occurred_atstring<date-time>required

any

any

external_refstring | null

created_atstring<date-time>required

updated_atstring<date-time>required

typeFulfillmentTyperequired

Allowed:standardwithdrawal

special_instructionsstring | null

deliver_bystring<date> | null

verified_address_idstring<uuid> | 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.statusqueryqidqueryFulfillments containing this item.qidsqueryComma-separated QIDs for bulk status lookup.external_refqueryExact match on your reference.created_afterquerycreated_beforequery

Request

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

const response = await fetch("https://api.vault.stashtab.gg/v1/fulfillments", {
  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": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "qids": [
        "7c9e6679-7425-40de-944b-e07fc1f90ae7"
      ],
      "status": "shipped",
      "processing_stage": "picked",
      "shipping_address": {
        "recipient_name": "Jordan Alvarez",
        "street": "480 Cedar St",
        "street_2": "Apt 12",
        "city": "Austin",
        "state": "TX",
        "zip": "78701",
        "country": "US"
      },
      "carrier": "usps",
      "service": "usps_priority_mail",
      "tracking_number": "9400111899223857267224",
      "tracking_url": "http://example.com",
      "issue": {
        "code": "address_undeliverable",
        "message": "string",
        "occurred_at": "2019-08-24T14:15:22Z"
      },
      "external_ref": "string",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "type": "standard",
      "special_instructions": "string",
      "deliver_by": "2019-08-24",
      "verified_address_id": "e92daf1e-afde-425b-aaf7-6374949522b4"
    }
  ]
}

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

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

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