Back

Search

Search

Methods

Inventory

OrderPrintStatus
Orders

ReturnsRefunds /CreateReturnsRefundsCSV

Allows 150 calls per minute

Response: String



Creates a CSV file of the search result for download

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.
sortColumnStringThe column to sort by
sortDirectionBooleanThe sort direction (true = ascending, false = descending).
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/CreateReturnsRefundsCSV

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=2023-01-10T13:49:13.1732256+00:00&to=2023-01-10T13:49:13.1732256+00:00&dateType=0&searchField=sample string 1&exactMatch=true&searchTerm=sample string 1&sortColumn=sample string 1&sortDirection=true&historyType=0

Response

This is an example of the response JSON. Results will vary depending on your data.

"sample string 1"