Returns

Return Status

Get return status. Requires the returns_read scope.

get/returns/{returnId}/status

Request

Base URL
https://api.getredo.com/v2.2
Auth
HTTP bearer
TypeScript
https://skmtc.dev/redoapp/apis/redo-api/docs/returns/:returnId/status/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

returnIdstring required

Example:64e4d5e837572a4813b73e40

Return ID

Response

Success

status'open' | 'in_transit' | 'delivered' | 'needs_review' | 'in_review' | 'complete' | 'rejected' | 'flagged' | 'pre_shipment' | 'deleted' required

Return status.

open: Return has been approved and is awaiting shipment.
in_transit: Return shipment is in transit.
delivered: Return shipment has been delivered and awaiting processing.
needs_review: Return requires review before further action.
in_review: Return is currently being reviewed.
complete: The return has been completed successfully.
rejected: The return has been rejected.
flagged: A problem with return processing requires merchant action.
pre_shipment: Return requires pre-shipment merchant authorization.
deleted: The return has been deleted (Reset).

Example response

{
  "status": "open"
}

Changes

No recorded changes to this operation across all 1 revision of this API.