API Reference
  1. Lidia Delivery
  2. Query > Deliveries > DeliveryProperties

GetDeliveryProperties

post
https://{yourlidiaurl}/delivery/query/delivery/properties

Fetches detailed metadata, route coordinates, and current tracking state of the target delivery properties.

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

The query request filtering constraints.

Query parameter filters defining constraints to search or list delivery query.

string | null

Gets or sets the channel code configuration value.

types
array of objects | null

Gets or sets the types configuration value.

types
states
array of objects | null

Gets or sets the states configuration value.

states
Allowed:
deliveryCodes
array of strings | null

Gets or sets the delivery codes configuration value.

deliveryCodes
includeDeliveryCodes
array of strings | null

Gets or sets the include delivery codes configuration value.

includeDeliveryCodes
excludeDeliveryCodes
array of strings | null

Gets or sets the exclude delivery codes configuration value.

excludeDeliveryCodes
deliveryIds
array | null

Gets or sets the delivery ids configuration value.

deliveryIds
includeDeliveryIds
array of strings | null

Gets or sets the include delivery ids configuration value.

includeDeliveryIds
exludeDeliveryIds
array of strings | null

Gets or sets the exlude delivery ids configuration value.

exludeDeliveryIds
orderIds
array of strings | null

Gets or sets the order ids configuration value.

orderIds
includeOrderIds
array of strings | null

Gets or sets the include order ids configuration value.

includeOrderIds
excludeOrderIds
array of strings | null

Gets or sets the exclude order ids configuration value.

excludeOrderIds
channelDeliveryIds
array of strings | null

Gets or sets the channel delivery ids configuration value.

channelDeliveryIds
channelIds
array | null

Gets or sets the channel ids configuration value.

channelIds
channelNames
array of strings | null

Gets or sets the channel names configuration value.

channelNames
includeChannelNames
array of strings | null

Gets or sets the include channel names configuration value.

includeChannelNames
excludeChannelNames
array of strings | null

Gets or sets the exclude channel names configuration value.

excludeChannelNames
districts
array of strings | null

Gets or sets the districts configuration value.

districts
includeDistricts
array of strings | null

Gets or sets the include districts configuration value.

includeDistricts
excludeDistricts
array of strings | null

Gets or sets the exclude districts configuration value.

excludeDistricts
cities
array of strings | null

Gets or sets the cities configuration value.

cities
includeCities
array of strings | null

Gets or sets the include cities configuration value.

includeCities
excludeCities
array of strings | null

Gets or sets the exclude cities configuration value.

excludeCities
recipientFirstNames
array of strings | null

Gets or sets the recipient first names configuration value.

recipientFirstNames
includeRecipientFirstNames
array of strings | null

Gets or sets the include recipient first names configuration value.

includeRecipientFirstNames
excludeRecipientFirstNames
array of strings | null

Gets or sets the exclude recipient first names configuration value.

excludeRecipientFirstNames
recipientLastNames
array of strings | null

Gets or sets the recipient last names configuration value.

recipientLastNames
includeRecipientLastNames
array of strings | null

Gets or sets the include recipient last names configuration value.

includeRecipientLastNames
excludeRecipientLastNames
array of strings | null

Gets or sets the exclude recipient last names configuration value.

excludeRecipientLastNames
recipientFullNames
array of strings | null

Gets or sets the recipient full names configuration value.

recipientFullNames
includeRecipientFullNames
array of strings | null

Gets or sets the include recipient full names configuration value.

includeRecipientFullNames
excludeRecipientFullNames
array of strings | null

Gets or sets the exclude recipient full names configuration value.

excludeRecipientFullNames
streetAddresses
array of strings | null

Gets or sets the street addresses configuration value.

streetAddresses
includeStreetAddresses
array of strings | null

Gets or sets the include street addresses configuration value.

includeStreetAddresses
excludeStreetAddresses
array of strings | null

Gets or sets the exclude street addresses configuration value.

excludeStreetAddresses
senderEmails
array of strings | null

Gets or sets the sender emails configuration value.

senderEmails
receiverEmails
array of strings | null

Gets or sets the receiver emails configuration value.

receiverEmails
propertyKeys
array of strings | null

Gets or sets the property keys configuration value.

propertyKeys
date-time | null

Gets or sets the from date configuration value.

date-time | null

Gets or sets the to date configuration value.

date-time | null

Gets or sets the from update date configuration value.

date-time | null

Gets or sets the to update date configuration value.

boolean | null

Gets or sets the include channel data configuration value.

string | null

Gets or sets the application ip configuration value.

string | null

Gets or sets the user token configuration value.

string | null

The unique database identifier linking this record to the target session.

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

The unique database identifier linking this record to the target user.

string | null

Gets or sets the user ip configuration value.

string | null

Gets or sets the envelope configuration value.

string | null

A correlation token used to track logs across async thread transitions.

includes
array of strings | null

Gets or sets the includes configuration value.

includes
string | null

Gets or sets the search key configuration value.

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

Gets or sets the page index configuration value.

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

Gets or sets the page size configuration value.

string | null

Gets or sets the sorting configuration value.

string | null

Gets or sets the prefix configuration value.

status
array of objects | null

The current lifecycle state of the delivery task or courier agent.

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 16 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 16 days ago

Did this page help you?