Preview an order and validate its address
Reviews a proposed order without creating it. For a redemption in Test or Live, set orderKind to redemption to check the exact destination. A rejected, unavailable or unconfirmed address cannot advance. Recheck any corrections before placing the order; a quote or autoAdvance alone does not authorize creation. Set rateContext.physicalSource to {} and copy physicalSource.selected unchanged as fulfillmentSource. Pass the same deliveryConfirmation to preview and quote; an omitted value means none. For priced shipping, quote the same recipient, products and source, then preview the exact named service and pass the quote selection as shippingQuote. Preview again when any input changes. Existing unquoted callers can pass preview’s requestedService.selected and requestedService.review as requestedShippingService and requestedShippingServiceReview.
/v1/organizations/{orgId}/orders/previewAuthorizationBasic 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_signaturelinesobject[]requiredShow propertiesHide properties
objectdeclaredUnitValueobjectShow propertiesHide properties
amountstringrequiredproductIdstringrequiredquantityintegerrequiredorderKindstringrateContextobjectrequiredShow propertiesHide properties
carrierIdsstring[]requiredshipFromobjectrequiredShow propertiesHide properties
addressLine1stringrequiredaddressLine2stringrequiredcitystringrequiredcompanystringrequiredcountrystringrequiredemailstringrequirednamestringrequiredphonestringrequiredpostalCodestringrequiredregionstringrequiredcarrierIdsstring[]requiredrequestedShippingServicestringphysicalSourceobjectrequiredShow propertiesHide properties
selectedobjectShow propertiesHide properties
configurationRevisionstringrequiredsourceSignaturestringrequiredphysicalOriginEquivalenceRefstringrequiredv1WarehouseIdintegerrequiredmodestringrequiredconfigurationRevisionstringrequiredsourceSignaturestringrequiredphysicalOriginEquivalenceRefstringrequiredrecipientobjectrequiredShow propertiesHide properties
addressLine1stringrequiredaddressLine2stringrequiredcitystringrequiredcompanystringrequiredcountrystringrequiredemailstringrequirednamestringrequiredphonestringrequiredpostalCodestringrequiredregionstringrequiredselectedAddressstringrequirededitedoriginalSuccess
dataobjectrequiredShow propertiesHide properties
addressobjectrequiredShow propertiesHide properties
addressLine1stringrequiredaddressLine2stringrequiredcitystringrequiredcompanystringrequiredcountrystringrequiredemailstringrequirednamestringrequiredphonestringrequiredpostalCodestringrequiredregionstringrequiredcandidateobject | nullrequiredShow propertiesHide properties
addressLine1stringrequiredaddressLine2stringrequiredcitystringrequiredcompanystringrequiredcountrystringrequiredemailstringrequirednamestringrequiredphonestringrequiredpostalCodestringrequiredregionstringrequirednullproviderobjectrequiredShow propertiesHide properties
codestring | nullrequiredfieldstring | nullrequiredoutcomestringrequiredacceptednot_runrejectedunavailablerateCountintegerrequiredrequestIdstring | nullrequiredreasonstring | nullrequiredselectedstringrequirededitedoriginalstatestringrequiredinvalid-required-fieldneeds-reviewpassed-unchangedprovider-unavailableautoAdvancebooleanrequiredeligibilitystringrequiredineligiblereadyunavailableissuesstring[]requiredproductsobject[]requiredShow propertiesHide properties
objectproductIdstringrequiredrevisionstring | nullrequiredskustring | nullrequiredweightobject | nullrequiredShow propertiesHide properties
unitstringrequiredvaluenumberrequirednullreviewIdstringrequiredrequestedServiceobjectShow propertiesHide properties
statestringrequiredreadyunavailableselectedstring | nullrequiredShow propertiesHide properties
stringnullchoicesstring[]requiredreviewstring | nullrequiredShow propertiesHide properties
stringnullreasonstring | nullrequiredphysicalSourceobjectShow propertiesHide properties
statestringrequiredunavailablechoicereadyselectedobject | nullrequiredShow propertiesHide properties
configurationRevisionstringrequiredsourceSignaturestringrequiredphysicalOriginEquivalenceRefstringrequiredv1WarehouseIdintegerrequiredmodestringrequiredconfigurationRevisionstringrequiredsourceSignaturestringrequiredphysicalOriginEquivalenceRefstringrequirednullchoicesobject[]requiredShow propertiesHide properties
objectselectionobjectrequiredShow propertiesHide properties
configurationRevisionstringrequiredsourceSignaturestringrequiredphysicalOriginEquivalenceRefstringrequiredv1WarehouseIdintegerrequiredmodestringrequiredconfigurationRevisionstringrequiredsourceSignaturestringrequiredphysicalOriginEquivalenceRefstringrequiredaddressobjectrequiredShow propertiesHide properties
addressLine1stringrequiredaddressLine2stringrequiredcitystringrequiredcompanystringrequiredcountrystringrequiredemailstringrequirednamestringrequiredphonestringrequiredpostalCodestringrequiredregionstringrequiredreasonstring | 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