Update a held order
PATCH
/v1/organizations/{orgId}/orders/{orderId}Authorization
AuthorizationBasic auth · headerrequiredRegistered confidential integration credentials. Keep the secret server-side.
or
CookieAPI key · headerrequiredConsole-managed Vault session cookie; secure cookie naming may vary by environment.
or
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.
Path parameters
orderIdstringrequiredmin length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
orgIdstringrequiredmin length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
Request body
requiredapplication/jsonchangesobjectrequiredShow propertiesHide properties
customerNotesstring | nullOmit to preserve the current provider value; send null or an empty string to clear it. Confirmation requires provider readback.
Show propertiesHide properties
Any of:
string
stringnull
nulllinesobject[]min items 1 · max items 100
Show propertiesHide properties
Array of
objectdeclaredUnitValueobjectShow propertiesHide properties
amountstringrequiredmatches ^(0|[1-9]\d{0,8})(\.\d{1,4})?$
namestringrequiredmin length 1 · max length 200
productIdstringmin length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
quantityintegerrequiredmin 1 · max 100000
skustringmin length 1 · max length 200
unitPricestringrequiredmatches ^(0|[1-9]\d{0,8})(\.\d{1,4})?$
recipientobjectShow propertiesHide properties
addressLine1string | nullShow propertiesHide properties
Any of:
string
stringnull
nulladdressLine2string | nullShow propertiesHide properties
Any of:
string
stringnull
nulladdressLine3string | nullShow propertiesHide properties
Any of:
string
stringnull
nullcitystring | nullShow propertiesHide properties
Any of:
string
stringnull
nullcompanystring | nullShow propertiesHide properties
Any of:
string
stringnull
nullcompanyNamestring | nullShow propertiesHide properties
Any of:
string
stringnull
nullcontactNamestring | nullShow propertiesHide properties
Any of:
string
stringnull
nullcountrystring | nullShow propertiesHide properties
Any of:
string
stringnull
nullcountryCodestring | nullShow propertiesHide properties
Any of:
string
stringnull
nullemailstring | nullShow propertiesHide properties
Any of:
string
stringnull
nullnamestring | nullShow propertiesHide properties
Any of:
string
stringnull
nullphonestring | nullShow propertiesHide properties
Any of:
string
stringnull
nullpostalCodestring | nullShow propertiesHide properties
Any of:
string
stringnull
nullregionstring | nullShow propertiesHide properties
Any of:
string
stringnull
nullstatestring | nullShow propertiesHide properties
Any of:
string
stringnull
nullstreet1string | nullShow propertiesHide properties
Any of:
string
stringnull
nullstreet2string | nullShow propertiesHide properties
Any of:
string
stringnull
nullstreet3string | nullShow propertiesHide properties
Any of:
string
stringnull
nullrequestedShippingServicestring | nullShow propertiesHide properties
Any of:
string
stringnull
nullexpectedRevisionstringrequiredmin length 1 · max length 64
submissionKeystringrequiredmin length 8 · max length 128 · matches ^[A-Za-z0-9_.:-]+$
Responses
200
Success
dataobjectrequiredShow propertiesHide properties
effectsstring[]requiredoperationIdstringrequiredoutcomestringrequiredorderobjectrequiredShow propertiesHide properties
idstringrequiredrevisionstringrequiredmetaobjectrequiredShow propertiesHide properties
requestIdstringrequireddefault
Error
errorobjectrequiredShow propertiesHide properties
codestringrequiredAllowed:
forbiddeninternal_errornot_foundprovider_data_invalidprovider_outcome_unknownprovider_unavailablerate_limitedstate_conflictunauthenticatedvalidation_errorwarehouse_not_readyfieldsobject[]Show propertiesHide properties
Array of
objectcodestringrequiredmessagestringrequiredpathstringrequiredmessagestringrequiredoperationIdstringmetaobjectrequiredShow propertiesHide properties
requestIdstringrequired