Skip to main content
GET
/
api
/
supplier-return-plans
List supplier return plans (return-to-vendor / RTV)
curl --request GET \
  --url https://app.solya.app/api/supplier-return-plans \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "code": "SR-ADS-001",
      "creditAmount": null,
      "creditNoteRef": null,
      "creditedAt": null,
      "deadline": "2025-09-30",
      "description": "First return batch for Adidas FW25 overstocked units",
      "expectedCreditAmount": 1250,
      "id": "srp-uuid-001",
      "itemsQty": 18,
      "name": "Adidas FW25 Return Wave 1",
      "notes": null,
      "sentAt": "2025-09-15T10:30:00.000Z",
      "sourceShopId": "550e8400-e29b-41d4-a716-446655440020",
      "status": "SENT",
      "supplierId": "550e8400-e29b-41d4-a716-446655440010"
    }
  ],
  "page": 1,
  "pageSize": 20,
  "total": 1
}

Authorizations

​
Authorization
string
header
required

User session token issued by NextAuth. For human users accessing Solya via the web application.

Query Parameters

​
supplierId
string

Filter by supplier identifier

​
status
enum<string>

Filter by plan status

Available options:
DRAFT,
SENT,
CREDITED,
CLOSED
​
search
string

Case-insensitive substring filter on plan name or code

​
page
number
default:1

Page number, starting from 1

​
pageSize
number
default:20

Number of plans per page

Response

Successful response

​
data
object
required
​
success
enum<boolean>
required
Available options:
true