Search Processed Orders
| Name | Type | Description |
|---|---|---|
| request | SearchProcessedOrdersRequest | Search parameters consisting of keyword, dates, filters and sorting. |
| cancellationToken | CancellationToken |
The following request format is required for this method.
This is an example of the request structure. Results will vary depending on your data.
GET https://eu-ext.linnworks.net/api/ProcessedOrders/SearchProcessedOrders?request=%7B%0D%0A%20%20%22SearchTerm%22%3A%20%22sample%20string%201%22%2C%0D%0A%20%20%22SearchFilters%22%3A%20%5B%0D%0A%20%20%20%20%7B%0D%0A%20%20%20%20%20%20%22SearchField%22%3A%200%2C%0D%0A%20%20%20%20%20%20%22SearchTerm%22%3A%20%22sample%20string%201%22%0D%0A%20%20%20%20%7D%0D%0A%20%20%5D%2C%0D%0A%20%20%22DateField%22%3A%20%22processed%22%2C%0D%0A%20%20%22FromDate%22%3A%20%222022-01-13T12%3A45%3A40.9083041%2B00%3A00%22%2C%0D%0A%20%20%22ToDate%22%3A%20%222022-01-13T12%3A45%3A40.9083041%2B00%3A00%22%2C%0D%0A%20%20%22PageNumber%22%3A%202%2C%0D%0A%20%20%22ResultsPerPage%22%3A%203%2C%0D%0A%20%20%22SearchSorting%22%3A%20%7B%0D%0A%20%20%20%20%22SortField%22%3A%20%22sample%20string%201%22%2C%0D%0A%20%20%20%20%22SortDirection%22%3A%200%0D%0A%20%20%7D%0D%0A%7D&cancellationToken=%7B%0D%0A%20%20%22IsCancellationRequested%22%3A%20false%2C%0D%0A%20%20%22CanBeCanceled%22%3A%20false%2C%0D%0A%20%20%22WaitHandle%22%3A%20%7B%0D%0A%20%20%20%20%22Handle%22%3A%20%7B%0D%0A%20%20%20%20%20%20%22value%22%3A%201388%0D%0A%20%20%20%20%7D%2C%0D%0A%20%20%20%20%22SafeWaitHandle%22%3A%20%7B%0D%0A%20%20%20%20%20%20%22IsInvalid%22%3A%20false%2C%0D%0A%20%20%20%20%20%20%22IsClosed%22%3A%20false%0D%0A%20%20%20%20%7D%0D%0A%20%20%7D%0D%0A%7DConnection: keep-alive
Accept: application/json
Accept-Encoding: gzip, deflate
Authorization: INSERT_YOUR_TOKEN_HERE
POST https://eu-ext.linnworks.net/api/ProcessedOrders/SearchProcessedOrdersConnection: keep-alive
Accept: application/json
Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Accept-Encoding: gzip, deflate
Authorization: INSERT_YOUR_TOKEN_HERE
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": "2022-01-13T12:45:40.9083041+00:00",
"ToDate": "2022-01-13T12:45:40.9083041+00:00",
"PageNumber": 2,
"ResultsPerPage": 3,
"SearchSorting": {
"SortField": "sample string 1",
"SortDirection": 0
}
}&cancellationToken={
"IsCancellationRequested": false,
"CanBeCanceled": false,
"WaitHandle": {
"Handle": {
"value": 1388
},
"SafeWaitHandle": {
"IsInvalid": false,
"IsClosed": false
}
}
}This is an example of the response JSON. Results will vary depending on your data.
{
"ProcessedOrders": {
"PageNumber": 1,
"EntriesPerPage": 2,
"TotalEntries": 3,
"TotalPages": 2,
"Data": [
{
"pkOrderID": "76306805-34eb-41eb-90d4-296e9465fa7a",
"cShippingAddress": "sample string 2",
"dReceivedDate": "2022-01-13T12:45:46.6683922+00:00",
"dProcessedOn": "2022-01-13T12:45:46.6683922+00:00",
"timeDiff": 5.1,
"fPostageCost": 6.1,
"fTotalCharge": 7.1,
"PostageCostExTax": 8.1,
"Subtotal": 9.1,
"fTax": 10.1,
"TotalDiscount": 11.1,
"ProfitMargin": 12.1,
"CountryTaxRate": 13.1,
"nOrderId": 14,
"nStatus": 15,
"cCurrency": "sample string 16",
"PostalTrackingNumber": "sample string 17",
"cCountry": "sample string 18",
"Source": "sample string 19",
"PostalServiceName": "sample string 20",
"PostalServiceCode": "sample string 21",
"Vendor": "sample string 22",
"BillingEmailAddress": "sample string 23",
"ReferenceNum": "sample string 24",
"SecondaryReference": "sample string 25",
"ExternalReference": "sample string 26",
"Address1": "sample string 27",
"Address2": "sample string 28",
"Address3": "sample string 29",
"Town": "sample string 30",
"Region": "sample string 31",
"BuyerPhoneNumber": "sample string 32",
"Company": "sample string 33",
"SubSource": "sample string 34",
"ChannelBuyerName": "sample string 35",
"AccountName": "sample string 36",
"cFullName": "sample string 37",
"cEmailAddress": "sample string 38",
"cPostCode": "sample string 39",
"dPaidOn": "2022-01-13T12:45:46.6683922+00:00",
"dCancelledOn": "2022-01-13T12:45:46.6683922+00:00",
"PackageCategory": "sample string 42",
"PackageTitle": "sample string 43",
"ItemWeight": 44.1,
"TotalWeight": 45.1,
"FolderCollection": "sample string 46",
"cBillingAddress": "sample string 47",
"BillingName": "sample string 48",
"BillingCompany": "sample string 49",
"BillingAddress1": "sample string 50",
"BillingAddress2": "sample string 51",
"BillingAddress3": "sample string 52",
"BillingTown": "sample string 53",
"BillingRegion": "sample string 54",
"BillingPostCode": "sample string 55",
"BillingCountryName": "sample string 56",
"BillingPhoneNumber": "sample string 57",
"HoldOrCancel": true,
"IsResend": true,
"IsExchange": true,
"TaxId": "sample string 61",
"FulfilmentLocationName": "sample string 62"
}
]
}
}