List physical returns
GET
/v1/organizations/{orgId}/returnsAuthorization
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_-]+$
Query parameters
cursorstringmin length 1 · max length 2048
limitintegermin 1 · max 100 · default: 50
Responses
200
Success
dataobject[]requiredShow propertiesHide properties
Array of
objectarrivalKindstringrequiredPhysical return or return to sender (RTS); RTS is linked to an original shipment.
Allowed:
returnrtsarrivedAtstringrequiredarrivalOriginstringrequiredAllowed:
staff_attestedverified_provideridstringrequiredinstructionRevisionintegerrequiredmin -9007199254740991 · max 9007199254740991
originalOrderIdstringrequiredoriginalShipmentIdstring | nullrequiredproviderReturnRefstring | nullrequiredmetaobjectrequiredShow propertiesHide properties
requestIdstringrequirednextCursorstring | nullrequiredpreviousCursorstring | nullrequireddefault
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