AEB Carrier Event Service API
Track-and-trace event aggregation across carriers. Registers shipments, configures per-carrier tracking connections, and returns resolved status events by shipment or reference number, including proof-of-delivery / entry certification. Also exposes an inbound PushApi endpoint that carriers and tracking providers post raw event data into.
AEB Carrier Event Service API is one of 11 APIs that AEB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Track and Trace, Supply Chain Visibility, Event, Logistics, and Parcel. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and API documentation.
This API exposes 84 operations across 78 paths, organized into 12 resource areas, and defines 170 schemas. It is described by OpenAPI 3.0.1, at version 1.0.
Requests are made against a single base URL, https://xnsg.dc.aeb.com/demo1ces/rest.
84 operations
78 paths
170 schemas
3 DELETE31 GET49 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
AEB Carrier Event Service API declares
2 security schemes
for authenticating requests.
An API key is passed in the header as X-XNSG_WEB_TOKEN (SWAGGER_AUTH_KEY).
It accepts HTTP basic authentication (BASIC_AUTH).
By default, every request must be authenticated.
Paths & Operations 84
Across 78 paths, the API surfaces 84 operations — 3 DELETE, 31 GET, 49 POST, 1 PUT. They span 12 resource areas, including PushAPIRestEndpoint, CarrierEventServiceBFBean, CoreBFBean, FoundationAFBean, Logon, DataFeedBFBean, ExternalTelemetryBFBean, FoundationBFBean, and 4 more. Each is listed below with its method, path, parameters, and response codes.
PushAPIRestEndpoint 1
PushApi for carrier events.
POST
/PushApi/v1/push
Receives carrier event data.
CarrierEventServiceBFBean 11
Carrier event service related business facade methods. Supports methods for shipments, events and configuration.
POST
/CarrierEventServiceBFBean/createShipments
createShipments
POST
/CarrierEventServiceBFBean/deleteCarrierTrackingConfigurations
deleteCarrierTrackingConfigurations
POST
/CarrierEventServiceBFBean/getAllConverterInformation
getAllConverterInformation
POST
/CarrierEventServiceBFBean/getEventsForReferenceNumber
getEventsForReferenceNumber
POST
/CarrierEventServiceBFBean/getProvidedTrackingData
getProvidedTrackingData
POST
/CarrierEventServiceBFBean/getShipmentsEvents
getShipmentsEvents
POST
/CarrierEventServiceBFBean/getShipmentsEventsFiltered
getShipmentsEventsFiltered
POST
/CarrierEventServiceBFBean/getShipmentsWithEntryCertification
getShipmentsWithEntryCertification
POST
/CarrierEventServiceBFBean/setCarrierTrackingConfigurations
setCarrierTrackingConfigurations
POST
/CarrierEventServiceBFBean/synchronizeResolvedEvents
synchronizeResolvedEvents
POST
/CarrierEventServiceBFBean/testProviderConnection
testProviderConnection
CoreBFBean 12
API for the XNSGFoundation
POST
/CoreBFBean/checkBFFunctionExists
Can be called to know if a BF function exist.
POST
/CoreBFBean/echo
Returns the given echo parameter value.
POST
/CoreBFBean/echoUpperCase
Returns the given echo parameter value in uppercase.
GET
/CoreBFBean/getAllMonitoringValues
Returns all available monitoring values of the server.
GET
/CoreBFBean/getBuildForSolution
Return the build information of a solution that is deployed in the product on this server. The RFC name of this function is \"/AEB/XNSGIFBLDSOL\".
GET
/CoreBFBean/getMonitoringValue
Returns the current monitoring value for the given group and name.
GET
/CoreBFBean/getProductInfo
Return information about the server that is answering this request. This includes the product name and various version informations. The RFC name of this function is \"/AEB/XNSGIFPRINFO\".
GET
/CoreBFBean/getRuntimeInfo
Return runtime information about the server that is answering this request. This includes the server name, ports and various other runtime informations. The RFC name of this function is \"/AEB/XNSGIF…
POST
/CoreBFBean/getRuntimeState
Return runtime state information about the server that is answering this request. This includes if the server is doing fine or not. Also included are the supported operations (bfs) for the installati…
GET
/CoreBFBean/getThreadDump
Generate Thread-Dump.
GET
/CoreBFBean/getVersionForSolution
Return the version information of a solution that is deployed in the product on this server. The RFC name of this function is \"/AEB/XNSGIFVERSOL\".
POST
/CoreBFBean/restartRFCServer
This method is only usefull to be called from SAP via RFC. It will restart the RFCServer which receives this method call. This method is useful to be called from SAP, if within SAP some structure def…
FoundationAFBean 2
Business facade for the XNSGFoundation UI API
POST
/FoundationAFBean/releaseApplicationFacade
Release a UI API which is no longer needed. This call will save resources in the server, because the server must not wait for the timeout of the UI API session but can release it earlier. The method…
POST
/FoundationAFBean/workplace
Creates an UI API to be able to display the workplace. The difference of this method compared to the the method \"IFoundationBF.getWorkplaceURL()\" is the fact, that no logon mask will be dipsplayed…
Logon 2
Authentication handler for the XNSGFoundation
GET
/logon/authToken
Logon from the "Authorization" header (e.g. type "Basic"). The generated authentication token can be used in subsequent calls in the "Authorization" header, type "Bearer".
POST
/logon/user
Logon with classical procedure: user, client and password.
DataFeedBFBean 3
DataFeedBFBean
POST
/DataFeedBFBean/acknowledgePublishedDataFeedParts
Acknowledge the processed published data feed parts retrieved with getPublishedDataFeedParts containing the synchronization ID up to which all parts are acknowledged.
GET
/DataFeedBFBean/dataFeedParts/{client}/{id}
Retrieve the data feed part content.
POST
/DataFeedBFBean/getPublishedDataFeedParts
Poll data about the next 10 published data feed parts. This data contains an id, which can be used to download the content of a part. To download the content, use the endpoint /DataFeedBFBean/dataFee…
ExternalTelemetryBFBean 3
API for sending telemetry data from a third party system.
POST
/ExternalTelemetryBFBean/getStatus
Returns the current status of the telemetry system. The external system id must be sent with the request.
GET
/ExternalTelemetryBFBean/status
Returns the current status of the telemetry system. The external system id must be sent with the request.
POST
/ExternalTelemetryBFBean/telemetryReport
Submits telemetry data for a new telemetry report. The external system id must be sent with the request, a client IdentCode only if client dependent.
FoundationBFBean 31
REST endpoint for FoundationBF
POST
/FoundationBFBean/acknowledgeFile
Acknowledges a file download.
POST
/FoundationBFBean/announceStop
Announces a stop of the installation.
POST
/FoundationBFBean/cancelAnnounceStop
Revokes an already announced stop.
POST
/FoundationBFBean/changeAdminPassword
Changes the admin password.
GET
/FoundationBFBean/client
Requests all clients from this engine, or one client identified by values in query parameter
POST
/FoundationBFBean/client
Create a client.
POST
/FoundationBFBean/downloadFile
Retrieves a file for download.
POST
/FoundationBFBean/generateClientIdentCode
Generates a client ident code.
GET
/FoundationBFBean/client/active
Requests all active clients from this engine.
GET
/FoundationBFBean/monitoringValue
Requests all monitoring values from this engine.
GET
/FoundationBFBean/solution/{name}/build
Requests the build info for a solution from this engine.
POST
/FoundationBFBean/downloadableFileRefs
Retrieves refs for download.
GET
/FoundationBFBean/monitoringValue/{groupName}/{valueName}
Requests a specific monitoring value from this engine.
GET
/FoundationBFBean/numberOfClients
Returns the number of clients.
GET
/FoundationBFBean/productInfo
Requests the product info from this engine.
GET
/FoundationBFBean/runtimeInfo
Requests the runtime info from this engine.
POST
/FoundationBFBean/scriptExecutionState
gets a script execution state
POST
/FoundationBFBean/tableUpdateState
Retrieve the status of the table update.
POST
/FoundationBFBean/uploadSettings
Retrieves the upload settings.
GET
/FoundationBFBean/solution/{name}/version
Requests the version info for a solution from this engine.
GET
/FoundationBFBean/workplaceURL
Requests the workplace url from this engine.
GET
/FoundationBFBean/checkDebtorNumber
Checks if debtor number is known.
POST
/FoundationBFBean/publishUserMessage
creates a user message, in several languages if required
GET
/FoundationBFBean/roles
Requests the current engine to report all its roles
GET
/FoundationBFBean/roles/{clientIdentCode}
Requests the current engine to report all roles for a specific client
POST
/FoundationBFBean/restartRFCServer
This method is only usefull to be called from SAP via RFC. It will restart the RFCServer which receives this method call. This method is useful to be called from SAP, if within SAP some structure def…
POST
/FoundationBFBean/sendMail
Sends a mail.
POST
/FoundationBFBean/startScriptExecution
Starts a script execution
POST
/FoundationBFBean/startTableUpdate
Starts the table update.
POST
/FoundationBFBean/systemSearch/{language}
Performs a system search in this engine.
POST
/FoundationBFBean/uploadFileMultiPart
Uploads a file using multipart.
RemoteAdminBFBean 2
Remote Administration tools use this methods. The main player are the Identity Access Manager (IAM) and the Installation Repository (IR).
GET
/RemoteAdminBFBean/clientRoles/{clientId}
getRoles
GET
/RemoteAdminBFBean/roles
getRoles
SyncBFBean 6
API for synchronizing data asynchronous from an engine to a client system.
POST
/SyncBFBean/acknowledgeEvents
Acknowledge events got with {@link getNotAcknowledgedEvents(SyncEventsRequestDTO)}. Since XNSG 4.0, Nov. FP, 2017 .
POST
/SyncBFBean/getNotAcknowledgedEvents
Poll any not acknowledged events for the client system. This method does not require, that the client system fills {@link SyncEventsRequestDTOsyncId}. However, it requires, that a call to {@link ackn…
POST
/SyncBFBean/getPartnerSystemSubscriptions
Fetch a list of registered subscriptions (either all or filtered by the business object type). Only subscription belonging to the provided clientSystemId are returned (mandatory field) Since XNSG 4.0…
POST
/SyncBFBean/subscribePartnerSystem
Subscribe a partner system to be able to receive events for the specified business object type. The subscription is uniquely identified by the clientSystemId and businessObjectType (both mandatory fi…
POST
/SyncBFBean/synchronizeEvents
Poll the next events for the client system. This method requires the client system to persist the synchronisation state itself and passing a proper value for {@link SyncEventsRequestDTOsyncId} See {@…
POST
/SyncBFBean/unsubscribePartnerSystem
Unsubscribe a partner system from being able to receive events for the specified business object type. The subscription is uniquely identified by the clientSystemId and businessObjectType (both manda…
Companies 5
Rest API for companies
GET
/companies/{id}
Returns the company with the requested ID (company number). In some cases the ID (company number) is not unique . In this case an error is returned.
PUT
/companies/{id}
Create or update a company with the specified ID (company number). If the company with the given ID does not exist, a new company is created. If the company exist, the existing company is fully updat…
DELETE
/companies/{id}
Delete the company with the specified ID (company number). The ID is in some AEB services not unique , in this case a conflict (409) is returned.
GET
/companies
Returns all companies matching the given filter criteria. In case no company matches the given filter criteria an empty companies collection is returned. All filter fields are case insensitive. If th…
GET
/company-roles
Returns all company roles of this AEB service. Company roles are domain specific characteristics and can differ between the different AEB services.
WorkstationServiceAgent 6
Connection handler for the Workstation Service Agent
GET
/wssagent/connectdeprecated
Checks if workstation agent exists for given id, creates one if not exists and returns corresponding launch request. Returns response object.
DELETE
/wssagent/connectdeprecated
Ends existing workstation agent. Noop if there is no agent for the id.
GET
/wssagent/connection/{id}
Returns response object with information about given workstation service agent.
POST
/wssagent/connection/{id}
Checks if workstation agent exists for given id, creates one if not exists and returns corresponding launch request. Returns response object.
DELETE
/wssagent/connection/{id}
Ends existing workstation agent. Noop if there is no agent for the id.
GET
/wssagent/statusdeprecated
Returns response object with information about given workstation service agent.
Schemas 170
The contract defines 170 schemas that model the data the API accepts and returns. The most detailed are Company (24 properties), DesktopAgentInfo (16 properties), RuntimeInfoDTO (16 properties), ApplicationFacadeParmsDTO (16 properties). Each schema is shown below with its type and property counts.
PushApiRequestContentDTO
object
1 property
PushApiRequestDTO
object
DTO for sending data to the push api
1 property
CESShipmentReferenceDTO
object
Reference that identifies a shipment
4 properties
CreateShipmentsResponseDTO
object
DTO for create shipments response
5 properties
CreateShipmentsResponseItemDTO
object
Represents a response information for a certain shipment after a create request. Messages include warnings, infos or errors that occured when the shipment was…
4 properties
ResponseMessageDTO
object
Result messages like errors or warnings.
4 properties
TextInLanguageDTO
object
A translated text in one of the specified languages.
2 properties
CESAdditionalReferenceDTO
object
Represents an additional reference field within a shipment request.
2 properties
1 required
CESAddressDTO
object
Address data
5 properties
3 required
CESCarrierServiceDataDTO
object
DTO to identify the service of a carrier
2 properties
2 required
CESReferenceNumberDTO
object
Represents a given type and value of a referenceNumber. May also contain a reference to a tracking object, which can be used to tie this reference number to a…
2 properties
2 required
CESShipmentDTO
object
Represents a shipment
12 properties
7 required
CESTrackingObjectDTO
object
Represents a tracking object of a shipment. A tracking object might be either a package or a shipment.
4 properties
2 required
CreateShipmentsRequestDTO
object
DTO for createShipments requests
5 properties
1 required
DateAndZoneDTO
object
Date and timezone.
2 properties
CESCarrierTrackingConfigurationReferenceDTO
object
DTO to reference a CarrierTrackingConfiguration
1 property
DeleteCarrierTrackingConfigurationResponseItemDTO
object
Item Response DTO for deleting carrier configuration
4 properties
DeleteCarrierTrackingConfigurationsResponseDTO
object
DTO with the response for deleting CarrierTrackingConfigurations For each CarrierTrackingConfiguration that was requested to be deleted a single response is pr…
5 properties
DeleteCarrierTrackingConfigurationsRequestDTO
object
DTO class for the number of carrier configurations that should be deleted in CES
5 properties
CESConverterDescriptionTranslationDTO
object
Text Translataion DTO for the description of converters
2 properties
1 required
CESConverterInformationDTO
object
DTO that identifies a converter
7 properties
GetAllConverterInformationResponseDTO
object
Response dto to get every converter in the system
5 properties
GetAllConverterInformationRequestDTO
object
Request dto to get every converter in the system
4 properties
CESAddressResponseDTO
object
Address data to be provided in responses. @see CESAddressDTO
5 properties
CESEventTextDTO
object
DTO for event text explaining the event ident codes, originalCodes and originalReason
2 properties
CESGeoCoordinatesResponseDTO
object
Location data represented by geographic coordinates formatted as decimal degrees.
2 properties
CESLocationIdentifierResponseDTO
object
Location data represented by an identifier
2 properties
CESTrackingEventAdditionalDataDTO
object
DTO with additional information provided for the carrier for the event
2 properties
CESTrackingEventLocationResponseDTO
object
DTO with location data for a tracking event. Fields and substructures only filled as provided.
4 properties
CESTrackingEventResponseDTO
object
DTO for the real event data.
7 properties
CEStandardEventTextDTO
object
DTO to provide the name and description in multiple languages
3 properties
GetEventsForReferenceNumberResponseDTO
object
Response DTO to get events for a reference number
5 properties
CESCarrierReferenceDTO
object
DTO that encapsulates data to identify a carrier.
1 property
1 required
GetEventsForReferenceNumberRequestDTO
object
Request DTO to get events for a reference number
8 properties
2 required
CESProvidedTrackingDataMetaDataDTO
object
Meta data of a CESProvidedTrackingData
8 properties
CESProvidedTrackingDataResponseDTO
object
DTO for a CESProvidedTrackingData
4 properties
GetProvidedTrackingDataResponseDTO
object
Response DTO for a request for CESProvidedTrackingData.
5 properties
GetProvidedTrackingDataRequestDTO
object
Request DTO to request CESProvidedTrackingData
6 properties
2 required
CESShipmentEventResponseDTO
object
DTO for the shipment containing tracking objects with its events.
6 properties
CESTrackingObjectResponseDTO
object
DTO for tracking object with its tracking events.
6 properties
GetShipmentsEventsResponseDTO
object
Response DTO for a request for shipment events.
5 properties
GetShipmentsEventsRequestDTO
object
Request DTO to request events for shipment references.
7 properties
GetShipmentsEventsFilteredResponseDTO
object
The response for getShipmentEventsFiltered method
5 properties
GetShipmentsEventsFilteredRequestDTO
object
Request DTO for getSchipmetsEventsFiltered method
8 properties
1 required
ShipmentsEventsFilterDTO
object
DTO to set a filter for shipment events query
1 property
CESShipmentWithEntryCertificationDTO
object
Represents a shipment with shipment number and entry certification date.
2 properties
GetShipmentsWithEntryCertificationResponseDTO
object
Response DTO for a request for getShipmentsWithEntryCertification.
7 properties
GetShipmentsWithEntryCertificationRequestDTO
object
Request DTO for a request for getShipmentsWithEntryCertificationRequest.
5 properties
SetCarrierTrackingConfigurationResponseDTO
object
Main Response DTO for setting carrier configuration
5 properties
SetCarrierTrackingConfigurationResponseItemDTO
object
Item Response DTO for setting carrier configuration
4 properties
CESCarrierTrackingConfigurationDTO
object
DTO class that encapsulates all configuration data to create one process chain for a given carrier, data provider, converter and recoding.
8 properties
SetCarrierTrackingConfigurationRequestDTO
object
Request for creating/updating CESCarrierTrackingConfiguration and derived data. It is possible to transmit more than one configuration.
5 properties
CESSynchronizeResolvedEventDTO
object
DTO for the resolved event with context information to enable assignment of the event to a certain business object.
9 properties
2 required
SynchronizeResolvedEventsResponseDTO
object
DTO with result to synchronize resolved events
7 properties
SynchronizeResolvedEventsRequestDTO
object
DTO with parms to synchronize resolved events
9 properties
TestProviderConnectionResponseDTO
object
response DTO which is submitted as a response after a connection test
4 properties
ConnectionTestParametersDTO
object
Container class for all connection test parameter types. Only one field may be filled at the same time.
2 properties
FTPConnectionTestParametersDTO
object
contains parameters for a connection test of a FTP tracking configuration
1 property
SFTPConnectionTestParametersDTO
object
contains parameters for a connection test of a SFTP tracking configuration
1 property
TestProviderConnectionRequestDTO
object
Request DTO that is submitted when requesting a connection test
7 properties
BFFunctionExistsDTO
object
Result DTO for the checkBusinessFacadeFunctionExists function
2 properties
BFFunctionDTO
object
Describe a API to be called.
2 properties
MonitoringDataProviderDTO
object
Data Transfer Object for monitoring provider
3 properties
ProductInfoDTO
object
This class holds various information items of the server which serves this request.
4 properties
VersionInfoDTO
object
This class holds version information about a solution or product in a server.
2 properties
RuntimeInfoDTO
object
This class holds various runtime information items of the server which serves this request.
16 properties
RuntimeStateResultDTO
object
This class holds various information items of the server which serves this request.
5 properties
RuntimeStateParmDTO
object
This class contains parameter about asking the server about its runtime state.
AFExecuteProcessParmsDTO
object
Parameters of UI API invocation when this is to be done via create process: The client has to invoke the process as specified by the properties of this object.
3 properties
AFShellExecuteParmsDTO
object
Parameters of application UI API when this is to be done via shellexecute: The client has to create a file with the given name in a temporary directory, the co…
2 properties
ApplicationFacadeDTO
object
A data transfer object which describes an UI API. There are various techniques possible how to "open" the "application" on the client; typically only one of th…
5 properties
ApplicationFacadeParmsDTO
object
A data transfer object to be the parameter of the method IFoundationBF.getNewApplicationFacade()
16 properties
LogonResponse
object
5 properties
LogonArgument
object
4 properties
AcknowledgePublishedDataFeedPartsResponseDTO
object
Response (result) for IDataFeedBFacknowledgePublishedDataFeedParts(AcknowledgePublishedDataFeedPartsRequestDTO.
4 properties
AcknowledgePublishedDataFeedPartsRequestDTO
object
Request parameter for Response (result) for IDataFeedBFacknowledgePublishedDataFeedParts(AcknowledgePublishedDataFeedPartsRequestDTO.
5 properties
GetPublishedDataFeedPartsResponseDTO
object
Response (result) for IDataFeedBFgetPublishedDataFeedParts(GetPublishedDataFeedPartsRequestDTO).
7 properties
PublishedDataFeedPartDTO
object
DTO to hold the data of a published data feed part.
9 properties
GetPublishedDataFeedPartsRequestDTO
object
Request parameter for IDataFeedBFgetPublishedDataFeedParts(GetPublishedDataFeedPartsRequestDTO).
4 properties
ExternalTMStatusResponseDTO
object
Response DTO for ExternalTelemetryBFBean/getStatus & ExternalTelemetryBFBean/status.
8 properties
ExternalTMIdentificationRequestDTO
object
Request DTO for registering, unregistering third party telemetry reporters, also to be used for obtaining informations on reporting status.
6 properties
ExternalTMResponseDTO
object
Response DTO for all calls to ExternalTelemetryBFBean.
10 properties
ExternalTMRDateEntryDTO
object
telemetry report entry for date values
3 properties
ExternalTMRDoubleEntryDTO
object
telemetry report entry for string double
3 properties
ExternalTMRIntegerEntryDTO
object
telemetry report entry for integer values
3 properties
ExternalTMRLongEntryDTO
object
telemetry report entry for long values
3 properties
ExternalTMRStringArrayEntryDTO
object
telemetry report entry for string array values
3 properties
ExternalTMRStringEntryDTO
object
telemetry report entry for string values
3 properties
ExternalTMReportRequestDTO
object
Request DTO for registering, unregistering third party telemetry reporters, also to be used for obtaining informations on reporting status.
8 properties
ExternalTelemetryReportDTO
object
report dto to ship the telemetry data to an XNSG engine
6 properties
AcknowledgeFileResponseDTO
object
Contains the result for an acknowledge file request.
2 properties
AcknowledgeFileRequestDTO
object
Contains information about the result of a file transfer
3 properties
SimpleFileDTO
object
Meta-data for a transfer file
2 properties
AnnounceStopResultDTO
object
the result of the announce stop API
AnnounceStopParmDTO
object
parameter necessary to announce a stop of the server
3 properties
CancelAnnounceStopResultDTO
object
Contains the result information of the cancel announce stop bf
CancelAnnounceStopParmDTO
object
parameter necessary to cancel an announced stop
ChangeAdminPasswordResultDTO
object
Contains the result information of the change admin password bf
1 property
ChangeAdminPasswordParmDTO
object
This class contains the old and the new admin password
2 properties
CreateClientResponseDTO
object
encapsulates the response parameters
1 property
CreateClientRequestDTO
object
encapsulates the request parameters
3 properties
ActivationDataFlavor
object
2 properties
CommandInfo
object
2 properties
CommandMap
object
1 property
DataHandler
object
The content of a file
10 properties
DataSource
object
4 properties
DownloadFileResponseDTO
object
Contains the result for a download file request
3 properties
FileDTO
object
Data Transfer Object for a file.
7 properties
DownloadFileRequestDTO
object
Contains information on how to select a file for transferring
4 properties
TransferFileParameterDTO
object
A generic parameter for use-case specific information
2 properties
GenerateClientIdentCodeRequestDTO
object
encapsulates the request parameters
2 properties
ClientDTO
object
DTO representing an XNSG Client.
6 properties
DLFilesRefsResponseDTO
object
Contains the result for a request to get the number of files available for download
3 properties
DLFilesRefsRequestDTO
object
Contains information on how to select files for transferring
3 properties
ScriptExecutionRowDTO
object
This dto contains the data of a single line in script result
2 properties
ScriptExecutionStateResultDTO
object
Contains the result information of the script execution bf
4 properties
ScriptExecutionStateParmDTO
object
parameters necessary to ask the server for the current state of the script execution
1 property
TableUpdateStateResultDTO
object
Contains the result information of the get table update state bf
5 properties
TableUpdateStateParmDTO
object
the parameter necessary to ask the server for the current state of the table update
UploadSettingsResponseDTO
object
retrieves the server settings for uploading files via SFT interface
3 properties
UploadSettingsRequestDTO
object
retrieves the server settings for uploading files via SFT interface
2 properties
MessageDataDTO
object
resulting user tip for one locale
3 properties
PublishMessageResponseDTO
object
Contains ids of user tips that were created, or error messages
1 property
LinkDTO
object
links associated with the tip
3 properties
MessageTextsDTO
object
locale specific data of the user tip. key is the language iso code.This language must be defined, or tip is not created.
7 properties
PublishMessageRequestDTO
object
the for user tip, possibly in several locales
14 properties
RoleInfoDTO
object
dto for roles
9 properties
SendMailResultDTO
object
Contains the result of the sendMail method.
2 properties
SendMailAttachmentParmDTO
object
Contains an attachment for an email.
3 properties
SendMailParmDTO
object
Parameter necessary for sending a mail
9 properties
StartScriptExecutionResultDTO
object
result of start script execution
3 properties
StartScriptExecutionParmDTO
object
parameters for start script execution
4 properties
StartTableUpdateResultDTO
object
Contains the result information of the start table update bf
StartTableUpdateParmDTO
object
parameter necessary for the table update
SystemSearchResultDTO
object
DTO contained in the result array of systemSearch function
7 properties
SystemSearchParameterDTO
object
DTO used as argument to systemSearch function
3 properties
UploadFileResponseDTO
object
Contains the result for a upload file request.
2 properties
UploadFileMultiPartRequestDTO
object
Contains information on how a transmitted file should be processed
9 properties
RoleDTO
object
data about a role
6 properties
RoleTextDTO
object
language dependent values of a role
2 properties
RolesOfClientDTO
object
Response DTO for listing roles assignable to users of a client.
2 properties
ClientRolesDTO
object
Response DTO for listing client specific roles in GetRolesResponseDTO.
2 properties
GetRolesResponseDTO
object
DTO for GetRoles response
6 properties
AcknowledgeEventsResponseDTO
object
Response DTO for acknowledging events.
4 properties
AcknowledgeEventsRequestDTO
object
Request DTO for acknowledging events.
6 properties
GenericDataFieldDTO
object
A field of a generic data record.
3 properties
GenericDataRecordDTO
object
A generic record of data. Each field is qualified by name and type and has a value.
2 properties
NamedGenericDataRecordDTO
object
A generic data record with a name. Wrapper class to encapsulate subrecords with their name and with the ability to have explicit null records.
2 properties
SyncEventDTO
object
DTO to hold data of one synchronized event.
7 properties
SyncEventsResponseDTO
object
Response DTO for synchronizing events.
8 properties
SyncEventsRequestDTO
object
Request DTO for synchronizing events.
9 properties
GetPartnerSystemSubscriptionsResponseDTO
object
Response parameter with fetched partner system subscriptions to sync events.
5 properties
SyncPartnerSystemDTO
object
Identification and other data of a single partner system subscription.
3 properties
2 required
GetPartnerSystemSubscriptionsRequestDTO
object
Request parameter to fetch all or filtered partner system subscriptions to sync events.
5 properties
SubscribePartnerSystemResponseDTO
object
Response parameter of a partner system subscription to sync events.
5 properties
SubscribePartnerSystemRequestDTO
object
Request parameter to subscribe a partner system to sync events.
6 properties
1 required
UnsubscribePartnerSystemResponseDTO
object
Response parameter of a partner system unsubscription from sync events.
5 properties
UnsubscribePartnerSystemRequestDTO
object
Request parameter to unsubscribe a partner system from sync events.
5 properties
1 required
Company
object
A complete address of a company.
24 properties
3 required
CompanyRole
object
A role of a company. Company roles are domain specific characteristics and can differ between the different AEB services.
2 properties
1 required
CompanyPage
object
2 properties
2 required
CompanyRoleList
object
1 property
1 required
DesktopAgentInfo
object
16 properties
LauncherInfo
object
2 properties
PerfMonitoringInfo
object
3 properties
ProcessInfo
object
6 properties
SessionInfo
object
1 property
TracingInfo
object
6 properties
WorkstationSessionInfoDTO
object
3 properties
WorkstationAgentConnectionTimeouts
object
4 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from AEB 10
Other APIs AEB publishes across the network.
AEB Customs Management API
AEB Customs Inventory Management API
AEB Customs Broker Portal API
AEB Product Classification API
AEB Trade Compliance Management API
AEB Carrier Connect API
AEB Carrier Select API
AEB Logistics Cost Management API
AEB Document Service API
AEB BSM API
#Track and Trace#Supply Chain Visibility#Event#Logistics#Parcel
Where this information came from
This is an independent, third-party profile of AEB Carrier Event Service API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.