Back

Search

Search

Methods

Inventory

Orders

ReturnsRefunds /CreateReturnsRefundsCSV

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

HTTP Endpoint

Server /ReturnsRefunds / CreateReturnsRefundsCSV

Permissions

GlobalPermissions.OrderBook.ReturnsRefunds.ReturnsRefundsNode

Example Code

Example Request

The following request format is required for this method.

POST https://eu-ext.linnworks.net//api/ReturnsRefunds/CreateReturnsRefundsCSV HTTP/1.1
Host: eu-ext.linnworks.net
Connection: keep-alive
Accept: application/json, text/javascript, */*; q=0.01
Origin: https://www.linnworks.net
Accept-Language: en
User-Agent: Mozilla/5.0 (Windows NT 6.1; WOW64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/42.0.2311.90 Safari/537.36
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Referer: https://www.linnworks.net/
Accept-Encoding: gzip, deflate
Authorization: INSERT_YOUR_TOKEN_HERE

from=2018-02-19T16:57:06.1817197+00:00&to=2018-02-19T16:57:06.1817197+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 response. Results may vary depending on your data.

"sample string 1"