getShipmentsEvents

post

https://xnsg.dc.aeb.com/demo1ces/rest/CarrierEventServiceBFBean/getShipmentsEvents

Returns the resolved events of the given shipments sorted by CESTrackingEventResponseDTO's eventDate in ascending order, taking the time zone into account.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request DTO to request events for shipment references.

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

References representing shipments. An event list should be returned for each reference provided.

shipmentReferences

isStandardEventTextIncluded

boolean

Defaults to false

Controls, if the name and description that explain the identCode of the event is included in the response. If this option is set to true, there will be a name and a description for each requested language

isOriginalDescriptionIncluded

boolean

Defaults to false

Controls, if the description of the carriers codelist that explain the originalIdentCode and originalReasonn of the event is included in the response. If this option is set to true, there will be a name and a description for each requested language if available

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json

Generated from available request 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