API Reference
  1. Lidia Order
  2. Query > Orders > Orders

GetOrders

post
https://{yourlidiaurl}/order/query/orders

Queries and retrieves orders matching the specified criteria.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The order query filters including date ranges, statuses, owner information, and pagination.

string | null

Gets or sets a comma-separated list of order IDs to filter by.

string | null

Gets or sets a comma-separated list of order reference numbers to filter by.

string | null

Gets or sets a comma-separated list of owner user IDs to filter by.

string | null

Gets or sets a comma-separated list of order state values to filter by.

string | null

Gets or sets the start date for order date range filtering (format: yyyy-MM-dd HH:mm:ss).

string | null

Gets or sets the end date for order date range filtering (format: yyyy-MM-dd HH:mm:ss).

string | null

Gets or sets the minimum order total for price range filtering.

string | null

Gets or sets the maximum order total for price range filtering.

string | null

Gets or sets the channel reference code to filter orders by sales channel.

string | null

Gets or sets the supplier ID to include in the results.

string | null

Gets or sets a line name filter to include matching lines.

string | null

Gets or sets the start date for order update date range filtering.

string | null

Gets or sets the end date for order update date range filtering.

string | null

Gets or sets the start date for delivery date range filtering.

string | null

Gets or sets the end date for delivery date range filtering.

supplierIds
array of strings | null

Gets or sets the list of supplier IDs to filter orders by.

supplierIds
includeOwnerEmails
array of strings | null

Gets or sets a list of owner emails to include in results.

includeOwnerEmails
ownerEmails
array of strings | null

Gets or sets a list of owner emails to filter by.

ownerEmails
includeOwnerFullNames
array of strings | null

Gets or sets a list of owner full names to include in results.

includeOwnerFullNames
ownerFullNames
array of strings | null

Gets or sets a list of owner full names to filter by.

ownerFullNames
includeOrderIds
array of strings | null

Gets or sets a list of order IDs to explicitly include in results.

includeOrderIds
includeRefNumbers
array of strings | null

Gets or sets a list of reference numbers to explicitly include in results.

includeRefNumbers
includeRefNumbersPrefix
array of strings | null

Gets or sets a list of reference number prefixes to include in results.

includeRefNumbersPrefix
orderProperties
array of objects | null

Gets or sets a list of order properties to filter by (exact match).

orderProperties
includeOrderProperties
array of objects | null

Gets or sets a list of order properties to include results for.

includeOrderProperties
includeOrderPropertiesWithAnd
array of objects | null

Gets or sets a list of order properties where all must match (AND logic).

includeOrderPropertiesWithAnd
includeOrderPropertiesWithOr
array of objects | null

Gets or sets a list of order properties where any can match (OR logic).

includeOrderPropertiesWithOr
orderPropertyKeys
array of strings | null

Gets or sets the property keys to include in the result set.

orderPropertyKeys
excludeOrderPropertyKeys
array of strings | null

Gets or sets the property keys to exclude from the result set.

excludeOrderPropertyKeys
isMembers
array of booleans | null

Gets or sets membership status filters for order owners.

isMembers
orderTags
array of objects | null

Gets or sets a list of order tags to filter by.

orderTags
orderLineStates
array of objects | null

Gets or sets a list of order line states to filter by.

orderLineStates
deliveryPropertyKeys
array of strings | null

Gets or sets delivery property keys to include in the result set.

deliveryPropertyKeys
boolean

Gets or sets whether to include order property search key filtering.

string | null

Gets or sets the property key to search within order properties.

string | null

Gets or sets the property value to match when searching order properties.

string | null

Gets or sets the environment identifier (e.g., Production, Staging).

string | null

Gets or sets the IP address of the calling application.

string | null

Gets or sets the user token for authentication context.

string | null

Gets or sets the session identifier of the current user session.

string
^-?(?:0|[1-9]\d*)$

Gets or sets the numeric user identifier.

string | null

Gets or sets the IP address of the requesting user.

string | null

Gets or sets the envelope parameter for response shaping.

string | null

Gets or sets the thread identifier for request tracing and correlation.

includes
array of strings | null

Gets or sets the list of related entities to include in the response (e.g., Lines, Properties, Tags).

includes
string | null

Gets or sets the search keyword used for full-text or partial matching.

string
^-?(?:0|[1-9]\d*)$

Gets or sets the page index for pagination (1-based).

string
^-?(?:0|[1-9]\d*)$

Gets or sets the number of records per page for pagination.

string | null

Gets or sets the sorting expression (e.g., "Created desc", "Name asc").

status
array of objects | null

Gets or sets the list of entity statuses to filter by.

status
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json-patch+json

Generated from available request content types

Allowed:
Response

Updated 17 days ago

Did this page help you?
Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json

Updated 17 days ago

Did this page help you?