Get physical return
GET
/v1/organizations/{orgId}/returns/{returnId}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_-]+$
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)$
Responses
200
Success
dataobjectrequiredShow propertiesHide properties
arrivalKindstringrequiredPhysical return or return to sender (RTS); RTS is linked to an original shipment.
Allowed:
returnrtsarrivedAtstringrequiredarrivalOriginstringrequiredAllowed:
staff_attestedverified_provideridstringrequiredinstructionRevisionintegerrequiredmin -9007199254740991 · max 9007199254740991
originalOrderIdstringrequiredoriginalShipmentIdstring | nullrequiredproviderReturnRefstring | nullrequiredinstructionobject | nullrequiredShow propertiesHide properties
Any of:
object
One of:
object
acknowledgedAtstring | nullrequiredchoicestringrequiredidstringrequiredrevisionintegerrequiredmin -9007199254740991 · max 9007199254740991
sourceLinesobject[]requiredShow propertiesHide properties
Array of
objectassessedConditionstring | nullrequiredShow propertiesHide properties
Any of:
string
stringnull
nullproductBindingIdstringrequiredreceivedQuantityintegerrequiredmin -9007199254740991 · max 9007199254740991
returnLineIdstringrequiredreturnLineRevisionIdstringrequiredrevisionintegerrequiredmin -9007199254740991 · max 9007199254740991
variantBindingIdstring | nullrequiredobject
acknowledgedAtstring | nullrequiredchoicestringrequiredidstringrequiredreshipSnapshotIdstringrequiredresultOrderIdstring | nullrequiredrevisionintegerrequiredmin -9007199254740991 · max 9007199254740991
sourceLinesobject[]requiredShow propertiesHide properties
Array of
objectassessedConditionstring | nullrequiredShow propertiesHide properties
Any of:
string
stringnull
nullproductBindingIdstringrequiredreceivedQuantityintegerrequiredmin -9007199254740991 · max 9007199254740991
returnLineIdstringrequiredreturnLineRevisionIdstringrequiredrevisionintegerrequiredmin -9007199254740991 · max 9007199254740991
variantBindingIdstring | nullrequirednull
nulllinesobject[]requiredShow propertiesHide properties
Array of
objectallocatedQuantityintegerrequiredmin -9007199254740991 · max 9007199254740991
assessedConditionstring | nullrequiredShow propertiesHide properties
Any of:
string
stringnull
nullproductBindingIdstringrequiredreceivedQuantityintegerrequiredmin -9007199254740991 · max 9007199254740991
returnLineIdstringrequiredreturnLineRevisionIdstringrequiredrevisionintegerrequiredmin -9007199254740991 · max 9007199254740991
variantBindingIdstring | nullrequiredmetaobjectrequiredShow 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