getShipments

post

https://rz3.aeb.de/demo1cai/rest/DLCarrierBFBean/getShipments

Returns detail information about specific shipments.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

clientSystemId

string

Id of the sending client system.

e.g. Installation ID of the sending host or ERP system.

Maximum length: 20

clientIdentCode

string

Client identification code.

Maximum length: 10

userName

string

User who initiated the request from the client system.

If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.

If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.

Actual authentication is handled separately via the request's headers, so no password is required in the request's data.

resultLanguageIsoCodes

array of strings

2-letter ISO codes of the languages in which texts will be returned.

English ('en') and German ('de') are typically supported by default. Other languages may be supported.

Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.

resultLanguageIsoCodes

shipmentReferences

array of objects

The list of shipment references for which detail information is requested. Cannot be used with the filter at the same time.

shipmentReferences

includeDocuments

boolean

Controls, if the (label) documents should be included in the response of each shipment. Default is 'false'.

withCanceledShipments

boolean

Controls, if canceled shipments should also be returned. Default is 'true'.

filter

object

Controls, which shipments should be returned. Cannot be used with shipment references at the same time.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Response

Language

Credentials

Basic

base64

Loading…

Response

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

application/json

defaultdefault response