---
title: "SearchReturnsRefundsPaged"
method: GET
path: "/api/ReturnsRefunds/SearchReturnsRefundsPaged"
tags: ["ReturnsRefunds"]
---

# SearchReturnsRefundsPaged

`GET /api/ReturnsRefunds/SearchReturnsRefundsPaged`

Searches through returns/refunds history that meets the parameters' criteria
<b>Permissions Required: </b> GlobalPermissions.OrderBook.ReturnsRefundsNode
<b>Rate limit: </b><span style="background-color:#0272d9;color:white;padding:4px 8px;text-align:center;border-radius:5px; font-size: small;"><b>150</b></span> / minute

## Query parameters

- `from` string, date-time
- `to` string, date-time
- `dateType` 'ALLDATES' | 'RECEIVED' | 'PROCESSED' | 'BOOKED' | 'ACTIONED'
- `searchField` string
- `exactMatch` boolean
- `searchTerm` string
- `pageNum` integer
- `numEntriesPerPage` integer
- `historyType` 'RETURNS' | 'REFUNDS' | 'CANCELLATIONS'

## Response `200`

OK

- GenericPagedResultReturnsRefundsWeb — Order item object
  - `PageNumber` integer — Result page number
  - `EntriesPerPage` integer — Result page size, quantity of records per page
  - `TotalEntries` integer — Total records
  - `TotalPages` integer — Total pages
  - `Data` ReturnsRefundsWeb[]
    - `Row` integer
    - `pkOrderID` string, uuid
    - `cShippingAddress` string
    - `dProcessedOn` string, date-time
    - `fPostageCost` number, double
    - `fTotalCharge` number, double
    - `PostageCostExTax` number, double
    - `Subtotal` number, double
    - `fTax` number, double
    - `TotalDiscount` number, double
    - `CountryTaxRate` number, double
    - `nOrderId` integer
    - `cCurrency` string
    - `PostalTrackingNumber` string
    - `cCountry` string
    - `Source` string
    - `PostalServiceName` string
    - `PostalServiceCode` string
    - `Vendor` string
    - `ReferenceNum` string
    - `SecondaryReference` string
    - `ExternalReference` string
    - `Address1` string
    - `Address2` string
    - `Address3` string
    - `Town` string
    - `Region` string
    - `BuyerPhoneNumber` string
    - `Company` string
    - `SubSource` string
    - `ChannelBuyerName` string
    - `AccountName` string
    - `cFullName` string
    - `cEmailAddress` string
    - `cPostCode` string
    - `dPaidOn` string, date-time
    - `cBillingAddress` string
    - `BillingName` string
    - `BillingCompany` string
    - `BillingAddress1` string
    - `BillingAddress2` string
    - `BillingAddress3` string
    - `BillingTown` string
    - `BillingRegion` string
    - `BillingPostCode` string
    - `BillingCountryName` string
    - `BillingPhoneNumber` string
    - `cItemNumber` string
    - `cItemName` string
    - `pkReturnId` integer
    - `RowType` string
    - `ReturnReference` string
    - `PendingRefundAmount` number, double
    - `LastDate` string, date-time
    - `Reason` string
    - `ChannelReason` string
    - `ChannelReasonSec` string
    - `Category` string
    - `ReturnQty` integer
    - `fkReturnLocationId` string, uuid
    - `Scrapped` boolean
    - `ScrapQty` integer
    - `ReturnDate` string, date-time
    - `Location` string
    - `ItemNumber` string
    - `ItemTitle` string
    - `NewQty` integer
    - `RefundReference` string
    - `pkRefundRowId` string, uuid
    - `Amount` number, double
    - `CreateDate` string, date-time
    - `CancellationQuantity` integer
    - `fkOrderItemReturnId` string, uuid
    - `ActionDate` string, date-time
    - `RefundStatus` 'OPEN' | 'PROCESSED' | 'ERROR' | 'ERROR_ACKED' | 'PENDING'

---

[API](https://skmtc.dev/linnworks/apis/authenticate-api.md) · [All operations](https://skmtc.dev/linnworks/apis/authenticate-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/linnworks/authenticate-api/revisions/0123569a22fb/schema)