Correct a purchase-order declaration
PATCH
/v1/organizations/{orgId}/purchase-orders/{purchaseOrderId}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 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.
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
orgIdstringrequiredmin length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
purchaseOrderIdstringrequiredmin length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
Request body
requiredapplication/jsonexpectedDeclarationRevisionintegerrequiredmin 1 · max 9007199254740991
linesobject[]requiredmin items 1 · max items 500
Show propertiesHide properties
Array of
objectdeclaredConditionstring | nullShow propertiesHide properties
Any of:
string
stringnull
nulldeclaredQuantityintegerrequiredmin 0 · max 100000
lineIdstringrequiredmin length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
productIdstringrequiredmin length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
submittedNamestringmin length 1 · max length 200
supplierSkustring | nullShow propertiesHide properties
Any of:
string
stringnull
nullsubmissionKeystringrequiredmin length 8 · max length 128 · matches ^[A-Za-z0-9_.:-]+$
Responses
200
Success
dataobjectrequiredShow propertiesHide properties
effectsstring[]requiredoperationIdstringrequiredoutcomestringrequiredpurchaseOrderobjectrequiredShow propertiesHide properties
declarationRevisionintegerrequiredmin 1 · max 9007199254740991
idstring<uuid>requiredmatches ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
lineIdsstring<uuid>[]requiredpoNumberstringrequiredmin length 1 · max length 200
providerPoRefstring | nullrequiredShow propertiesHide properties
Any of:
string
stringnull
nulldepositobjectShow propertiesHide properties
providerVerifiedbooleanrequireddepositRefstringrequiredmin length 1 · max length 200
labelRefstringrequiredmin length 1 · max length 200
trackingstringrequiredmin length 1 · max length 200
metaobjectrequiredShow 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