/returns
List customer returns
Returns a paginated list of customer returns, sorted by returnNumber. ?modifiedSince= returns both created and modified returns, so it can be used for delta sync; deletions are reported by GET /preview/deletions.
Query parameters
| Field | Type | Description |
|---|---|---|
search
|
string | Matches return number and RMA number, case-insensitively and on partial words. |
status
|
enum |
Filters on how far the return has been processed.
Draft
Approved
Received
CreditNoted
Closed
Cancelled
|
orderNumber
|
string | Returns only the returns raised against this sales order number. |
customerNumber
|
string | Returns only the returns from this customer number. |
modifiedSince
|
string(date-time) | Returns only records created or changed at or after this instant (ISO 8601 UTC datetime). A change anywhere inside the record counts, including on its lines. |
page
|
integer | Page to return, 1-based. Default 1. |
pageSize
|
integer | Number of records per page. Default 50, max 200. |
Responses
PagedResult_PublicReturnResponse
Paginated response: the fields below sit in items[], wrapped in totalCount, page, pageSize, totalPages, hasPreviousPage and hasNextPage. Paginated
| Field | Type | Description |
|---|---|---|
createdDate
|
string(date-time) | UTC timestamp when the return was created. |
currencyCode
|
string · nullable | ISO 4217 currency code the return is valued in. |
customerNumber
|
string · nullable | Customer number the return belongs to. Null if the customer has no number. |
externalNotes
|
string · nullable | Notes visible to the customer. Null if not set. |
lines
|
ReturnLine[] · nullable | The return's lines. |
links
|
Links | Hypermedia links for a public API resource. Exposed as a computed `links` property on the public response DTOs so that create and read responses carry the same self-reference — the canonical URL is derived from the business key already present on the DTO and can never drift from the route it points at. |
modifiedDate
|
string(date-time) · nullable | UTC timestamp when the return was last modified. Null if never modified. |
orderNumber
|
string · nullable | Order number the goods were returned from. |
reason
|
string · nullable | Why the goods came back: Defective, WrongItem, DamagedInTransit, CustomerRemorse, Warranty, QualityIssue, OverDelivery or Other. |
receivedDate
|
string(date) · nullable | Date the goods arrived back (ISO 8601 date). Null until received. |
returnDate
|
string(date) | Date the return was registered (ISO 8601 date). |
returnNumber
|
string · nullable | Unique return number. |
rmaNumber
|
string · nullable | The customer's own RMA reference. Null if not set. |
status
|
enum |
Status of a customer return.
Draft
Approved
Received
CreditNoted
Closed
Cancelled
|
totalAmount
|
decimal | Net total of the returned lines. Serialised as a decimal string. |
totalVat
|
decimal | Total VAT on the returned lines. Serialised as a decimal string. |
warehouseCode
|
string · nullable | Warehouse the goods are returned to. |
ProblemDetails
?status= got a value outside its list.
| Field | Type |
|---|---|
detail
|
string · nullable |
instance
|
string · nullable |
status
|
integer · nullable |
title
|
string · nullable |
type
|
string · nullable |
Standard errors:
401
403
Errors
Examples
curl "https://api.erp.fluit.cloud/preview/returns" \
-H "X-Api-Key: fluit_live_sk_..."{
"hasNextPage": true,
"hasPreviousPage": true,
"items": [
{
"createdDate": "2026-06-11T09:24:13.418",
"currencyCode": "SEK",
"customerNumber": "CUST-001",
"externalNotes": "string",
"lines": [
{
"condition": "string",
"itemName": "Widget A",
"itemNumber": "WIDGET-A",
"lineNumber": 1,
"lineTotal": "299.00",
"notes": "string",
"orderLineNumber": 42,
"quantity": "10",
"unitPrice": "299.00"
}
],
"links": {
"self": "string"
},
"modifiedDate": "2026-06-11T09:24:13.418",
"orderNumber": "SO-2026-1041",
"reason": "string",
"receivedDate": "2026-06-11",
"returnDate": "2026-06-11",
"returnNumber": "RMA-2026-0037",
"rmaNumber": "ABC-001",
"status": "Draft",
"totalAmount": "299.00",
"totalVat": "299.00",
"warehouseCode": "MAIN"
}
],
"page": 1,
"pageSize": 50,
"totalCount": 137,
"totalPages": 3
}Base URL https://api.erp.fluit.cloud/preview. The response example is generated from the schema: the shape is right, the values are made up.