Content > API Reference > Order Management > Methods > GetFilteredOrders

GetFilteredOrders

The method can be used to retrieve orders from the system. The method expects a filter request parameter which enables you to specify the search parameters for the order data set to be retrieved. The method returns response type GetFilteredOrdersResponse which includes the list of orders of type Order. The result is split into pages, maximum of 100 orders per page. The response returns MorePages indicator if there are more pages for the request.

Syntax

GetFilteredOrders(Token, GetOrdersFilter)

GetOrdersFilter

You must supply filtering with every request when getting orders from the system

OrderDateFromIsSet	boolean	Specifies whether OrderDateFrom is set. Default False – OrderDateFrom is disregarded
OrderDateFrom	datetime	If set, only orders from this date will be included
OrderDateToIsSet	boolean	Specifies whether OrderDateTo is set. Default False – OrderDateTo is disregarded
OrderDateTo	datetime	If set, only orders to this date will be included
OrderProcessDateFromIsSet	boolean	Specifies whether OrderProcessDateFrom is set. Default False – OrderProcessDateFrom is disregarded
OrderProcessDateFrom	datetime	If set, only orders that have been processed after this date will be included.
OrderProcessDateToIsSet	boolean	Specifies whether OrderProcessDateTo is set. Default False – OrderProcessDateTo is disregarded
OrderProcessDateTo	datetime	If set, only order processed before this date is date will be included.
OrderIdIsSet	boolean	Specifies whether OrderId is set. Default False – OrderId is disregarded
OrderId	int	If specified, the response will return only order with the specified id
pkOrderIdIsSet	boolean	Specifies whether pkOrderId is set. Default False – pkOrderId is disregarded
pkOrderId	guid	Internal Linnworks orderid. If specified, the response will return only the order with this id.
ProcessedIsSet	boolean	Specifies whether Processed is set. Default False – Processed is disregarded
Processed	boolean	If set to True, only processed order will be returned. If to False, only open orders will be returned. If ProcessedIdSet is set to False, both open and processed order will be returned.
Source	string	Default – null. If set to a value only orders with this source will be returned.
SubSource	string	Default – null. If set to a value only orders with this SubSource will be returned.
Location	string	Default – null. If set to a value only orders assigned to specified location will be returned.
OrderFolder	string	Default – null. If set to a value only orders assigned to specified Order Folder will be returned.
StatusIsSet	boolean	Specifies whether Status is set. Default False – Status is disregarded
Status	int	Default – Int.MinValue. If StatusIsSet is set to to True, only orders with specified Status. 0 - unpaid, 1 - paid, 2 - return, 3 - pending, 4 - resend
ExcludeOnHold	boolean	Required – Default True – if set to True OnHold orders will not be returned. Also Cancelled orders will not be orders.
ExcludeParked	boolean	Required – Default True – if set to True Parked orders will not be returned.
EntriesPerPage	int	Required – specifies how many orders will be returned per query.
PageNumber	int	Required – specifies the page number of the request

GetFilteredOrdersResponse

Error	string	If IsError is set to true. There was an error and Error will contain full error message
ErrorNum	int	Error number. See Error Codes
IsError	boolean	Indicates whether there was an error executing or validating the request.
MorePages	boolean	Indicates whether there are more orders in the request. Increment PageNumber in the request and execute another request.
Orders	Array[] type Order	If request is successfully executed. This array will contain orders classes.