Cancel an eligible whole order
Cancel one whole order using its current expectedRevision and a stable submissionKey. A redemption requires its persisted server hold to remain open strictly before cancellation.deadlineAt; it uses its native On hold order and does not require the ordinary picking acknowledgement. An ordinary order is eligible while it is On hold or Ready with no established shipment and the current customer policy allows cancellation; only a Ready order requires acknowledgePickingMayHaveStarted: true, and an On hold order accepts it without needing it. Vault rechecks native identity, store, revision and absence of an established shipment before a preserved-field cancellation, then confirms only from exact cancelled-order readback and its atomic receipt. An unknown result remains unresolved and is observed without another cancellation write. A successful receipt does not prove stopped physical picking, carrier handoff, refund, token restoration or escrow changes. Shared Test uses only its current simulated realm and never falls back to Live.
/v1/organizations/{orgId}/orders/{orderId}/cancelAuthorizationBasic 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.
orderIdstringrequiredorgIdstringrequiredapplication/jsonacknowledgePickingMayHaveStartedbooleanexpectedRevisionstringrequiredsubmissionKeystringrequiredSuccess
dataobjectrequiredShow propertiesHide properties
effectsstring[]requiredoperationIdstringrequiredoutcomestringrequiredorderobjectrequiredShow propertiesHide properties
idstringrequiredmetaobjectrequiredShow 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