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

Get an order

Read one known order within the current organization and mode, including permitted recipient, line, status and tracking facts. Current provider facts can be null when the warehouse no longer reports the order. current.requestedDeliveryConfirmation reports the provider order request. Each tracking entry reports deliveryConfirmation only from that exact purchased shipment; null or an absent field means unknown. A request, label or signature option does not prove recipient identity or physical delivery. For a Live redemption, cancellation.deadlineAt is the persisted server deadline and cancellation.eligible reflects the current hold policy: an untouched held order is eligible only while now < deadlineAt. The exact deadline is closed. Cancellation rechecks current provider identity, revision and shipment state; eligibility is not a provider or physical-workflow guarantee. A historical redemption without a recorded hold returns cancellation: null; ordinary orders omit it. The creation receipt preserves its original creation-time eligibility on replay and never extends the deadline. Test redemptions also expose their server-owned cancellation deadline and current time/state eligibility; these facts do not grant cancellation permission. Manual Test release is unavailable before the deadline. An early release returns 409 state_conflict explaining the open window. Refresh after expiry to review manual release; expiry alone does not release the order. Additive current.parcelEvidence confirms allParcelsCollected only for a complete active outbound parcel set with qualifying physical carrier evidence for every parcel. Historical collection and current refresh health remain separate; unknown, incomplete, stale or unavailable evidence returns no affirmative conclusion. Label creation, electronic advice, shipDate and shipped status do not prove collection. Test events are explicitly simulated. Missing or foreign orders are not found. A redemption also returns packingException: null when no card was held while packing, otherwise the held cards; ordinary orders omit the field. Each unit is one physical copy with a stable id, its zero-based lineIndex and unitIndex (duplicate copies of one card are separate units), the ordered product, SKU and condition, the reason (condition_mismatch, missing or damaged) and the condition found. offer is the current offer: id, revision, kind replacement (one reserved card with its product and condition) or no_offer (removal is the only answer), readableAt and responseDeadlineAt, 168 hours after readableAt. decision is null until the card is answered, decided by the warehouse on your instruction or defaulted to remove_card at the deadline; it carries the answer, source, offerRevision, decidedAt and the answer operationId. outcome is awaiting_answer, received, pending, applied or refused. Only applied is a confirmed effect: an applied remove_card is a confirmed removal that you can use as evidence to restore that card’s token, and an applied accept_offer ships the offered card. received and pending are not confirmed. The order lines keep the ordered content; apply the applied unit decisions to them for the current contents. status stays held, and the order cannot ship, until every unit is applied and any purchased label is reconciled; resolved lifts the hold, and an order with no remaining cards is cancelled. estimate is the current revised customer estimate with its revision, asOf, components and complete flag. It is not a charge or an invoice; an amount of null means unknown and is never zero. A higher estimate needs no approval. Actual charges come from actual work and carrier costs through your ordinary invoices.

GET/v1/organizations/{orgId}/orders/{orderId}
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
orderIdstringrequired

Vault's order ID from the order list, not the visible order number.

min length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
orgIdstringrequired
min length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
Responses
200

Success

dataobjectrequired
Show properties
customerLabelstring | nullrequired
idstringrequired
kindstringrequired
Allowed:ordinaryredemptionreshipship_back
receiptobjectrequired
Show properties
operationIdstring | nullrequired
recordedAtstringrequired
visibleOrderNumberstring | nullrequired
cancellationobject | null
Show properties
Any of:
object
deadlineAtstring<date-time>required
matches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
eligiblebooleanrequired
null
null
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
customerNotesstring | nullrequired
holdUntilDatestring | nullrequired
itemsobject[]required
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 | nullrequired
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
revisionstringrequired
requestedShippingServicestring | nullrequired
null
null
packingExceptionobject | null

Redemption cards held while packing, each with its offer, response deadline and outcome. Null when no card was held.

Show properties
Any of:
object
estimateobject | nullrequired
Show properties
Any of:
object
amountstring | nullrequired

Estimated total in currency units. Null when a component is not yet known; unknown is never reported as zero.

asOfstring<date-time>required
matches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
basisstringrequired
completebooleanrequired

True only when every affected unit is applied and the amount is known. False while any unit is not applied, because that card is priced as ordered, and when the amount is null.

componentsobject[]required
Show properties
Array of object
amountstring | nullrequired
codestringrequired
currencystringrequired
min length 3 · max length 3
revisionintegerrequired
min 1 · max 9007199254740991
null
null
idstringrequired
recordedAtstring<date-time>required
matches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
resolvedAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
revisionintegerrequired
min 1 · max 9007199254740991
statusstringrequired

held keeps the order from shipping until every unit settles.

Allowed:heldresolved
unitsobject[]required
Show properties
Array of object
decisionobject | nullrequired
Show properties
Any of:
object
answerstringrequired
Allowed:accept_offerremove_card
decidedAtstring<date-time>required
matches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
offerRevisionintegerrequired
min 1 · max 9007199254740991
operationIdstring | nullrequired

Operation ID of the answer that made this decision. Retry or recover an answer by this ID. Null when the warehouse or the deadline decided.

sourcestringrequired

answer is the customer's own answer; warehouse is a decision the warehouse recorded on the customer's instruction; deadline_default removes the card when the response window closes without one.

Allowed:answerwarehousedeadline_default
null
null
foundConditionstring | nullrequired
Show properties
Any of:
string
string
null
null
idstringrequired
lineIndexintegerrequired
min 0 · max 9007199254740991
offerobjectrequired
Show properties
conditionstring | nullrequired

Condition of the offered replacement card, when graded.

Show properties
Any of:
string
string
null
null
idstringrequired
kindstringrequired

replacement offers one reserved card; no_offer means the only choice is removing the card.

Allowed:replacementno_offer
productstring | nullrequired

The SKU of the offered replacement card, or null for no_offer.

readableAtstring<date-time>required
matches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
responseDeadlineAtstring<date-time>required
matches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
revisionintegerrequired
min 1 · max 9007199254740991
orderedobjectrequired
Show properties
conditionstring | nullrequired
Show properties
Any of:
string
string
null
null
productstringrequired
skustring | nullrequired
outcomestringrequired
Allowed:awaiting_answerreceivedpendingappliedrefused
packCardOrdinalinteger | nullrequired
Show properties
Any of:
integer
integer
null
null
reasonstringrequired
Allowed:condition_mismatchmissingdamaged
responseDeadlineAtstring<date-time>required
matches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
unitIndexintegerrequired
min 0 · max 9007199254740991
null
null
sourceOrderIdstring | nullrequired
metaobjectrequired
Show properties
requestIdstringrequired
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/string' \
  -H 'Authorization: Basic YOUR_CREDENTIALS' \
  -H 'Accept: application/json'
Response
{
  "data": {
    "customerLabel": "string",
    "id": "string",
    "kind": "ordinary",
    "receipt": {
      "operationId": "string",
      "recordedAt": "string"
    },
    "visibleOrderNumber": "string",
    "cancellation": {
      "deadlineAt": "2019-08-24T14:15:22Z",
      "eligible": true
    },
    "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
          }
        ]
      },
      "customerNotes": "string",
      "holdUntilDate": "string",
      "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"
      },
      "revision": "string",
      "requestedShippingService": "string"
    },
    "packingException": {
      "estimate": {
        "amount": "string",
        "asOf": "2019-08-24T14:15:22Z",
        "basis": "estimate",
        "complete": true,
        "components": [
          {
            "amount": "string",
            "code": "string"
          }
        ],
        "currency": "str",
        "revision": 1
      },
      "id": "string",
      "recordedAt": "2019-08-24T14:15:22Z",
      "resolvedAt": "2019-08-24T14:15:22Z",
      "revision": 1,
      "status": "held",
      "units": [
        {
          "decision": {
            "answer": "accept_offer",
            "decidedAt": "2019-08-24T14:15:22Z",
            "offerRevision": 1,
            "operationId": "string",
            "source": "answer"
          },
          "foundCondition": "nm",
          "id": "string",
          "lineIndex": 0,
          "offer": {
            "condition": "nm",
            "id": "string",
            "kind": "replacement",
            "product": "string",
            "readableAt": "2019-08-24T14:15:22Z",
            "responseDeadlineAt": "2019-08-24T14:15:22Z",
            "revision": 1
          },
          "ordered": {
            "condition": "nm",
            "product": "string",
            "sku": "string"
          },
          "outcome": "awaiting_answer",
          "packCardOrdinal": 1,
          "reason": "condition_mismatch",
          "responseDeadlineAt": "2019-08-24T14:15:22Z",
          "unitIndex": 0
        }
      ]
    },
    "sourceOrderId": "string"
  },
  "meta": {
    "requestId": "string"
  }
}

Was this page helpful?