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

Update a held order

PATCH/v1/organizations/{orgId}/orders/{orderId}
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 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
changesobjectrequired
Show properties
customerNotesstring | null

Omit to preserve the current provider value; send null or an empty string to clear it. Confirmation requires provider readback.

Show properties
Any of:
string
string
null
null
linesobject[]
min items 1 · max items 100
Show properties
Array of object
declaredUnitValueobject
Show properties
amountstringrequired
matches ^(0|[1-9]\d{0,8})(\.\d{1,4})?$
namestringrequired
min length 1 · max length 200
productIdstring
min length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
quantityintegerrequired
min 1 · max 100000
skustring
min length 1 · max length 200
unitPricestringrequired
matches ^(0|[1-9]\d{0,8})(\.\d{1,4})?$
recipientobject
Show properties
addressLine1string | null
Show properties
Any of:
string
string
null
null
addressLine2string | null
Show properties
Any of:
string
string
null
null
addressLine3string | null
Show properties
Any of:
string
string
null
null
citystring | null
Show properties
Any of:
string
string
null
null
companystring | null
Show properties
Any of:
string
string
null
null
companyNamestring | null
Show properties
Any of:
string
string
null
null
contactNamestring | null
Show properties
Any of:
string
string
null
null
countrystring | null
Show properties
Any of:
string
string
null
null
countryCodestring | null
Show properties
Any of:
string
string
null
null
emailstring | null
Show properties
Any of:
string
string
null
null
namestring | null
Show properties
Any of:
string
string
null
null
phonestring | null
Show properties
Any of:
string
string
null
null
postalCodestring | null
Show properties
Any of:
string
string
null
null
regionstring | null
Show properties
Any of:
string
string
null
null
statestring | null
Show properties
Any of:
string
string
null
null
street1string | null
Show properties
Any of:
string
string
null
null
street2string | null
Show properties
Any of:
string
string
null
null
street3string | null
Show properties
Any of:
string
string
null
null
requestedShippingServicestring | null
Show properties
Any of:
string
string
null
null
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
revisionstringrequired
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 PATCH '/v1/organizations/string/orders/string' \
  -H 'Authorization: Basic YOUR_CREDENTIALS' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "changes": {
    "customerNotes": "string",
    "lines": [
      {
        "declaredUnitValue": {
          "amount": "string"
        },
        "name": "string",
        "productId": "string",
        "quantity": 1,
        "sku": "string",
        "unitPrice": "string"
      }
    ],
    "recipient": {
      "addressLine1": "string",
      "addressLine2": "string",
      "addressLine3": "string",
      "city": "string",
      "company": "string",
      "companyName": "string",
      "contactName": "string",
      "country": "string",
      "countryCode": "string",
      "email": "string",
      "name": "string",
      "phone": "string",
      "postalCode": "string",
      "region": "string",
      "state": "string",
      "street1": "string",
      "street2": "string",
      "street3": "string"
    },
    "requestedShippingService": "string"
  },
  "expectedRevision": "string",
  "submissionKey": "stringst"
}'
Response
{
  "data": {
    "effects": [
      "string"
    ],
    "operationId": "string",
    "outcome": "confirmed",
    "order": {
      "id": "string",
      "revision": "string"
    }
  },
  "meta": {
    "requestId": "string"
  }
}

Was this page helpful?