Update product shipping metadata
PATCH
/v1/organizations/{orgId}/products/{productId}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.
Path parameters
orgIdstringrequiredmin length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
productIdstringrequiredmin length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
Request body
requiredapplication/jsonaliasesobject[]max items 50
Show propertiesHide properties
Array of
objectaliasstringrequiredmin length 1 · max length 100
storeRefstringrequiredmin length 1 · max length 64
customsobjectShow propertiesHide properties
countryOfOriginstring | nullShow propertiesHide properties
Any of:
string
stringnull
nulldeclaredValueobject | nullShow propertiesHide properties
Any of:
object
amountstringrequiredmatches ^(0|[1-9]\d{0,8})(\.\d{1,4})?$
null
nulldescriptionstring | nullShow propertiesHide properties
Any of:
string
stringnull
nulltariffCodestring | nullShow propertiesHide properties
Any of:
string
stringnull
nullexpectedRevisionstringrequiredmin length 1 · max length 64
submissionKeystringrequiredmin length 8 · max length 128 · matches ^[A-Za-z0-9_.:-]+$
weightobjectShow propertiesHide properties
unitstringrequiredAllowed:
gramkilogramouncepoundvaluenumberrequiredmax 1000000
Responses
200
Success
dataobjectrequiredShow propertiesHide properties
effectsstring[]requiredoperationIdstringrequiredoutcomestringrequiredproductobjectrequiredShow propertiesHide properties
aliasesobject[]requiredShow propertiesHide properties
Array of
objectaliasstringrequiredstoreRefstringrequiredcustomsobject | nullrequiredShow propertiesHide properties
Any of:
object
countryOfOriginstring | nullrequireddeclaredValueobject | nullrequiredShow propertiesHide properties
Any of:
object
amountstringrequiredcurrencystringrequirednull
nulldescriptionstring | nullrequiredtariffCodestring | nullrequirednull
nulldefaultAliasStoreRefstringidstringrequiredrevisionstring | nullrequiredweightobject | nullrequiredShow propertiesHide properties
Any of:
object
unitstring | nullrequiredvaluenumber | nullrequirednull
nullmetaobjectrequiredShow 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