Sign in

v1

latestOpenAPI 3.0.02026-07-266521,3121.2 MB
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

get/api/ReturnsRefunds/SearchReturnsRefundsPaged

Query parameters

fromstring date-time

The lower end of the date range to search. Can be null if searching for 'all dates'. Maximum range is 3 months.

tostring date-time

The upper end of the date range to search. Can be null if searching for 'all dates'. Maximum range is 3 months.

dateType'ALLDATES' | 'RECEIVED' | 'PROCESSED' | 'BOOKED' | 'ACTIONED'

The search type (e.g. ALLDATES)

searchFieldstring

The field to search by. Can be found by calling GetSearchTypes.

exactMatchboolean

Set to true if an exact match is required for the search data.

searchTermstring

The term which you are searching for.

pageNuminteger

The page number of the request.

numEntriesPerPageinteger

The number of entries required on a page. Maximum 200.

historyType'RETURNS' | 'REFUNDS' | 'CANCELLATIONS'

Search type. Allow RETURNS or REFUNDS

Response

OK

PageNumberinteger

Result page number

EntriesPerPageinteger

Result page size, quantity of records per page

TotalEntriesinteger

Total records

TotalPagesinteger

Total pages

Example response

{
  "Data": [
    {
      "pkOrderID": "00000000-0000-0000-0000-000000000000",
      "fkReturnLocationId": "00000000-0000-0000-0000-000000000000",
      "pkRefundRowId": "00000000-0000-0000-0000-000000000000",
      "fkOrderItemReturnId": "00000000-0000-0000-0000-000000000000"
    }
  ]
}