Skip to content
Stashtab Docs
Esc
↑↓navigate↵open⌘Jpreview

List physical returns

GET/v1/organizations/{orgId}/returns
Authorization
AuthorizationBasic auth · headerrequired

Registered confidential integration credentials. Keep the secret server-side.

or
CookieAPI key · headerrequired

Console-managed Vault session cookie; secure cookie naming may vary by environment.

Path parameters
orgIdstringrequired
min length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
Query parameters
cursorstring
min length 1 · max length 2048
limitinteger
min 1 · max 100 · default: 50
Responses
200

Success

dataobject[]required
Show properties
Array of object
arrivalKindstringrequired

Physical return or return to sender (RTS); RTS is linked to an original shipment.

Allowed:returnrts
arrivedAtstringrequired
arrivalOriginstringrequired
Allowed:staff_attestedverified_provider
idstringrequired
instructionRevisionintegerrequired
min -9007199254740991 · max 9007199254740991
originalOrderIdstringrequired
originalShipmentIdstring | nullrequired
providerReturnRefstring | nullrequired
metaobjectrequired
Show properties
requestIdstringrequired
nextCursorstring | nullrequired
previousCursorstring | nullrequired
default

Error

errorobjectrequired
Show properties
codestringrequired
Allowed:forbiddeninternal_errornot_foundprovider_data_invalidprovider_outcome_unknownprovider_unavailablerate_limitedstate_conflictunauthenticatedvalidation_errorwarehouse_not_ready
fieldsobject[]
Show properties
Array of object
codestringrequired
messagestringrequired
pathstringrequired
messagestringrequired
operationIdstring
metaobjectrequired
Show properties
requestIdstringrequired
Request
curl -X GET '/v1/organizations/string/returns' \
  -H 'Authorization: Basic YOUR_CREDENTIALS' \
  -H 'Accept: application/json'
Response
{
  "data": [
    {
      "arrivalKind": "return",
      "arrivedAt": "string",
      "arrivalOrigin": "staff_attested",
      "id": "string",
      "instructionRevision": -9007199254740991,
      "originalOrderId": "string",
      "originalShipmentId": "string",
      "providerReturnRef": "string"
    }
  ],
  "meta": {
    "requestId": "string",
    "nextCursor": "string",
    "previousCursor": "string"
  }
}

Was this page helpful?