Back

Search

Search

Methods

Inventory

OrderPrintStatus
Orders

ShippingService

ProcessedOrders /DownloadOrdersToCSV

Allows 150 calls per minute

Response: DownloadOrdersToCSVResponse



Download Processed Orders to CSV

Parameters

NameTypeDescription
requestDownloadOrdersToCSVRequestRequest parameter populated with search critera for the file download
cancellationTokenCancellationToken

Permissions

GlobalPermissions.OrderBook.ProcessedOrdersNode

Example Request

The following request format is required for this method.

Endpoint URL

POST https://eu-ext.linnworks.net/api/ProcessedOrders/DownloadOrdersToCSV

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.

request={
  "SearchTerm": "sample string 1",
  "SearchFilters": [
    {
      "SearchField": 0,
      "SearchTerm": "sample string 1"
    }
  ],
  "DateField": "processed",
  "FromDate": "2021-07-29T09:24:11.6943332+01:00",
  "ToDate": "2021-07-29T09:24:11.6953334+01:00",
  "SearchSorting": {
    "SortField": "sample string 1",
    "SortDirection": 0
  }
}&cancellationToken={
  "IsCancellationRequested": false,
  "CanBeCanceled": false,
  "WaitHandle": {
    "Handle": {
      "value": 1248
    },
    "SafeWaitHandle": {
      "IsInvalid": false,
      "IsClosed": false
    }
  }
}

Response

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

{
  "Url": "sample string 1",
  "DownloadProgress": 2.1,
  "UploadProgress": 3.1,
  "Id": "7a524705-b74a-4eeb-bc7f-f3116e254408",
  "CreationDate": "sample string 5"
}