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

Get physical return

GET/v1/organizations/{orgId}/returns/{returnId}
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_-]+$
returnIdstring<uuid>required
matches ^([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

dataobjectrequired
Show properties
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
instructionobject | nullrequired
Show properties
Any of:
object
One of:
object
acknowledgedAtstring | nullrequired
choicestringrequired
idstringrequired
revisionintegerrequired
min -9007199254740991 · max 9007199254740991
sourceLinesobject[]required
Show properties
Array of object
assessedConditionstring | nullrequired
Show properties
Any of:
string
string
null
null
productBindingIdstringrequired
receivedQuantityintegerrequired
min -9007199254740991 · max 9007199254740991
returnLineIdstringrequired
returnLineRevisionIdstringrequired
revisionintegerrequired
min -9007199254740991 · max 9007199254740991
variantBindingIdstring | nullrequired
object
acknowledgedAtstring | nullrequired
choicestringrequired
idstringrequired
reshipSnapshotIdstringrequired
resultOrderIdstring | nullrequired
revisionintegerrequired
min -9007199254740991 · max 9007199254740991
sourceLinesobject[]required
Show properties
Array of object
assessedConditionstring | nullrequired
Show properties
Any of:
string
string
null
null
productBindingIdstringrequired
receivedQuantityintegerrequired
min -9007199254740991 · max 9007199254740991
returnLineIdstringrequired
returnLineRevisionIdstringrequired
revisionintegerrequired
min -9007199254740991 · max 9007199254740991
variantBindingIdstring | nullrequired
null
null
linesobject[]required
Show properties
Array of object
allocatedQuantityintegerrequired
min -9007199254740991 · max 9007199254740991
assessedConditionstring | nullrequired
Show properties
Any of:
string
string
null
null
productBindingIdstringrequired
receivedQuantityintegerrequired
min -9007199254740991 · max 9007199254740991
returnLineIdstringrequired
returnLineRevisionIdstringrequired
revisionintegerrequired
min -9007199254740991 · max 9007199254740991
variantBindingIdstring | nullrequired
metaobjectrequired
Show properties
requestIdstringrequired
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/497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -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",
    "instruction": {
      "acknowledgedAt": "string",
      "choice": "restock",
      "id": "string",
      "revision": -9007199254740991,
      "sourceLines": [
        {
          "assessedCondition": "nm",
          "productBindingId": "string",
          "receivedQuantity": -9007199254740991,
          "returnLineId": "string",
          "returnLineRevisionId": "string",
          "revision": -9007199254740991,
          "variantBindingId": "string"
        }
      ]
    },
    "lines": [
      {
        "allocatedQuantity": -9007199254740991,
        "assessedCondition": "nm",
        "productBindingId": "string",
        "receivedQuantity": -9007199254740991,
        "returnLineId": "string",
        "returnLineRevisionId": "string",
        "revision": -9007199254740991,
        "variantBindingId": "string"
      }
    ]
  },
  "meta": {
    "requestId": "string"
  }
}

Was this page helpful?