---
title: "SearchProcessedOrders"
method: POST
path: "/api/ProcessedOrders/SearchProcessedOrders"
tags: ["ProcessedOrders"]
---

# SearchProcessedOrders

`POST /api/ProcessedOrders/SearchProcessedOrders`

Search Processed Orders
<b>Permissions Required: </b> GlobalPermissions.OrderBook.ProcessedOrdersNode
<b>Rate limit: </b><span style="background-color:#0272d9;color:white;padding:4px 8px;text-align:center;border-radius:5px; font-size: small;"><b>150</b></span> / minute

## Request body

- ProcessedOrdersSearchProcessedOrdersRequest
  - `request` SearchProcessedOrdersRequest
    - `SearchTerm` string — Search Term
    - `SearchFilters` SearchFilters[] — Search Filters
      - `SearchField` 'Source' | 'SubSource' | 'ItemIdentifier'
      - `SearchTerm` string
    - `DateField` 'processed' | 'payment' | 'cancelled' | 'received' — Date Field Type
    - `FromDate` string, date-time — From Date
    - `ToDate` string, date-time — To Date
    - `PageNumber` integer — Page Number
    - `ResultsPerPage` integer — Results Per Page
    - `SearchSorting` SearchSorting
      - `SortField` string
      - `SortDirection` 'ASC' | 'DESC'

## Response `200`

OK

- SearchProcessedOrdersResponse
  - `ProcessedOrders` GenericPagedResultProcessedOrderWeb — Order item object
    - `PageNumber` integer — Result page number
    - `EntriesPerPage` integer — Result page size, quantity of records per page
    - `TotalEntries` integer — Total records
    - `TotalPages` integer — Total pages
    - `Data` ProcessedOrderWeb[]
      - `pkOrderID` string, uuid — Order ID
      - `cShippingAddress` string — Customer's shipping address
      - `dReceivedDate` string, date-time — Date when order was received on a channel
      - `dProcessedOn` string, date-time — Date when order was processed
      - `timeDiff` number, double — Days elapsed between order received and order processed
      - `fPostageCost` number, double — Order postage cost
      - `fTotalCharge` number, double — Order total charge
      - `PostageCostExTax` number, double — Postage cost excluding tax
      - `Subtotal` number, double — Order subtotal
      - `fTax` number, double — Order tax
      - `TotalDiscount` number, double — Total discount
      - `ProfitMargin` number, double — Profit margin
      - `CountryTaxRate` number, double — Country specific tax rate
      - `nOrderId` integer — Linnworks order ID
      - `nStatus` integer — Order status
      - `cCurrency` string — Order currency
      - `PostalTrackingNumber` string — Postal tracking number
      - `cCountry` string — Country
      - `Source` string — ChannelName/Source (e.g. EBAY)
      - `PostalServiceName` string — Postal service name (e.g. Next day delivery)
      - `PostalServiceCode` string — Postal service code
      - `Vendor` string — Courier name (e.g. DPD)
      - `BillingEmailAddress` string
      - `ReferenceNum` string — Order reference number
      - `SecondaryReference` string — An additional reference number for the order
      - `ExternalReference` string — This is an additional reference number from the sales channel, typically used by eBay
      - `Address1` string — Order first line of address
      - `Address2` string — Order second line of address
      - `Address3` string — Order third line of address
      - `Town` string — Town
      - `Region` string — Region, county, area
      - `BuyerPhoneNumber` string — Buyer phone number
      - `Company` string — Company
      - `SubSource` string — Order subsource (e.g. EBAY1)
      - `ChannelBuyerName` string — Channel specific name used to identify the buyer, such as a username, normally used for eBay
      - `AccountName` string — Customer channel account name
      - `cFullName` string — Customer full name
      - `cEmailAddress` string — Customer email address
      - `cPostCode` string — Post Code
      - `dPaidOn` string, date-time — When order was marked as PAID
      - `dCancelledOn` string, date-time — When order was cancelled
      - `PackageCategory` string — Package category
      - `PackageTitle` string — Package name
      - `ItemWeight` number, double — Items weight
      - `TotalWeight` number, double — Total order weight
      - `FolderCollection` string — Folder name of an order
      - `cBillingAddress` string — Customer billing address
      - `BillingName` string — Customer billing name
      - `BillingCompany` string — Customer billing company
      - `BillingAddress1` string — Billing address line one
      - `BillingAddress2` string — Billing address line two
      - `BillingAddress3` string — Billing address line three
      - `BillingTown` string — Billing town
      - `BillingRegion` string — Billing region, area, county
      - `BillingPostCode` string — Billing postcode
      - `BillingCountryName` string — Billing country
      - `BillingPhoneNumber` string — Billing phone number
      - `HoldOrCancel` boolean — If order on hold or cancelled.
      - `IsResend` boolean — If order was created from a resend
      - `IsExchange` boolean — If order was created from an exchange
      - `TaxId` string — Order tax id
      - `FulfilmentLocationName` string — Order fulfilment location

---

[API](https://skmtc.net/linnworks/apis/authenticate-api.md) · [All operations](https://skmtc.net/linnworks/apis/authenticate-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/linnworks/authenticate-api/versions/0123569a22fb/schema)