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.
/v1/organizations/{orgId}/orders/{orderId}AuthorizationBasic auth · headerrequiredRegistered confidential integration credentials. Keep the secret server-side.
CookieAPI key · headerrequiredConsole-managed Vault session cookie; secure cookie naming may vary by environment.
AuthorizationBearer token (Vault TEST service token) · headerrequiredCustomer- 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.
AuthorizationBearer token (Vault organization API key) · headerrequiredOrganization-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.
orderIdstringrequiredVault's order ID from the order list, not the visible order number.
orgIdstringrequiredSuccess
dataobjectrequiredShow propertiesHide properties
customerLabelstring | nullrequiredidstringrequiredkindstringrequiredordinaryredemptionreshipship_backreceiptobjectrequiredShow propertiesHide properties
operationIdstring | nullrequiredrecordedAtstringrequiredvisibleOrderNumberstring | nullrequiredcancellationobject | nullShow propertiesHide properties
deadlineAtstring<date-time>requiredeligiblebooleanrequirednullcurrentobject | nullrequiredShow propertiesHide properties
insuranceobject | nullShow propertiesHide properties
insuredbooleanrequiredWhether the order asks the warehouse to insure its one parcel. False is the explicit no-additional-insurance choice.
insuredValueobject | nullrequiredDeclared value to insure, independent of goods and customs values. Null when not insured.
Show propertiesHide properties
amountstringrequiredcurrencystringrequirednulllabelobject | nullrequiredNull until the warehouse buys the one label for this order, or when the order has more than one active shipment.
Show propertiesHide properties
insuredboolean | nullrequiredWhether the warehouse's label reports additional coverage. Null when the label does not report it.
insuredValueobject | nullrequiredShow propertiesHide properties
amountstringrequiredcurrencystringrequirednullproviderstring | nullrequiredShow propertiesHide properties
stringnullnullproviderstring | nullrequiredCoverage provider. carrier is the carrier's declared-value coverage.
Show propertiesHide properties
stringnullnullrequestedDeliveryConfirmationstring | nullShow propertiesHide properties
stringnullorderDatestring | nullrequiredproviderOrderNumberstring | nullrequiredrecipientNamestring | nullrequiredstatusstringrequiredon_holdreadyshippedcanceledunknowntrackingobject[]requiredShow propertiesHide properties
objectdeliveryConfirmationstring | nullShow propertiesHide properties
stringnullcarrierstring | nullrequirednumberstringrequiredshipDatestring | nullrequiredparcelEvidenceobjectShow propertiesHide properties
allParcelsCollectedboolean | nullrequiredcoveragestringrequiredcompleteincompletemembershipObservedAtstring<date-time> | nullrequiredShow propertiesHide properties
string<date-time>nullstatestringrequiredconfirmedpendingincompletestaleunavailableunknownparcelsobject[]requiredShow propertiesHide properties
objectidstringrequiredcarrierstring | nullrequirednumberstringrequiredstatestringrequiredconfirmedpendingunavailableunknowneventobject | nullrequiredShow propertiesHide properties
detailCodestringrequiredoccurredAtstring<date-time> | nullrequiredShow propertiesHide properties
string<date-time>nullreportedAtstring | nullrequirednulldetailCodestring | nullrequiredobservedAtstring<date-time> | nullrequiredShow propertiesHide properties
string<date-time>nullestablishedAtstring<date-time> | nullrequiredShow propertiesHide properties
string<date-time>nullrefreshstringrequiredcurrentunavailableunknownstalesimulatedbooleanrequiredcustomerNotesstring | nullrequiredholdUntilDatestring | nullrequireditemsobject[]requiredShow propertiesHide properties
objectdeclaredUnitValuestring | nullnamestring | nullrequiredproductIdstring | nullquantityinteger | nullrequiredShow propertiesHide properties
integernullskustring | nullrequiredunitPricestring | nullrecipientobject | nullrequiredShow propertiesHide properties
citystring | nullrequiredcompanystring | nullrequiredcountrystring | nullrequiredemailstring | nullrequirednamestring | nullrequiredphonestring | nullrequiredpostalCodestring | nullrequiredstatestring | nullrequiredstreet1string | nullrequiredstreet2string | nullrequirednullrevisionstringrequiredrequestedShippingServicestring | nullrequirednullpackingExceptionobject | nullRedemption cards held while packing, each with its offer, response deadline and outcome. Null when no card was held.
Show propertiesHide properties
estimateobject | nullrequiredShow propertiesHide properties
amountstring | nullrequiredEstimated total in currency units. Null when a component is not yet known; unknown is never reported as zero.
asOfstring<date-time>requiredbasisstringrequiredcompletebooleanrequiredTrue 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[]requiredShow propertiesHide properties
objectamountstring | nullrequiredcodestringrequiredcurrencystringrequiredrevisionintegerrequirednullidstringrequiredrecordedAtstring<date-time>requiredresolvedAtstring<date-time> | nullrequiredShow propertiesHide properties
string<date-time>nullrevisionintegerrequiredstatusstringrequiredheld keeps the order from shipping until every unit settles.
heldresolvedunitsobject[]requiredShow propertiesHide properties
objectdecisionobject | nullrequiredShow propertiesHide properties
answerstringrequiredaccept_offerremove_carddecidedAtstring<date-time>requiredofferRevisionintegerrequiredoperationIdstring | nullrequiredOperation ID of the answer that made this decision. Retry or recover an answer by this ID. Null when the warehouse or the deadline decided.
sourcestringrequiredanswer 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.
answerwarehousedeadline_defaultnullfoundConditionstring | nullrequiredShow propertiesHide properties
stringnullidstringrequiredlineIndexintegerrequiredofferobjectrequiredShow propertiesHide properties
conditionstring | nullrequiredCondition of the offered replacement card, when graded.
Show propertiesHide properties
stringnullidstringrequiredkindstringrequiredreplacement offers one reserved card; no_offer means the only choice is removing the card.
replacementno_offerproductstring | nullrequiredThe SKU of the offered replacement card, or null for no_offer.
readableAtstring<date-time>requiredresponseDeadlineAtstring<date-time>requiredrevisionintegerrequiredorderedobjectrequiredShow propertiesHide properties
conditionstring | nullrequiredShow propertiesHide properties
stringnullproductstringrequiredskustring | nullrequiredoutcomestringrequiredawaiting_answerreceivedpendingappliedrefusedpackCardOrdinalinteger | nullrequiredShow propertiesHide properties
integernullreasonstringrequiredcondition_mismatchmissingdamagedresponseDeadlineAtstring<date-time>requiredunitIndexintegerrequirednullsourceOrderIdstring | nullrequiredmetaobjectrequiredShow propertiesHide properties
requestIdstringrequiredError
errorobjectrequiredShow propertiesHide properties
codestringrequiredforbiddeninternal_errornot_foundprovider_data_invalidprovider_outcome_unknownprovider_unavailablerate_limitedstate_conflictunauthenticatedvalidation_errorwarehouse_not_readyfieldsobject[]Show propertiesHide properties
objectcodestringrequiredmessagestringrequiredpathstringrequiredmessagestringrequiredoperationIdstringmetaobjectrequiredShow propertiesHide properties
requestIdstringrequired