AEB Carrier Event Service BF Bean API is one of 67 APIs that AEB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include CarrierEventServiceBFBean. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, a changelog, and a GitHub repository.
This API exposes
11 operations
across 11 paths,
and defines 58 schemas.
It is described by OpenAPI 3.2.0, at version 1.0.
Requests are made against a single base URL, https://xnsg.dc.aeb.com/demo1ces/rest.
The identity and technical contract details declared by the specification.
GetShipmentsEventsResponseDTO
object
Response DTO for a request for shipment events.
5 properties
GetProvidedTrackingDataResponseDTO
object
Response DTO for a request for CESProvidedTrackingData.
5 properties
GetAllConverterInformationRequestDTO
object
Request dto to get every converter in the system
4 properties
CESCarrierServiceDataDTO
object
DTO to identify the service of a carrier
2 properties
2 required
CESShipmentDTO
object
Represents a shipment
12 properties
7 required
CreateShipmentsResponseDTO
object
DTO for create shipments response
5 properties
SynchronizeResolvedEventsRequestDTO
object
DTO with parms to synchronize resolved events
9 properties
CESProvidedTrackingDataMetaDataDTO
object
Meta data of a CESProvidedTrackingData
8 properties
TestProviderConnectionRequestDTO
object
Request DTO that is submitted when requesting a connection test
7 properties
CESCarrierTrackingConfigurationReferenceDTO
object
DTO to reference a CarrierTrackingConfiguration
1 property
CESLocationIdentifierResponseDTO
object
Location data represented by an identifier
2 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
ConnectionTestParametersDTO
object
Container class for all connection test parameter types. Only one field may be filled at the same time.
2 properties
CESAdditionalReferenceDTO
object
Represents an additional reference field within a shipment request.
2 properties
1 required
CreateShipmentsRequestDTO
object
DTO for createShipments requests
5 properties
1 required
CESTrackingEventLocationResponseDTO
object
DTO with location data for a tracking event. Fields and substructures only filled as provided.
4 properties
CEStandardEventTextDTO
object
DTO to provide the name and description in multiple languages
3 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
GetProvidedTrackingDataRequestDTO
object
Request DTO to request CESProvidedTrackingData
6 properties
2 required
DeleteCarrierTrackingConfigurationsRequestDTO
object
DTO class for the number of carrier configurations that should be deleted in CES
5 properties
CESEventTextDTO
object
DTO for event text explaining the event ident codes, originalCodes and originalReason
2 properties
GetShipmentsWithEntryCertificationResponseDTO
object
Response DTO for a request for getShipmentsWithEntryCertification.
7 properties
CESTrackingEventResponseDTO
object
DTO for the real event data.
7 properties
GetShipmentsEventsFilteredRequestDTO
object
Request DTO for getSchipmetsEventsFiltered method
8 properties
1 required
GetShipmentsEventsRequestDTO
object
Request DTO to request events for shipment references.
7 properties
SFTPConnectionTestParametersDTO
object
contains parameters for a connection test of a SFTP tracking configuration
1 property
CESAddressDTO
object
Address data
5 properties
3 required
CESProvidedTrackingDataResponseDTO
object
DTO for a CESProvidedTrackingData
4 properties
DeleteCarrierTrackingConfigurationResponseItemDTO
object
Item Response DTO for deleting carrier configuration
4 properties
CESTrackingObjectDTO
object
Represents a tracking object of a shipment. A tracking object might be either a package or a shipment.
4 properties
2 required
SynchronizeResolvedEventsResponseDTO
object
DTO with result to synchronize resolved events
7 properties
CESShipmentWithEntryCertificationDTO
object
Represents a shipment with shipment number and entry certification date.
2 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
GetShipmentsEventsFilteredResponseDTO
object
The response for getShipmentEventsFiltered method
5 properties
CESTrackingEventAdditionalDataDTO
object
DTO with additional information provided for the carrier for the event
2 properties
SetCarrierTrackingConfigurationRequestDTO
object
Request for creating/updating CESCarrierTrackingConfiguration and derived data. It is possible to transmit more than one configuration.
5 properties
CESShipmentEventResponseDTO
object
DTO for the shipment containing tracking objects with its events.
6 properties
CESCarrierReferenceDTO
object
DTO that encapsulates data to identify a carrier.
1 property
1 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
GetEventsForReferenceNumberResponseDTO
object
Response DTO to get events for a reference number
5 properties
SetCarrierTrackingConfigurationResponseDTO
object
Main Response DTO for setting carrier configuration
5 properties
CESTrackingObjectResponseDTO
object
DTO for tracking object with its tracking events.
6 properties
CESConverterDescriptionTranslationDTO
object
Text Translataion DTO for the description of converters
2 properties
1 required
GetEventsForReferenceNumberRequestDTO
object
Request DTO to get events for a reference number
8 properties
2 required
CESAddressResponseDTO
object
Address data to be provided in responses. @see CESAddressDTO
5 properties
CESConverterInformationDTO
object
DTO that identifies a converter
7 properties
ShipmentsEventsFilterDTO
object
DTO to set a filter for shipment events query
1 property
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
SetCarrierTrackingConfigurationResponseItemDTO
object
Item Response DTO for setting carrier configuration
4 properties
CESGeoCoordinatesResponseDTO
object
Location data represented by geographic coordinates formatted as decimal degrees.
2 properties
DateAndZoneDTO
object
Date and timezone.
2 properties
FTPConnectionTestParametersDTO
object
contains parameters for a connection test of a FTP tracking configuration
1 property
TestProviderConnectionResponseDTO
object
response DTO which is submitted as a response after a connection test
4 properties
CESShipmentReferenceDTO
object
Reference that identifies a shipment
4 properties
TextInLanguageDTO
object
A translated text in one of the specified languages.
2 properties
GetShipmentsWithEntryCertificationRequestDTO
object
Request DTO for a request for getShipmentsWithEntryCertificationRequest.
5 properties
ResponseMessageDTO
object
Result messages like errors or warnings.
4 properties
GetAllConverterInformationResponseDTO
object
Response dto to get every converter in the system
5 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs AEB publishes across the network.
