Back

Search

Search

Methods

Inventory

OrderPrintStatus
Orders

ReturnsRefunds /SearchReturnsRefundsPaged

Allows 150 calls per minute

Response: GenericPagedResult<ReturnsRefundsWeb>



Searches through returns/refunds history that meets the parameters' criteria

Parameters

NameTypeDescription
fromNullable<DateTime>The lower end of the date range to search. Can be null if searching for 'all dates'. Maximum range is 3 months.
toNullable<DateTime>The upper end of the date range to search. Can be null if searching for 'all dates'. Maximum range is 3 months.
dateTypeReturnsRefundsSearchDateTypeThe search type (e.g. ALLDATES)
searchFieldStringThe field to search by. Can be found by calling GetSearchTypes.
exactMatchBooleanSet to true if an exact match is required for the search data.
searchTermStringThe term which you are searching for.
pageNumInt32The page number of the request.
numEntriesPerPageInt32The number of entries required on a page. Maximum 200.
historyTypeHistoryTypeSearch type. Allow RETURNS or REFUNDS

Permissions

GlobalPermissions.OrderBook.ReturnsRefundsNode

Example Request

The following request format is required for this method.

Endpoint URL

GET | POST https://eu-ext.linnworks.net/api/ReturnsRefunds/SearchReturnsRefundsPaged

Headers

Connection: keep-alive
Accept: application/json
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Accept-Encoding: gzip, deflate
Authorization: INSERT_YOUR_TOKEN_HERE

Request Body

This is an example of the request structure. Results will vary depending on your data.

from=2022-09-05T15:10:00.543534+03:00&to=2022-09-05T15:10:00.543534+03:00&dateType=0&searchField=sample string 1&exactMatch=true&searchTerm=sample string 1&pageNum=1&numEntriesPerPage=1&historyType=0

Response

This 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": "91b3d517-ca56-42c2-ad11-225e00ed91d5",
      "cShippingAddress": "sample string 3",
      "dProcessedOn": "2022-09-05T15:10:03.0299658+03: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": "2022-09-05T15:10:03.0319644+03: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": "2022-09-05T15:10:03.0319644+03:00",
      "Reason": "sample string 55",
      "ChannelReason": "sample string 56",
      "ChannelReasonSec": "sample string 57",
      "Category": "sample string 58",
      "ReturnQty": 59,
      "fkReturnLocationId": "af6ee736-4ba7-438d-b6e5-5aa93e9a6cf2",
      "Scrapped": true,
      "ScrapQty": 1,
      "ReturnDate": "2022-09-05T15:10:03.0329628+03:00",
      "Location": "sample string 63",
      "ItemNumber": "sample string 64",
      "ItemTitle": "sample string 65",
      "NewQty": 66,
      "RefundReference": "sample string 67",
      "pkRefundRowId": "90eabff5-d516-4619-b5fa-6d0491e5617f",
      "Amount": 69.1,
      "CreateDate": "2022-09-05T15:10:03.0329628+03:00",
      "CancellationQuantity": 71,
      "fkOrderItemReturnId": "0ed84230-83bc-46bd-ae38-1678345625ff",
      "ActionDate": "2022-09-05T15:10:03.0329628+03:00",
      "RefundStatus": 0
    }
  ]
}