getConsignments

post

https://rz3.aeb.de/demo1ma/rest/LISBF20Bean/getConsignments

Returns a list of consignments for the given requestDTO

Body Params

identificationDTO

object

DTO suppliying the identification information for making requests.

dateFrom

date

required

Date filter for the search, only consignments from this date on will be included in the search result.

format: yyyy-MM-dd, length=10

dateTo

date

required

Date filter for the search, only consignments up to this date will be included in the search result. If the field is empty, the actual date is assumed.

format: yyyy-MM-dd, length=10

dateField

string

enum

required

The date field of the consignment, the date filter will be applied to.

Allowed:

sortField

string

enum

The field used to sort the result consignment list. "CONSIGNMENT_NUMBER" is the default, when no value is specified.

Allowed:

sortDirection

string

enum

The direction the consignments are sorted by their sortField.

Allowed:

problemLevelFilter

array of strings

enum

Problem level filter. When left empty, all found consignments will be returned, otherwise only the consignments with the specified problem levels will be returned.

problemLevelFilter

consigneeNameFilter

string

Consignee filter. When filled, only consignments with the specified consignee name will be returned.

forwarderDeliveryNameFilter

string

Forwarder filter. When filled, only consignments with the specified name for the delivering forwarder will be returned.

maxNumberOfCons

int32

Specifies the maximal number of consignments the result list can include. Should prevent, that the result list will bee too large. Therefore a default of 50 will be assumed, when no value is specified. An error will be returned if the given number is greater than 50.

Response

Language

Credentials

Basic

base64

Response

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

application/json

defaultdefault response