Submit return instruction
POST
/v1/organizations/{orgId}/returns/{returnId}/instructionAuthorization
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_-]+$
returnIdstring<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)$
Request body
requiredapplication/jsonexpectedRevisionintegerrequiredmin 0 · max 9007199254740991
instructionobjectrequiredShow propertiesHide properties
Any of:
object
choicestringrequiredobject
choicestringrequiredreshipSnapshotIdstring<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)$
object
choicestringrequiredcorrectedRecipientobjectrequiredShow 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
nullcompanyNamestring | nullShow propertiesHide properties
Any of:
string
stringnull
nullcontactNamestring | nullShow propertiesHide properties
Any of:
string
stringnull
nullcountryCodestring | nullShow propertiesHide properties
Any of:
string
stringnull
nulldefaultIncotermstring | nullShow propertiesHide properties
Any of:
string
stringnull
nullemailstring | nullShow propertiesHide properties
Any of:
string
stringnull
nullimporterOfRecordstring | nullShow propertiesHide properties
Any of:
string
stringnull
nulllegalNamestring | 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
nulltaxIdentifierstring | 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[]requiredoperationIdstringrequiredoutcomestringrequiredinstructionobjectrequiredShow propertiesHide properties
idstringrequiredrevisionintegerrequiredmin -9007199254740991 · max 9007199254740991
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