v1

latestOpenAPI 3.0.02026-07-266521,3121.2 MB

ReturnsRefunds

CreateReturnsRefundsCSV

Creates a CSV file of the search result for download Permissions Required: GlobalPermissions.OrderBook.ReturnsRefundsNode Rate limit: 150 / minute

get/api/ReturnsRefunds/CreateReturnsRefundsCSV

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.

sortColumnstring

The column to sort by

sortDirectionboolean

The sort direction (true = ascending, false = descending).

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

Search type. Allow RETURNS or REFUNDS

string required