Recovery Status
Get the current status of a recovery.
GET
/api/v1/recoveries/{recovery_number}/statusDescription
Returns the recovery number and current workflow status of recovery.
Request
Headers
| Header | Value | Required |
|---|---|---|
| Authorization | Bearer <access_token> | Yes |
| Content-Type | application/json | Yes |
Path Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| recovery_number | string | Yes | Recovery code. |
Response
| Field | Type | Description |
|---|---|---|
| data | object | Recovery status payload. |
| data.recovery_number | string | Recovery code. |
| data.status | string | Recover workflow status. Examples: Order Received, Print Shipping Label, Boxes Shipped, Delivered, Label Requested, Label Delivered, Pickup Requested, Pickup Scheduled, Return Shipped, Box Received, Already Returned, Cancelled, Not Responsive, Recovery Failed, Recovery Order, Delivery Failed. |
Related Endpoints
Did this page help you?
Request
curl -X GET https://uat.unduit.com/api-exposed/api/v1/recoveries/REC-2026-001/status \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json"Success Response
{
"data": {
"recovery_number": "REC-2026-001",
"status": "Box Received"
}
}