List all RMA orders for tenant

List all RMA orders for tenant

Required permissions: RMA_ORDER

get

/tenants/{tenantUid}/rma-orders

Authorizations

AuthorizationstringRequired

Access token recevied after user login with a deviceToken

Path parameters

tenantUidstringRequired

Reference to a tenant.

Pattern: ^[A-Za-z0-9-_]+

Query parameters

pageNumberintegerOptional

Reference to a specific page in a result set.

pageSizeintegerOptional

The number of items per page in a result set.

sortBystringOptional

Defines which field the resource list is sorted by.

sortDirectionstring · enumOptional

ENUM	Description
ASC	Sort in ascending order
DESC	Sort in descending order

Possible values:

rmaOrderStoreUidstringOptional

Reference to a storeUid

rmaOrderSupplierUidstringOptional

Reference to a supplierUid

rmaOrderFromDatestring · dateOptional

Reference to a date

rmaOrderToDatestring · dateOptional

Reference to a date

rmaOrderReasonstringOptional

Case-insensitive partial match on the RMA order reason.

Responses

200

Example response

application/json

get/tenants/{tenantUid}/rma-orders

GET /v2/tenants/{tenantUid}/rma-orders HTTP/1.1
Host: api.flowretail.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Example response

{
  "items": [
    {
      "note": "text",
      "storeUid": "text",
      "storeName": "text",
      "supplierUid": "text",
      "supplierName": "text",
      "supplierReference": "text",
      "ourReference": "text",
      "reason": "text",
      "reference": "text",
      "status": "NEW",
      "rmaNumber": "text",
      "items": [
        {
          "requestedQuantity": 1,
          "productUid": "text",
          "sku": "text",
          "name": "text",
          "supplierSku": "text",
          "serialNumber": "text",
          "requestedUnitPrice": 1,
          "requestedLinePrice": 1,
          "note": "text",
          "warehouseUid": "text",
          "createdAt": "2026-01-01T00:00:00.000Z",
          "lastModifiedAt": "2026-01-01T00:00:00.000Z",
          "createdBy": "text",
          "lastModifiedBy": "text",
          "rmaOrderItemUid": "text",
          "serviceOrderUid": "text",
          "customerUid": "text",
          "customerName": "text",
          "originalPurchaseNumber": "text",
          "supplierReferenceNumber": "text"
        }
      ],
      "createdAt": "2026-01-01T00:00:00.000Z",
      "lastModifiedAt": "2026-01-01T00:00:00.000Z",
      "createdBy": "text",
      "lastModifiedBy": "text",
      "sentToSupplierAt": "text",
      "rmaOrderUid": "text"
    }
  ],
  "paging": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalCount": 1
  }
}