AEB Carrier Connect API
Multi-carrier shipping API covering 300+ carriers and parcel services. Creates shipments, packages and items, produces labels and shipping documents, builds and manifests pickups (AEB sends the carrier EDI on the customer's behalf), and manages carrier definitions, terms of delivery and shipment objectives across parcel, pallet, FCL/LCL, road, rail, ocean and air.
AEB Carrier Connect API is one of 11 APIs that AEB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Multi-Carrier Shipping, Parcel, Shipping, Labels, and Freight. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, pricing, and a GitHub repository.
This API exposes 119 operations across 99 paths, organized into 15 resource areas, and defines 274 schemas. It is described by OpenAPI 3.0.1, at version 3.0.
Requests are made against a single base URL, https://rz3.aeb.de/demo1cai/rest.
119 operations
99 paths
274 schemas
8 DELETE47 GET54 POST10 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
AEB Carrier Connect 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 119
Across 99 paths, the API surfaces 119 operations — 8 DELETE, 47 GET, 54 POST, 10 PUT. They span 15 resource areas, including CarrierDefinition, CarrierDescription, CarrierSetup, TermsOfDelivery, ShipmentObjectives, Shipping, FoundationAFBean, Logon, and 7 more. Each is listed below with its method, path, parameters, and response codes.
CarrierDefinition 8
Rest API for carrier definitions
GET
/carrier-definitions/{id}
Returns a carrier definition with the requested ID. If the ID does not exist, an error will be returned
GET
/carrier-definitions
Returns all carrier definitions matching the given filter criteria. In case no carrier definition matches the given filter criteria an empty carrier definition collection is returned. All filter fiel…
GET
/carrier-definitions/{id}/additional-values
Returns a list of all the additional values of a carrier definition with the requested ID. If the ID does not exist, an error will be returned
GET
/carrier-definitions/{id}/carrier-info-texts
Returns a list of all the carrier info texts of a carrier definition with the requested ID.
GET
/carrier-definitions/{id}/despatch-countries
Returns a list of all the despatch countries of a carrier definition with the requested ID. If the ID does not exist, an error will be returned
GET
/carrier-definitions/{id}/logos
Returns the logos of a carrier with the requested ID. If the ID does not exist, an error will be returned
GET
/carrier-definitions/{id}/services
Returns a list of all the services of a carrier definition with the requested ID. If the ID does not exist, an error will be returned
GET
/carrier-definitions/{id}/value-added-services
Returns a list of all the value added services of a carrier definition with the requested ID. If the ID does not exist, an error will be returned
CarrierDescription 1
Rest API for carrier descriptions
GET
/carrier-descriptions
Returns all carrier descriptions.
CarrierSetup 26
Rest API for carrier setups
GET
/carrier-setups/{id}
Returns a carrier setup with the requested ID.
PUT
/carrier-setups/{id}
Create or update a carrier setup with the requested ID. If the carrier setup with the given ID does not exist, a new carrier setup will be created. If the carrier setup exists, the existing carrier s…
DELETE
/carrier-setups/{id}
Delete a carrier setup with the requested ID.
GET
/carrier-setups
Returns all carrier setups matching the given filter criteria. In case no carrier setup matches the given filter criteria an empty collection is returned. If the filter field supports place holders (…
GET
/carrier-setups/{id}/additional-values/{additional-value-id}
Returns an additional value setup of a carrier setup with the requested ID.
PUT
/carrier-setups/{id}/additional-values/{additional-value-id}
Create or update an additional value setup of a carrier setup with the requested ID. If the additional value setup with the given ID does not exist, a new additional value setup will be created. If t…
DELETE
/carrier-setups/{id}/additional-values/{additional-value-id}
Deletes an additional value setup of a carrier setup with the requested ID.
GET
/carrier-setups/{id}/additional-values
Returns all additional value setups of a carrier setup.
PUT
/carrier-setups/{id}/additional-values
Create or update all additional value setups of a carrier setup with the requested ID. If the additional value setup with the given ID does not exist, a new additional value setup will be created. If…
GET
/carrier-setups/{id}/application-url
Returns the application URL of a carrier setup with the requested ID.
GET
/carrier-setups/{id}/carrier-info-texts
Returns all carrier info text setups of a carrier setup.
PUT
/carrier-setups/{id}/carrier-info-texts
Create or update all carrier info text setups of a carrier setup with the requested ID. If the carrier info text setup with the given ID does not exist, a new carrier info text setup will be created.…
GET
/carrier-setups/{id}/carrier-info-texts/{carrier-info-text-id}
Returns a carrier info text setup of a carrier setup with the requested ID.
PUT
/carrier-setups/{id}/carrier-info-texts/{carrier-info-text-id}
Create or update a carrier info text setup of a carrier setup with the requested ID. If the carrier info text setup with the given ID does not exist, a new carrier info text setup will be created. If…
DELETE
/carrier-setups/{id}/carrier-info-texts/{carrier-info-text-id}
Deletes a carrier info text setup of a carrier setup with the requested ID.
GET
/carrier-setups/{id}/services
Returns all service setups of a carrier setup.
PUT
/carrier-setups/{id}/services
Create or update all service setups of a carrier setup with the requested ID. If the service setup with the given ID does not exist, a new service setup will be created. If the service setup exist, t…
GET
/carrier-setups/{id}/services/{service-id}
Returns a service setup of a carrier setup with the requested ID.
PUT
/carrier-setups/{id}/services/{service-id}
Create or update a service setup of a carrier setup with the requested ID. If the service setup with the given ID does not exist, a new service setup will be created. If the service setup exist, the…
DELETE
/carrier-setups/{id}/services/{service-id}
Deletes a service setup of a carrier setup with the requested ID.
GET
/carrier-setups/{id}/status
Returns the status of a carrier setup with the requested ID.
GET
/carrier-setups/{id}/value-added-services
Returns all value added service setups of a carrier setup.
PUT
/carrier-setups/{id}/value-added-services
Create or update all value added service setups of a carrier setup with the requested ID. If the value added service setup with the given ID does not exist, a new value added service setup will be cr…
GET
/carrier-setups/{id}/value-added-services/{value-added-service-id}
Returns a value added service setup of a carrier setup with the requested ID.
PUT
/carrier-setups/{id}/value-added-services/{value-added-service-id}
Create or update a value added service setup of a carrier setup with the requested ID. If the value added service setup with the given ID does not exist, a new value added service setup will be creat…
DELETE
/carrier-setups/{id}/value-added-services/{value-added-service-id}
Deletes a value added service setup of a carrier setup with the requested ID.
TermsOfDelivery 2
Rest API for terms of deliveries
GET
/terms-of-deliveries/{id}
Returns a terms of delivery with the requested ID. If the ID does not exist, an error will be returned
GET
/terms-of-deliveries
Returns all terms of deliveries matching the given filter criteria. In case no terms of delivery matches the given filter criteria an empty collection is returned. If the filter field supports place…
ShipmentObjectives 1
Rest API to get shipment objectives
POST
/shipment-objectives
Returns objectives for the posted shipment data.
Shipping 21
API for the CarrierEngine service
POST
/DLCarrierBFBean/addShipmentAttachments
addShipmentAttachments
POST
/DLCarrierBFBean/cancelShipment
cancelShipment
POST
/DLCarrierBFBean/createPickup
createPickup
POST
/DLCarrierBFBean/createShipment
createShipment
POST
/DLCarrierBFBean/deleteItem
deleteItem
POST
/DLCarrierBFBean/deletePackage
deletePackage
POST
/DLCarrierBFBean/deletePickup
deletePickup
POST
/DLCarrierBFBean/getAllCarriers
getAllCarriers
POST
/DLCarrierBFBean/getCarrierPortfolioDetails
getCarrierPortfolioDetails
POST
/DLCarrierBFBean/getCarrierPortfolioNames
getCarrierPortfolioNames
POST
/DLCarrierBFBean/getCarrierProperties
getCarrierProperties
POST
/DLCarrierBFBean/getPickups
getPickups
POST
/DLCarrierBFBean/getShipments
getShipments
POST
/DLCarrierBFBean/processPackage
processPackage
POST
/DLCarrierBFBean/processPackageReturnEnclosedLabel
processPackageReturnEnclosedLabel
POST
/DLCarrierBFBean/processPickup
processPickup
POST
/DLCarrierBFBean/processShipment
processShipment
POST
/DLCarrierBFBean/syncPickups
syncPickups
POST
/DLCarrierBFBean/syncShipments
syncShipments
POST
/DLCarrierBFBean/updateCustomsData
updateCustomsData
POST
/DLCarrierBFBean/validateShipment
validateShipment
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 274
The contract defines 274 schemas that model the data the API accepts and returns. The most detailed are DLShipmentResponseDataDTO (102 properties), DLShipmentRequestDataDTO (93 properties), DLHazardousGoodsItemRequestDataDTO (37 properties), DLHazardousGoodsItemResponseDataDTO (33 properties). Each schema is shown below with its type and property counts.
CarrierDefinition
object
The most important information of the carrier definition.
5 properties
4 required
CarrierDefinitionTextTranslation
object
Name of the carrier in a certain language.
2 properties
1 required
CarrierExtendedInfo
object
Extended information of the carrier.
2 properties
CarrierDefinitionPage
object
2 properties
2 required
AdditionalValueDefinition
object
Information about the additional value the carrier offers.
4 properties
4 required
AdditionalValueDefinitionDefinitionPage
object
2 properties
2 required
AdditionalValueDefinitionTextTranslation
object
Name of the additional value in a certain language.
2 properties
1 required
CarrierInfoTextDefinition
object
Information about the additional info text the carrier offers.
6 properties
4 required
CarrierInfoTextDefinitionPage
object
2 properties
2 required
CarrierInfoTextDefinitionTextTranslation
object
Description of the carrier info text in a certain language.
2 properties
1 required
CarrierDespatchCountry
object
Information about the supported despatch country of the carrier.
2 properties
CarrierDespatchCountryPage
object
2 properties
2 required
CarrierDefinitionLogos
object
The logos of the carrier.
3 properties
ServiceDefinition
object
Information about the service the carrier offers.
9 properties
1 required
ServiceDefinitionPage
object
2 properties
2 required
ServiceDefinitionTextTranslation
object
Name and description of the service in a certain language.
3 properties
1 required
ValueAddedServiceDefinition
object
Information about the value added service the carrier offers.
3 properties
3 required
ValueAddedServiceDefinitionPage
object
2 properties
2 required
ValueAddedServiceDefinitionTextTranslation
object
Name and description of the value added service in a certain language.
3 properties
1 required
CarrierDescription
object
Textual description of the functional scope of a carrier.
6 properties
2 required
CarrierDescriptionPage
object
2 properties
2 required
CarrierSetup
object
The most important information of the carrier setup.
4 properties
3 required
AebProblem
object
8 properties
AebProblemError
object
Array of related errors
4 properties
CarrierSetupPage
object
2 properties
2 required
AdditionalValueChoiceEntry
object
Additional information about the choice entry of an additional value.
3 properties
2 required
AdditionalValueSetupAttributes
object
Information about the additional value setup.
4 properties
4 required
AdditionalValueTextTranslation
object
Name of the additional value in a certain language.
2 properties
1 required
AdditionalValuesSetup
object
Information about an additional value setup.
3 properties
2 required
ChoiceEntryTextTranslation
object
Name of the choice entry in a certain language.
2 properties
1 required
AdditionalValueSetupPage
object
1 property
1 required
CarrierSetupStatus
object
The status of a carrier setup.
1 property
1 required
CarrierSetupApplicationURL
object
The application URL of a carrier setup.
1 property
1 required
CarrierInfoTextSetup
object
List of carrier info text setups.
3 properties
1 required
CarrierInfoTextSetupPage
object
1 property
1 required
ServiceSetup
object
List of service setups.
3 properties
1 required
ServiceSetupPage
object
1 property
1 required
ValueAddedService
object
Information about the value added service setup.
3 properties
1 required
ValueAddedServicePage
object
1 property
1 required
DLClientTermsOfDeliveryRestDTO
object
List of terms of deliveries.
6 properties
3 required
TermsOfDeliveryTextTranslation
object
Description of the terms of delivery in a certain language.
2 properties
1 required
DLClientTermsOfDeliveryListRestDTO
object
2 properties
2 required
ComboboxEntryDTO
object
For common use in BF methods which return combobox entries, e.g. for a list of master file data.
2 properties
DLInvalidValueDTO
object
The data for fields with invalid values.
3 properties
DLMustBeFilledDTO
object
The data for fields that must be filled.
2 properties
DLObjectiveTextsDTO
object
Info texts of the objective.
4 properties
DLPossibleValuesDTO
object
A possible value for the interface.
1 property
DLShipmentObjectivePathSegmentDTO
object
The path of the objective.
2 properties
GetShipmentObjectivesResponse
object
The determined objectives of a shipment.
2 properties
ShipmentObjective
object
All accessible data of an Objective.
5 properties
TextInLanguageDTO
object
A translated text in one of the specified languages.
2 properties
AmountOfMoneyDTO
object
An amount of money with a value and an currency ISO code.
2 properties
DLContainerDataDTO
object
DTO containing data for container package types.
3 properties
DLCuboidDimensionsDTO
object
DLCuboidDimensionsDTO with length, width, height and identCode.
4 properties
4 required
DLHazardousGoodsItemRequestDataDTO
object
DTO for request information of a DLHazardousGoodsItem.
37 properties
1 required
DLPackageCumulationRequestDataDTO
object
DTO for package cumulation data.
7 properties
2 required
DLPackageHazardousGoodsDataRequestDTO
object
Holds hazardous goods data concerning the package.
3 properties
1 required
DLPackageRequestDataDTO
object
DTO for package data.
26 properties
3 required
DLPartyDTO
object
DLPartyDTO containing address data
19 properties
DLPersonDTO
object
DLPersonDTO containing contact data.
4 properties
DLReferenceTextDTO
object
DTO for reference numbers and texts of a certain (predefined) type.
2 properties
DLShipmentCarrierInfoTextDTO
object
DTO specifying a carrier's info text for a shipment.
2 properties
1 required
DLShipmentItemReferenceDTO
object
DTO for uniquely identifying an item within a shipment.
5 properties
1 required
DLShipmentItemReferenceTextDTO
object
DTO for reference texts of shipment items.
2 properties
DLShipmentItemRequestDataDTO
object
DTO for shipment item data in a request.
18 properties
1 required
DLShipmentReferenceDTO
object
DTO for uniquely identifying a DLShipment within a specific client.
3 properties
DLShipmentRequestDataDTO
object
DTO for shipment data in a request.
93 properties
9 required
DLShipmentTotalsRequestDataDTO
object
DTO for shipment totals in a request.
4 properties
DLTransportEquipmentDTO
object
DTO representing a specific transport equipment such as a containers or a pallets.
7 properties
2 required
DLTransportEquipmentReferenceDTO
object
DTO for uniquely identifying a transport equipment within a shipment.
2 properties
1 required
DLValueAddedServiceReferenceDTO
object
DTO to reference a value added service within a carrier.
1 property
1 required
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
GetShipmentObjectivesRequest
object
Determine the objectives of a shipment.
2 properties
1 required
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
QuantityDTO
object
A quantity with a value and a quantity unit. Quantity units are encoded by using AEB unit codes mainly based on the International System of Unit (e.g. 'Gram' i…
3 properties
DLAddShipmentAttachmentsResponseDTO
object
Response DTO for the addShipmentAttachments business facade method
4 properties
ResponseMessageDTO
object
Result messages like errors or warnings.
4 properties
DLAddShipmentAttachmentsRequestDTO
object
Request DTO for the addShipmentAttachments business facade method
7 properties
1 required
DLAttachmentDTO
object
DTO to hold attachment data.
4 properties
DLCancelShipmentResponseDTO
object
Response DTO for the cancelShipment business facade method
4 properties
DLCancelShipmentRequestDTO
object
Request DTO for the cancelShipment business facade method
6 properties
2 required
DLProcessModeDTO
object
DTO specifying the mode in which an operation is processed.
1 property
1 required
DLShipmentCancelParmsDTO
object
Parameters for the cancle operation for a shipment.
1 property
1 required
DLCreatePickupResponseDTO
object
Response DTO for the processPickup business facade method
6 properties
DLDocumentDTO
object
DTO for a document to be printed out by the client system.
7 properties
DLCreatePickupRequestDTO
object
Request DTO for the processPickup business facade method
7 properties
3 required
DLDocumentOutputModeDTO
object
DTO specifying the output mode for documents.
3 properties
1 required
DLPickupCreationParmsDTO
object
Creation parameters for a shipment. Specifies when and how to create a pickup and the shipment it contains.
1 property
1 required
DLPickupProcessParmsDTO
object
Process parameters for a pickup. Especially controls the handling of the manifest documents.
3 properties
3 required
DLPickupRequestDataDTO
object
DTO for pickup data.
12 properties
5 required
DLSignatureDTO
object
DLSignatureDTO containing driver's signature data
3 properties
DLCreateShipmentResponseDTO
object
Response DTO for the createShipment business facade method
14 properties
DLPackageProcessingResultDTO
object
DTO holding result information of a package processing. The package is created and basic validation checks are performed synchronously. The carrier data prepar…
11 properties
DLShipmentAccountInfoResponseDataDTO
object
Holds information from the account used for the shipment
3 properties
DLCreateShipmentRequestDTO
object
Request DTO for the createShipment business facade method
7 properties
3 required
DLDocumentScopeDTO
object
DTO specifying the scope of documents to be processed.
1 property
1 required
DLShipmentCreationParmsDTO
object
Creation parameters for a shipment. Specifies when and how to create a shipment or it's packages.
1 property
1 required
DLShipmentProcessParmsDTO
object
Process parameters for a shipment. Specifies which operations have to be performed after a shipment has been created.
6 properties
6 required
DLDeleteItemResponseDTO
object
Response DTO for the deleteItem business facade method
4 properties
DLDeleteItemRequestDTO
object
Request DTO for the deleteItem business facade method
5 properties
1 required
DLDeletePackageResponseDTO
object
Response DTO for the deletePackage business facade method
4 properties
DLDeletePackageRequestDTO
object
Request DTO for the deletePackage business facade method
5 properties
1 required
DLPackageReferenceDTO
object
DTO for uniquely identifying a package. The context settings clientIdentCode and clientSystemId are also applied when filled.
3 properties
2 required
DLDeletePickupResponseDTO
object
Response DTO for the cancelPickup business facade method
4 properties
DLDeletePickupRequestDTO
object
Request DTO for the cancelShipment business facade method
5 properties
1 required
DLPickupReferenceDTO
object
DTO for uniquely identifying a shipment pickup within a client.
3 properties
DLCarrierListItemDTO
object
Minimum carrier info to use in lists.
5 properties
DLGetAllCarriersResponseDTO
object
Response DTO containing a list of available carrier for a client.
5 properties
DLGetAllCarriersRequestDTO
object
Request DTO to retrieve the codes and names of all available carriers for a client.
4 properties
DLAdditionalValueDTO
object
Information about an additional value defined for a carrier.
4 properties
DLCarrierBusinessDivisionDTO
object
Response information about the supported business Divisions from a carrier
2 properties
DLCarrierDespatchCountryDTO
object
Response information about the supported countries from a carrier
4 properties
DLCarrierExtendedInfosDTO
object
Response information for the extended Infos URL and WebLogo for the Carrier.
4 properties
DLCarrierInfoTextDTO
object
Information about an additional info text a carrier offers.
2 properties
DLCarrierNetworkDTO
object
Response information about the networks in which the carrier is involved.
2 properties
DLGetCarrierPortfolioDetailsResponseDTO
object
Response DTO for all available carriers with their detail information.
5 properties
DLGetCarrierPropertiesResponseDTO
object
Response DTO containing the properties of a specific carrier.
19 properties
DLServiceDTO
object
Information about a service a carrier offers.
8 properties
DLValueAddedServiceDTO
object
Response information about a value added service.
3 properties
DLGetCarrierPortfolioDetailsRequestDTO
object
Response DTO for carrier properties for all carriers
5 properties
DLCarrierPortfolioNameDTO
object
DTO for the code and name of a carrier.
8 properties
DLGetCarrierPortfolioNamesResponseDTO
object
Response DTO containing the codes and names of all available carriers.
5 properties
DLGetCarrierPortfolioNamesRequestDTO
object
Request DTO to retrieve the codes and names of all available carriers.
5 properties
DLGetCarrierPropertiesRequestDTO
object
Request DTO to retrieve various properties for a specific carrier.
5 properties
1 required
DLGetPickupsResponseDTO
object
Data Transfer Object for pickup search result.
5 properties
DLPickupResponseDataDTO
object
DTO for response information of a DLShipmentPickup.
32 properties
DLShipmentPickupEDIDTO
object
Response-DTO for an EDI message for a pickup.
12 properties
DLGetPickupsRequestDTO
object
DTO to search for pickups and request detail information about them.
8 properties
DLPickupFilterDTO
object
DTO to set a filter for a pickup query.
14 properties
DLGetShipmentsResponseDTO
object
Data Transfer Object for shipment search result.
5 properties
DLHazardousGoodsItemResponseDataDTO
object
DTO for response information of a DLHazardousGoodsItem.
33 properties
DLPackageHazardousGoodsDataResponseDTO
object
Holds hazardous goods data concerning the package.
3 properties
DLPackageResponseDataDTO
object
DTO for response information of a DLPackage. Contains also errors that occurred during carrier data preparation (performed asynchronously by a job). These are…
27 properties
DLShipmentItemResponseDataDTO
object
DTO for shipment item data in a response.
20 properties
DLShipmentResponseDataDTO
object
DTO for response information of a DLShipment. Contains also errors that occurred during carrier data preparation (performed asynchronously by a job). These are…
102 properties
DLShipmentTotalsResponseDataDTO
object
DTO for shipment totals in a request.
6 properties
DLGetShipmentsRequestDTO
object
DTO to search for shipments and request detail information about them.
8 properties
DLShipmentFilterDTO
object
DTO to set a filter for a shipment query.
11 properties
DLProcessPackageResponseDTO
object
Response DTO for the getPackageDocuments business facade method
8 properties
DLMasterPackageReferenceDTO
object
DTO for uniquely identifying a master package.
1 property
1 required
DLPackageDocumentPrepareModeDTO
object
DTO specifying the prepare mode for documents on package level.
1 property
1 required
DLPackageOperationModeDTO
object
Holds a special operation ID to be performed on the package. NOTE: this function has BETA status.
1 property
1 required
DLPackageProcessParmsDTO
object
Process parameters for a package. Specifies which operations have to be performed on a package.
5 properties
4 required
DLProcessPackageRequestDTO
object
Request DTO for the getPackageDocuments business facade method.
10 properties
2 required
DLProcessPackageUpdateRequestDataDTO
object
DTO for package fields which can be updated after the initial creation of the package
2 properties
1 required
DLProcessPackageReturnEnclosedLabelResponseDTO
object
Response DTO for the processPackageReturnEnclosedLabel business facade method
5 properties
DLPackageReturnEnclosedLabelProcessParmsDTO
object
Process parameters for a package enclosed return label. Specifies which operations have to be performed on a package return enclosed label.
2 properties
2 required
DLProcessPackageReturnEnclosedLabelRequestDTO
object
Request DTO for the processPackageReturnEnclosedLabel business facade method.
6 properties
2 required
DLReturnEnclosedLabelOutputModeDTO
object
DTO specifying the output mode for return enclosed labels.
1 property
1 required
DLProcessPickupResponseDTO
object
Response DTO for the printDocumentsForPickup business facade method
5 properties
DLPickupUpdateRequestDataDTO
object
DTO for pickup fields which can be updated after the initial creation of the pickup
1 property
DLProcessPickupRequestDTO
object
Request DTO for the printDocumentsForPickup business facade method
9 properties
2 required
DLProcessShipmentResponseDTO
object
Response DTO for the processShipment business facade method. For possible validation and preparation warnings and errors see DLCreateShipmentResponseDTO
10 properties
DLProcessShipmentRequestDTO
object
Request DTO for the processShipment business facade method
15 properties
2 required
DLShipmentUpdateRequestDataDTO
object
DTO for shipment fields which can be updated after the initial creation of the shipment
24 properties
DLSyncPickupsResponseDTO
object
Data Transfer Object for a pickup synchronize result.
7 properties
DLSyncPickupsRequestDTO
object
Request DTO for pickup synchronization.
8 properties
DLSyncShipmentsResponseDTO
object
Data Transfer Object for a shipment synchronize result.
7 properties
DLSyncShipmentsRequestDTO
object
Request DTO for shipment synchronization.
7 properties
DLUpdateCustomsDataResponseDTO
object
Response DTO for the updateCustomsData business facade method
4 properties
DLReferenceTextUCDDTO
object
DTO for reference numbers and texts of a certain (predefined) type.
2 properties
DLShipmentItemReferenceTextUCDDTO
object
DTO for reference numbers and texts of a certain (predefined) type. This is the same DTO like DLShipmentItemReferenceTextDTO, but supports fewer types.
2 properties
DLShipmentItemReferenceUCDDTO
object
DTO for uniquely identifying an item within a shipment.
2 properties
DLUpdateCustomsDataRequestDTO
object
Request DTO for the updateCustomsData business facade method
9 properties
1 required
DLUpdateCustomsItemRequestDataDTO
object
DTO for a few shipment item fields which can be updated after the initial creation of the shipment. This DTO includes customs data ONLY. No item net / gross we…
9 properties
1 required
DLUpdateCustomsShipmentRequestDataDTO
object
Request DTO for a few shipment fields which can be updated after the initial creation of the shipment.
3 properties
DLValidateShipmentResponseDTO
object
Possible Result Values: VALIDATIONFAILED VALIDATIONOK VALIDATIONREQUESTNOTSUPPORTED VALIDATIONMISSINGDATA VALIDATIONNOCHECKSELECTED VALIDATIONEXECUTIONERROR
5 properties
DLShipmentValidationParmsDTO
object
DTO class for shipment validation parameter request data. Possible validation modes: ROUTESERVED and SERVICECOMPLIANT
1 property
1 required
DLValidateShipmentRequestDTO
object
DTO class for shipment validation request data.
6 properties
2 required
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
DateAndZoneDTO
object
Date and timezone.
2 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
MonitoringDataProviderDTO
object
Data Transfer Object for monitoring provider
3 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
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
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
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 Select API
AEB Carrier Event Service API
AEB Logistics Cost Management API
AEB Document Service API
AEB BSM API
#Multi-Carrier Shipping#Parcel#Shipping#Labels#Freight#Logistics
Where this information came from
This is an independent, third-party profile of AEB Carrier Connect 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.