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

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.

POST/v1/organizations/{orgId}/orders/{orderId}/cancel
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
min length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
orgIdstringrequired
min length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
Request body
requiredapplication/json
acknowledgePickingMayHaveStartedboolean
expectedRevisionstringrequired
min length 1 · max length 64
submissionKeystringrequired
min length 8 · max length 128 · matches ^[A-Za-z0-9_.:-]+$
Responses
200

Success

dataobjectrequired
Show properties
effectsstring[]required
operationIdstringrequired
outcomestringrequired
orderobjectrequired
Show properties
idstringrequired
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 POST '/v1/organizations/string/orders/string/cancel' \
  -H 'Authorization: Basic YOUR_CREDENTIALS' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "acknowledgePickingMayHaveStarted": true,
  "expectedRevision": "string",
  "submissionKey": "stringst"
}'
Response
{
  "data": {
    "effects": [
      "string"
    ],
    "operationId": "string",
    "outcome": "confirmed",
    "order": {
      "id": "string"
    }
  },
  "meta": {
    "requestId": "string"
  }
}

Was this page helpful?