GetDeliveries

post

https://{yourlidiaurl}/order/query/deliveries

Queries and retrieves deliveries matching the specified criteria.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The delivery query filters and pagination settings.

deliveryIds

string | null

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

orderIds

string | null

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

deliveryCodes

string | null

Gets or sets a comma-separated list of delivery codes to filter by.

sourceDeliveryCodes

array of strings | null

Gets or sets a list of source delivery codes to filter by.

sourceDeliveryCodes

refNumbers

string | null

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

supplierId

string | null

Gets or sets the supplier ID to filter deliveries by.

states

string | null

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

fromDate

date-time | null

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

toDate

date-time | null

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

orderStates

array of objects | null

Gets or sets the list of parent order states to filter deliveries by.

orderStates

orderLineStates

array of objects | null

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

orderLineStates

types

array of objects | null

Gets or sets the list of delivery types to filter by.

types

properties

array of objects | null

Gets or sets a list of delivery properties to filter by.

properties

tags

environment

string | null

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

applicationIP

string | null

Gets or sets the IP address of the calling application.

userToken

string | null

Gets or sets the user token for authentication context.

sessionId

string | null

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

userId

string

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

Gets or sets the numeric user identifier.

userIP

string | null

Gets or sets the IP address of the requesting user.

envelope

string | null

Gets or sets the envelope parameter for response shaping.

threadId

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

searchKey

string | null

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

pageIndex

string

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

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

pageSize

string

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

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

sorting

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:

content-type

string

enum

Defaults to application/json-patch+json

Generated from available request content types

Allowed:

Response

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

200A paginated list of deliveries.