Use this call to search for processed orders.
| Name | Type | Description |
|---|---|---|
| from | Nullable<DateTime> | The lower end of the date range to search. Can be null if searching for 'all dates'. Maximum range is 3 months. |
| to | Nullable<DateTime> | The upper end of the date range to search. Can be null if searching for 'all dates'. Maximum range is 3 months. |
| dateType | SearchDateType | The search type (e.g. ALLDATES) |
| searchField | String | The field to search by. Can be found by calling GetSearchTypes. |
| exactMatch | Boolean | Set to true if an exact match is required for the search data. |
| searchTerm | String | The term which you are searching for. |
| pageNum | Int32 | The page number of the request. |
| numEntriesPerPage | Int32 | The number of entries required on a page. Maximum 200. |
| cancellationToken | CancellationToken |
The following request format is required for this method.
GET | POST https://eu-ext.linnworks.net/api/ProcessedOrders/SearchProcessedOrdersPagedConnection: 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.
from=2023-01-10T13:49:45.6295598+00:00&to=2023-01-10T13:49:45.6295598+00:00&dateType=0&searchField=sample string 1&exactMatch=true&searchTerm=sample string 1&pageNum=1&numEntriesPerPage=1&cancellationToken={
"IsCancellationRequested": false,
"CanBeCanceled": false,
"WaitHandle": {
"Handle": {
"value": 1292
},
"SafeWaitHandle": {
"IsInvalid": false,
"IsClosed": false
}
}
}This is an example of the response JSON. Results will vary depending on your data.
{
"PageNumber": 1,
"EntriesPerPage": 2,
"TotalEntries": 3,
"TotalPages": 2,
"Data": [
{
"pkOrderID": "a2200ee5-dc45-423b-b0c0-3a2a0ae873bd",
"cShippingAddress": "sample string 2",
"dReceivedDate": "2023-01-10T13:49:50.2657351+00:00",
"dProcessedOn": "2023-01-10T13:49:50.2657351+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": "2023-01-10T13:49:50.2657351+00:00",
"dCancelledOn": "2023-01-10T13:49:50.2657351+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"
}
]
}