Searches through returns/refunds history that meets the parameters' criteria
| Name | Type | Description |
|---|---|---|
| from | Nullable<DateTime> | The lower end of the date range to search. Can be null if searching for 'all dates'. Maximum range is 3 months. |
| to | Nullable<DateTime> | The upper end of the date range to search. Can be null if searching for 'all dates'. Maximum range is 3 months. |
| dateType | ReturnsRefundsSearchDateType | The search type (e.g. ALLDATES) |
| searchField | String | The field to search by. Can be found by calling GetSearchTypes. |
| exactMatch | Boolean | Set to true if an exact match is required for the search data. |
| searchTerm | String | The term which you are searching for. |
| pageNum | Int32 | The page number of the request. |
| numEntriesPerPage | Int32 | The number of entries required on a page. Maximum 200. |
| historyType | HistoryType | Search type. Allow RETURNS or REFUNDS |
The following request format is required for this method.
GET | POST https://eu-ext.linnworks.net/api/ReturnsRefunds/SearchReturnsRefundsPagedConnection: keep-alive
Accept: application/json
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Accept-Encoding: gzip, deflate
Authorization: INSERT_YOUR_TOKEN_HERE
This is an example of the request structure. Results will vary depending on your data.
from=2023-01-10T13:49:13.1722001+00:00&to=2023-01-10T13:49:13.1722001+00:00&dateType=0&searchField=sample string 1&exactMatch=true&searchTerm=sample string 1&pageNum=1&numEntriesPerPage=1&historyType=0This is an example of the response JSON. Results will vary depending on your data.
{
"PageNumber": 1,
"EntriesPerPage": 2,
"TotalEntries": 3,
"TotalPages": 2,
"Data": [
{
"Row": 1,
"pkOrderID": "43285521-b4f4-42a0-8f03-713d4ab84099",
"cShippingAddress": "sample string 3",
"dProcessedOn": "2023-01-10T13:49:46.8657162+00:00",
"fPostageCost": 5.1,
"fTotalCharge": 6.1,
"PostageCostExTax": 7.1,
"Subtotal": 8.1,
"fTax": 9.1,
"TotalDiscount": 10.1,
"CountryTaxRate": 11.1,
"nOrderId": 12,
"cCurrency": "sample string 13",
"PostalTrackingNumber": "sample string 14",
"cCountry": "sample string 15",
"Source": "sample string 16",
"PostalServiceName": "sample string 17",
"PostalServiceCode": "sample string 18",
"Vendor": "sample string 19",
"ReferenceNum": "sample string 20",
"SecondaryReference": "sample string 21",
"ExternalReference": "sample string 22",
"Address1": "sample string 23",
"Address2": "sample string 24",
"Address3": "sample string 25",
"Town": "sample string 26",
"Region": "sample string 27",
"BuyerPhoneNumber": "sample string 28",
"Company": "sample string 29",
"SubSource": "sample string 30",
"ChannelBuyerName": "sample string 31",
"AccountName": "sample string 32",
"cFullName": "sample string 33",
"cEmailAddress": "sample string 34",
"cPostCode": "sample string 35",
"dPaidOn": "2023-01-10T13:49:46.8657162+00:00",
"cBillingAddress": "sample string 37",
"BillingName": "sample string 38",
"BillingCompany": "sample string 39",
"BillingAddress1": "sample string 40",
"BillingAddress2": "sample string 41",
"BillingAddress3": "sample string 42",
"BillingTown": "sample string 43",
"BillingRegion": "sample string 44",
"BillingPostCode": "sample string 45",
"BillingCountryName": "sample string 46",
"BillingPhoneNumber": "sample string 47",
"cItemNumber": "sample string 48",
"cItemName": "sample string 49",
"pkReturnId": 50,
"RowType": "sample string 51",
"ReturnReference": "sample string 52",
"PendingRefundAmount": 53.1,
"LastDate": "2023-01-10T13:49:46.8667112+00:00",
"Reason": "sample string 55",
"ChannelReason": "sample string 56",
"ChannelReasonSec": "sample string 57",
"Category": "sample string 58",
"ReturnQty": 59,
"fkReturnLocationId": "4d61eaa0-9ba6-4037-ad71-1b49dbda7e02",
"Scrapped": true,
"ScrapQty": 1,
"ReturnDate": "2023-01-10T13:49:46.8667112+00:00",
"Location": "sample string 63",
"ItemNumber": "sample string 64",
"ItemTitle": "sample string 65",
"NewQty": 66,
"RefundReference": "sample string 67",
"pkRefundRowId": "8e2052dd-8341-4bed-8991-8276b8964122",
"Amount": 69.1,
"CreateDate": "2023-01-10T13:49:46.8667112+00:00",
"CancellationQuantity": 71,
"fkOrderItemReturnId": "894b4f1b-bdde-4a00-b3d9-c6985f935295",
"ActionDate": "2023-01-10T13:49:46.8667112+00:00",
"RefundStatus": 0
}
]
}