Create an order for the warehouse to ship
Creates one ordinary order with the requested service. It starts On hold for a later explicit release unless hold is false; set hold to false to release it to the warehouse as awaiting shipment at once. A retry with the same submission key must repeat the same hold value, and a changed value conflicts. A retry more than five minutes after the original creation never sends a new release and reports the order’s current state. Vault never buys a shipping label: the warehouse buys it after packing, and its tracking then appears in order.current.tracking on later reads. placement.state is released, on_hold, or release_unconfirmed when the order was created but its release could not be verified. A deliveryConfirmation request must match the priced shippingQuote selection. Omit the top-level value to carry the selection unchanged. Changed confirmation conflicts with the original intent. For the priced flow, preview the recipient and physical source, call createShippingQuote with those same products, quantities and recipient, choose a quote, and pass its exact selection as shippingQuote and its fulfillmentSource unchanged. An item may set declaredUnitValue.amount in USD independently of unitPrice; omitting it uses the verified product declaration. The top-level customs object remains only a compatibility fallback for older callers. Create rechecks eligibility, packing, pricing and service identity before sending; changed estimates require a new quote and explicit selection. Quotes are estimates, not price locks or label purchases. A quote prices one parcel at the order’s total weight. The ordinary Vault web form requires this priced choice. Existing unquoted HTTP/MCP clients remain compatible: a named service requires preview’s requestedService.selected and requestedService.review as requestedShippingService and requestedShippingServiceReview; omitting both requested-service fields retains their legacy warehouse-choice behavior. New submissions require a current fulfillmentSource. Confirmed legacy submissions replay their original receipt; unknown outcomes are never resent. The original 47-column CSV profile uses externalIdentity with source original_47_column_csv and the original Order # as reference (1–100 characters after trimming outer whitespace). It derives orderKey when omitted and recognizes equivalent initial content across CSV, API, MCP and replacement credentials. A changed recipient, item, declared customs value, quantity or requested service conflicts and requires a deliberate permitted held-order edit. An API or MCP create that names a CSV reference and sets hold to false is released at once; only held orders can be corrected.
/v1/organizations/{orgId}/ordersAuthorizationBasic 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 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.
orgIdstringrequiredapplication/jsondeliveryConfirmationstringnonedeliverysignatureadult_signaturedirect_signaturecustomsobjectShow propertiesHide properties
countryOfOriginstringrequireddeclaredValueobjectrequiredShow propertiesHide properties
amountstringrequireddescriptionstringrequiredtariffCodestringrequiredcustomerLabelstring | nullShow propertiesHide properties
stringnulllinesobject[]requiredShow propertiesHide properties
objectdeclaredUnitValueobjectShow propertiesHide properties
amountstringrequirednamestringrequiredproductIdstringquantityintegerrequiredskustringunitPricestringrequiredorderKeystringorderNumberstringrecipientobjectrequiredShow propertiesHide properties
addressLine1string | nullShow propertiesHide properties
stringnulladdressLine2string | nullShow propertiesHide properties
stringnulladdressLine3string | nullShow propertiesHide properties
stringnullcitystring | nullShow propertiesHide properties
stringnullcompanystring | nullShow propertiesHide properties
stringnullcompanyNamestring | nullShow propertiesHide properties
stringnullcontactNamestring | nullShow propertiesHide properties
stringnullcountrystring | nullShow propertiesHide properties
stringnullcountryCodestring | nullShow propertiesHide properties
stringnullemailstring | nullShow propertiesHide properties
stringnullnamestring | nullShow propertiesHide properties
stringnullphonestring | nullShow propertiesHide properties
stringnullpostalCodestring | nullShow propertiesHide properties
stringnullregionstring | nullShow propertiesHide properties
stringnullstatestring | nullShow propertiesHide properties
stringnullstreet1string | nullShow propertiesHide properties
stringnullstreet2string | nullShow propertiesHide properties
stringnullstreet3string | nullShow propertiesHide properties
stringnullstoreLinkIdstringstoreRefstringvisibleOrderNumberstringshippingQuoteobjectShow propertiesHide properties
deliveryConfirmationstringnonedeliverysignatureadult_signaturedirect_signatureinsuranceobjectShow propertiesHide properties
kindstringrequiredkindstringrequiredpackagesobject[]requiredShow propertiesHide properties
objectamountstringrequiredcurrencystringrequiredproviderstringrequiredcarrierparcelguardshipsurancexcoverreviewstringrequiredrequestedShippingServicestringrequiredrequestedShippingServiceReviewstringrequiredrequestedShippingServicestringrequestedShippingServiceReviewstringfulfillmentSourceobjectShow propertiesHide properties
configurationRevisionstringrequiredsourceSignaturestringrequiredphysicalOriginEquivalenceRefstringrequiredv1WarehouseIdintegerrequiredmodestringrequiredconfigurationRevisionstringrequiredsourceSignaturestringrequiredphysicalOriginEquivalenceRefstringrequiredexternalIdentityobjectShow propertiesHide properties
referencestringrequiredsourcestringrequiredoriginal_47_column_csvholdbooleansubmissionKeystringrequiredSuccess
dataobjectrequiredShow propertiesHide properties
effectsstring[]requiredoperationIdstringrequiredoutcomestringrequiredorderobjectrequiredShow 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 | nullrequiredplacementobjectrequiredShow propertiesHide properties
statestringrequiredreleasedon_holdrelease_unconfirmedmetaobjectrequiredShow 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