Back

Search

Search

Methods

Inventory

Orders

ProcessedOrders /SearchProcessedOrders

Response: SearchProcessedOrdersResponse



Search Processed Orders

Parameters

NameTypeDescription
requestSearchProcessedOrdersRequestSearch parameters consisting of keyword, dates, filters and sorting.

HTTP Endpoint

Server /ProcessedOrders / SearchProcessedOrders

Permissions

GlobalPermissions.OrderBook.ProcessedOrdersNode

Example Code

Example Request

The following request format is required for this method.

POST https://eu-ext.linnworks.net//api/ProcessedOrders/SearchProcessedOrders 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

request={
  "SearchTerm": "sample string 1",
  "SearchFilters": [
    {
      "SearchField": 0,
      "SearchTerm": "sample string 1"
    },
    {
      "SearchField": 0,
      "SearchTerm": "sample string 1"
    }
  ],
  "DateField": "processed",
  "FromDate": "2018-10-03T11:12:33.1155339+01:00",
  "ToDate": "2018-10-03T11:12:33.1155339+01:00",
  "PageNumber": 2,
  "ResultsPerPage": 3,
  "SearchSorting": {
    "SortField": "sample string 1",
    "SortDirection": 0
  }
}

Response

This is an example response. Results may vary depending on your data.

{
  "ProcessedOrders": {
    "PageNumber": 1,
    "EntriesPerPage": 2,
    "TotalEntries": 3,
    "TotalPages": 2,
    "Data": [
      {
        "pkOrderID": "f1ef72dc-ca1d-4a27-9607-3edd96b1643c",
        "cShippingAddress": "sample string 2",
        "dReceivedDate": "2018-10-03T11:12:35.615295+01:00",
        "dProcessedOn": "2018-10-03T11:12:35.615295+01: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": "2018-10-03T11:12:35.615295+01:00",
        "dCancelledOn": "2018-10-03T11:12:35.615295+01: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
      },
      {
        "pkOrderID": "f1ef72dc-ca1d-4a27-9607-3edd96b1643c",
        "cShippingAddress": "sample string 2",
        "dReceivedDate": "2018-10-03T11:12:35.615295+01:00",
        "dProcessedOn": "2018-10-03T11:12:35.615295+01: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": "2018-10-03T11:12:35.615295+01:00",
        "dCancelledOn": "2018-10-03T11:12:35.615295+01: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
      }
    ]
  }
}