Docs
Dashboard
DocsAPI ReferenceReturns

Returns API

Create and manage return requests, process refunds, and handle RMA workflows.

Base URL:https://gateway.regentherapy.com/api/v1/returns
Return Status Flow
Requested
Approved
Shipped
Received
Inspected
Refunded

Alternative: REQUESTED → REJECTED (with reason)

Endpoints
POST/

Create a return request

Request Body

{
  "orderId": "ord_abc123",
  "items": [
    {
      "orderItemId": "oi_xyz789",
      "quantity": 1,
      "reason": "DEFECTIVE",
      "reasonDetails": "Product arrived damaged",
      "condition": "UNOPENED"
    }
  ],
  "returnType": "REFUND",  // REFUND, EXCHANGE, STORE_CREDIT
  "customerNotes": "Item was damaged in shipping"
}

Response

{
  "id": "ret_def456",
  "rmaNumber": "RMA-2024-001234",
  "orderId": "ord_abc123",
  "status": "REQUESTED",
  "returnType": "REFUND",
  "items": [...],
  "estimatedRefund": 49.99,
  "returnLabel": null,
  "createdAt": "2024-01-15T10:30:00Z"
}
Return Reason Codes
CodeDescriptionAuto-Approve
DEFECTIVEProduct is defective or not workingYes
WRONG_ITEMReceived wrong itemYes
DAMAGED_SHIPPINGDamaged during shippingYes
NOT_AS_DESCRIBEDItem not as describedReview
CHANGED_MINDCustomer changed mindReview
OTHEROther reason (requires details)Review
Return Webhook Events
return.requestedNew return request created
return.approvedReturn approved, label generated
return.rejectedReturn request rejected
return.receivedReturn arrived at warehouse
return.refundedRefund processed
← Shipping APIWebhooks