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

List orders

GET/v1/organizations/{orgId}/orders
Authorization
AuthorizationBasic auth · headerrequired

Registered confidential integration credentials. Keep the secret server-side.

or
CookieAPI key · headerrequired

Console-managed Vault session cookie; secure cookie naming may vary by environment.

or
AuthorizationBearer token (Vault TEST service token) · headerrequired

Customer- and resource-bound service grant, rechecked on every call. Existing Live opening-feed authority remains narrow; ordinary Test business requests refuse until shared Test composition is available.

or
AuthorizationBearer token (Vault organization API key) · headerrequired

Organization-owned credential with immutable mode and Read-only or Read/write permissions. Only explicitly declared ordinary customer operations accept it. Test business access refuses until shared Test composition is available; no staff, team, key-management or protocol authority is granted.

Path parameters
orgIdstringrequired
min length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
Query parameters
cursorstring
min length 1 · max length 2048
limitinteger
min 1 · max 100 · default: 50
customerLabelstring
min length 1 · max length 200
qstring

Matches part of the order number or, for Live orders, part of the recipient name. Email addresses, street addresses, SKUs and tracking numbers are not searched.

max length 200
statusstring
Allowed:on_holdreadyshippedcanceledunknown
Responses
200

Success

dataobject[]required
Show properties
Array of object
customerLabelstring | nullrequired
idstringrequired
kindstringrequired
Allowed:ordinaryredemptionreshipship_back
receiptobjectrequired
Show properties
operationIdstring | nullrequired
recordedAtstringrequired
visibleOrderNumberstring | nullrequired
currentobject | nullrequired
Show properties
Any of:
object
insuranceobject | null
Show properties
Any of:
object
insuredbooleanrequired

Whether the order asks the warehouse to insure its one parcel. False is the explicit no-additional-insurance choice.

insuredValueobject | nullrequired

Declared value to insure, independent of goods and customs values. Null when not insured.

Show properties
Any of:
object
amountstringrequired
currencystringrequired
null
null
labelobject | nullrequired

Null until the warehouse buys the one label for this order, or when the order has more than one active shipment.

Show properties
Any of:
object
insuredboolean | nullrequired

Whether the warehouse's label reports additional coverage. Null when the label does not report it.

insuredValueobject | nullrequired
Show properties
Any of:
object
amountstringrequired
currencystringrequired
null
null
providerstring | nullrequired
Show properties
Any of:
string
string
null
null
null
null
providerstring | nullrequired

Coverage provider. carrier is the carrier's declared-value coverage.

Show properties
Any of:
string
string
null
null
null
null
requestedDeliveryConfirmationstring | null
Show properties
Any of:
string
string
null
null
orderDatestring | nullrequired
providerOrderNumberstring | nullrequired
recipientNamestring | nullrequired
statusstringrequired
Allowed:on_holdreadyshippedcanceledunknown
trackingobject[]required
Show properties
Array of object
deliveryConfirmationstring | null
Show properties
Any of:
string
string
null
null
carrierstring | nullrequired
numberstringrequired
shipDatestring | nullrequired
parcelEvidenceobject
Show properties
allParcelsCollectedboolean | nullrequired
coveragestringrequired
Allowed:completeincomplete
membershipObservedAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
statestringrequired
Allowed:confirmedpendingincompletestaleunavailableunknown
parcelsobject[]required
Show properties
Array of object
idstringrequired
carrierstring | nullrequired
numberstringrequired
statestringrequired
Allowed:confirmedpendingunavailableunknown
eventobject | nullrequired
Show properties
Any of:
object
detailCodestringrequired
occurredAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
reportedAtstring | nullrequired
null
null
detailCodestring | nullrequired
observedAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
establishedAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
refreshstringrequired
Allowed:currentunavailableunknownstale
simulatedbooleanrequired
itemsobject[]
Show properties
Array of object
declaredUnitValuestring | null
namestring | nullrequired
productIdstring | null
quantityinteger | nullrequired
Show properties
Any of:
integer
integer
null
null
skustring | nullrequired
unitPricestring | null
recipientobject | null
Show properties
Any of:
object
citystring | nullrequired
companystring | nullrequired
countrystring | nullrequired
emailstring | nullrequired
namestring | nullrequired
phonestring | nullrequired
postalCodestring | nullrequired
statestring | nullrequired
street1string | nullrequired
street2string | nullrequired
null
null
null
null
metaobjectrequired
Show properties
requestIdstringrequired
nextCursorstring | nullrequired
previousCursorstring | nullrequired
default

Error

errorobjectrequired
Show properties
codestringrequired
Allowed:forbiddeninternal_errornot_foundprovider_data_invalidprovider_outcome_unknownprovider_unavailablerate_limitedstate_conflictunauthenticatedvalidation_errorwarehouse_not_ready
fieldsobject[]
Show properties
Array of object
codestringrequired
messagestringrequired
pathstringrequired
messagestringrequired
operationIdstring
metaobjectrequired
Show properties
requestIdstringrequired
Request
curl -X GET '/v1/organizations/string/orders' \
  -H 'Authorization: Basic YOUR_CREDENTIALS' \
  -H 'Accept: application/json'
Response
{
  "data": [
    {
      "customerLabel": "string",
      "id": "string",
      "kind": "ordinary",
      "receipt": {
        "operationId": "string",
        "recordedAt": "string"
      },
      "visibleOrderNumber": "string",
      "current": {
        "insurance": {
          "insured": true,
          "insuredValue": {
            "amount": "string",
            "currency": "string"
          },
          "label": {
            "insured": true,
            "insuredValue": {
              "amount": "string",
              "currency": "string"
            },
            "provider": "carrier"
          },
          "provider": "carrier"
        },
        "requestedDeliveryConfirmation": "none",
        "orderDate": "string",
        "providerOrderNumber": "string",
        "recipientName": "string",
        "status": "on_hold",
        "tracking": [
          {
            "deliveryConfirmation": "none",
            "carrier": "string",
            "number": "string",
            "shipDate": "string"
          }
        ],
        "parcelEvidence": {
          "allParcelsCollected": true,
          "coverage": "complete",
          "membershipObservedAt": "2019-08-24T14:15:22Z",
          "state": "confirmed",
          "parcels": [
            {
              "id": "string",
              "carrier": "string",
              "number": "string",
              "state": "confirmed",
              "event": {
                "detailCode": "string",
                "occurredAt": "2019-08-24T14:15:22Z",
                "reportedAt": "string"
              },
              "detailCode": "string",
              "observedAt": "2019-08-24T14:15:22Z",
              "establishedAt": "2019-08-24T14:15:22Z",
              "refresh": "current",
              "simulated": true
            }
          ]
        },
        "items": [
          {
            "declaredUnitValue": "string",
            "name": "string",
            "productId": "string",
            "quantity": -9007199254740991,
            "sku": "string",
            "unitPrice": "string"
          }
        ],
        "recipient": {
          "city": "string",
          "company": "string",
          "country": "string",
          "email": "string",
          "name": "string",
          "phone": "string",
          "postalCode": "string",
          "state": "string",
          "street1": "string",
          "street2": "string"
        }
      }
    }
  ],
  "meta": {
    "requestId": "string",
    "nextCursor": "string",
    "previousCursor": "string"
  }
}

Was this page helpful?