AEB Shipping API
API for the CarrierEngine service
AEB Shipping API is one of 67 APIs that AEB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Shipping. 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 21 operations across 21 paths, and defines 120 schemas. It is described by OpenAPI 3.2.0, at version 1.0.
Requests are made against 2 base URLs: https://rz3.aeb.de/test2bsm/rest, https://rz3.aeb.de/demo1cai/rest.
21 operations
21 paths
120 schemas
21 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
AEB Shipping 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 21
Across 21 paths, the API surfaces 21 operations — 21 POST. Each is listed below with its method, path, parameters, and response codes.
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/getCarrierPortfolioNames
getCarrierPortfolioNames
POST
/DLCarrierBFBean/getCarrierPortfolioDetails
getCarrierPortfolioDetails
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
Schemas 120
The contract defines 120 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.
DLShipmentCarrierInfoTextDTO
object
DTO specifying a carrier's info text for a shipment.
2 properties
1 required
DLGetAllCarriersRequestDTO
object
Request DTO to retrieve the codes and names of all available carriers for a client.
4 properties
DLPackageCumulationRequestDataDTO
object
DTO for package cumulation data.
7 properties
2 required
DLAddShipmentAttachmentsRequestDTO
object
Request DTO for the addShipmentAttachments business facade method
7 properties
1 required
DLShipmentPickupEDIDTO
object
Response-DTO for an EDI message for a pickup.
12 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
DLShipmentCreationParmsDTO
object
Creation parameters for a shipment. Specifies when and how to create a shipment or it's packages.
1 property
1 required
DLAttachmentDTO
object
DTO to hold attachment data.
4 properties
DLValidateShipmentRequestDTO
object
DTO class for shipment validation request data.
6 properties
2 required
DLCancelShipmentRequestDTO
object
Request DTO for the cancelShipment business facade method
6 properties
2 required
DLContainerDataDTO
object
DTO containing data for container package types.
3 properties
DLProcessPackageRequestDTO
object
Request DTO for the getPackageDocuments business facade method.
10 properties
2 required
DLPickupReferenceDTO
object
DTO for uniquely identifying a shipment pickup within a client.
3 properties
DLPackageOperationModeDTO
object
Holds a special operation ID to be performed on the package. NOTE: this function has BETA status.
1 property
1 required
DLPackageRequestDataDTO
object
DTO for package data.
26 properties
3 required
DLCancelShipmentResponseDTO
object
Response DTO for the cancelShipment business facade method
4 properties
DLCarrierListItemDTO
object
Minimum carrier info to use in lists.
5 properties
DLSyncShipmentsRequestDTO
object
Request DTO for shipment synchronization.
7 properties
DLReferenceTextDTO
object
DTO for reference numbers and texts of a certain (predefined) type.
2 properties
DLSignatureDTO
object
DLSignatureDTO containing driver's signature data
3 properties
DLShipmentTotalsRequestDataDTO
object
DTO for shipment totals in a request.
4 properties
DLGetCarrierPropertiesRequestDTO
object
Request DTO to retrieve various properties for a specific carrier.
5 properties
1 required
DLDocumentOutputModeDTO
object
DTO specifying the output mode for documents.
3 properties
1 required
DLAdditionalValueDTO
object
Information about an additional value defined for a carrier.
4 properties
DLProcessModeDTO
object
DTO specifying the mode in which an operation is processed.
1 property
1 required
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
DLShipmentProcessParmsDTO
object
Process parameters for a shipment. Specifies which operations have to be performed after a shipment has been created.
6 properties
6 required
DLGetCarrierPortfolioNamesResponseDTO
object
Response DTO containing the codes and names of all available carriers.
5 properties
DLCreatePickupRequestDTO
object
Request DTO for the processPickup business facade method
7 properties
3 required
ComboboxEntryDTO
object
For common use in BF methods which return combobox entries, e.g. for a list of master file data.
2 properties
DLDeletePickupResponseDTO
object
Response DTO for the cancelPickup business facade method
4 properties
DLUpdateCustomsDataResponseDTO
object
Response DTO for the updateCustomsData business facade method
4 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
DLCarrierDespatchCountryDTO
object
Response information about the supported countries from a carrier
4 properties
DLShipmentFilterDTO
object
DTO to set a filter for a shipment query.
11 properties
DLReferenceTextUCDDTO
object
DTO for reference numbers and texts of a certain (predefined) type.
2 properties
DLShipmentUpdateRequestDataDTO
object
DTO for shipment fields which can be updated after the initial creation of the shipment
24 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
DLCarrierBusinessDivisionDTO
object
Response information about the supported business Divisions from a carrier
2 properties
DLShipmentItemReferenceUCDDTO
object
DTO for uniquely identifying an item within a shipment.
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
AmountOfMoneyDTO
object
An amount of money with a value and an currency ISO code.
2 properties
DLPickupCreationParmsDTO
object
Creation parameters for a shipment. Specifies when and how to create a pickup and the shipment it contains.
1 property
1 required
DLProcessPickupResponseDTO
object
Response DTO for the printDocumentsForPickup business facade method
5 properties
DLPickupProcessParmsDTO
object
Process parameters for a pickup. Especially controls the handling of the manifest documents.
3 properties
3 required
DLProcessPackageReturnEnclosedLabelResponseDTO
object
Response DTO for the processPackageReturnEnclosedLabel business facade method
5 properties
DLMasterPackageReferenceDTO
object
DTO for uniquely identifying a master package.
1 property
1 required
DLPickupFilterDTO
object
DTO to set a filter for a pickup query.
14 properties
DLGetCarrierPortfolioDetailsRequestDTO
object
Response DTO for carrier properties for all carriers
5 properties
DLCarrierExtendedInfosDTO
object
Response information for the extended Infos URL and WebLogo for the Carrier.
4 properties
GenericDataRecordDTO
object
A generic record of data. Each field is qualified by name and type and has a value.
2 properties
DLCreateShipmentResponseDTO
object
Response DTO for the createShipment business facade method
14 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
DLValidateShipmentResponseDTO
object
Possible Result Values: VALIDATIONFAILED VALIDATIONOK VALIDATIONREQUESTNOTSUPPORTED VALIDATIONMISSINGDATA VALIDATIONNOCHECKSELECTED VALIDATIONEXECUTIONERROR
5 properties
DLShipmentReferenceDTO
object
DTO for uniquely identifying a DLShipment within a specific client.
3 properties
DLPackageHazardousGoodsDataResponseDTO
object
Holds hazardous goods data concerning the package.
3 properties
DLUpdateCustomsDataRequestDTO
object
Request DTO for the updateCustomsData business facade method
9 properties
1 required
DLPickupUpdateRequestDataDTO
object
DTO for pickup fields which can be updated after the initial creation of the pickup
1 property
DLReturnEnclosedLabelOutputModeDTO
object
DTO specifying the output mode for return enclosed labels.
1 property
1 required
ResponseMessageDTO
object
Result messages like errors or warnings.
4 properties
DLShipmentValidationParmsDTO
object
DTO class for shipment validation parameter request data. Possible validation modes: ROUTESERVED and SERVICECOMPLIANT
1 property
1 required
DLShipmentItemResponseDataDTO
object
DTO for shipment item data in a response.
20 properties
DLShipmentTotalsResponseDataDTO
object
DTO for shipment totals in a request.
6 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
DLGetShipmentsRequestDTO
object
DTO to search for shipments and request detail information about them.
8 properties
DLHazardousGoodsItemResponseDataDTO
object
DTO for response information of a DLHazardousGoodsItem.
33 properties
DLDeletePackageResponseDTO
object
Response DTO for the deletePackage business facade method
4 properties
DLGetPickupsResponseDTO
object
Data Transfer Object for pickup search result.
5 properties
DLShipmentItemRequestDataDTO
object
DTO for shipment item data in a request.
18 properties
1 required
DLGetCarrierPortfolioNamesRequestDTO
object
Request DTO to retrieve the codes and names of all available carriers.
5 properties
DLGetCarrierPropertiesResponseDTO
object
Response DTO containing the properties of a specific carrier.
19 properties
DLDeleteItemRequestDTO
object
Request DTO for the deleteItem business facade method
5 properties
1 required
DLProcessPackageResponseDTO
object
Response DTO for the getPackageDocuments business facade method
8 properties
DLTransportEquipmentReferenceDTO
object
DTO for uniquely identifying a transport equipment within a shipment.
2 properties
1 required
GenericDataFieldDTO
object
A field of a generic data record.
3 properties
DLSyncPickupsRequestDTO
object
Request DTO for pickup synchronization.
8 properties
DLPartyDTO
object
DLPartyDTO containing address data
19 properties
DLShipmentItemReferenceDTO
object
DTO for uniquely identifying an item within a shipment.
5 properties
1 required
DLPackageDocumentPrepareModeDTO
object
DTO specifying the prepare mode for documents on package level.
1 property
1 required
DLDocumentDTO
object
DTO for a document to be printed out by the client system.
7 properties
DLDeleteItemResponseDTO
object
Response DTO for the deleteItem business facade method
4 properties
DLUpdateCustomsShipmentRequestDataDTO
object
Request DTO for a few shipment fields which can be updated after the initial creation of the shipment.
3 properties
DLShipmentCancelParmsDTO
object
Parameters for the cancle operation for a shipment.
1 property
1 required
DLPickupResponseDataDTO
object
DTO for response information of a DLShipmentPickup.
32 properties
DLTransportEquipmentDTO
object
DTO representing a specific transport equipment such as a containers or a pallets.
7 properties
2 required
DLCarrierNetworkDTO
object
Response information about the networks in which the carrier is involved.
2 properties
DLGetShipmentsResponseDTO
object
Data Transfer Object for shipment search result.
5 properties
DLHazardousGoodsItemRequestDataDTO
object
DTO for request information of a DLHazardousGoodsItem.
37 properties
1 required
TextInLanguageDTO
object
A translated text in one of the specified languages.
2 properties
DLGetCarrierPortfolioDetailsResponseDTO
object
Response DTO for all available carriers with their detail information.
5 properties
DLCreatePickupResponseDTO
object
Response DTO for the processPickup business facade method
6 properties
DLShipmentRequestDataDTO
object
DTO for shipment data in a request.
93 properties
9 required
DLProcessShipmentResponseDTO
object
Response DTO for the processShipment business facade method. For possible validation and preparation warnings and errors see DLCreateShipmentResponseDTO
10 properties
DLProcessPackageUpdateRequestDataDTO
object
DTO for package fields which can be updated after the initial creation of the package
2 properties
1 required
DLShipmentAccountInfoResponseDataDTO
object
Holds information from the account used for the shipment
3 properties
DLGetAllCarriersResponseDTO
object
Response DTO containing a list of available carrier for a client.
5 properties
DLGetPickupsRequestDTO
object
DTO to search for pickups and request detail information about them.
8 properties
DLPackageHazardousGoodsDataRequestDTO
object
Holds hazardous goods data concerning the package.
3 properties
1 required
DLPickupRequestDataDTO
object
DTO for pickup data.
12 properties
5 required
DLSyncShipmentsResponseDTO
object
Data Transfer Object for a shipment synchronize result.
7 properties
DLDeletePackageRequestDTO
object
Request DTO for the deletePackage business facade method
5 properties
1 required
DLServiceDTO
object
Information about a service a carrier offers.
8 properties
DLProcessShipmentRequestDTO
object
Request DTO for the processShipment business facade method
15 properties
2 required
DLCarrierPortfolioNameDTO
object
DTO for the code and name of a carrier.
8 properties
DLProcessPackageReturnEnclosedLabelRequestDTO
object
Request DTO for the processPackageReturnEnclosedLabel business facade method.
6 properties
2 required
DLPackageReferenceDTO
object
DTO for uniquely identifying a package. The context settings clientIdentCode and clientSystemId are also applied when filled.
3 properties
2 required
DLDeletePickupRequestDTO
object
Request DTO for the cancelShipment business facade method
5 properties
1 required
DLShipmentItemReferenceTextDTO
object
DTO for reference texts of shipment items.
2 properties
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
DLValueAddedServiceReferenceDTO
object
DTO to reference a value added service within a carrier.
1 property
1 required
DLSyncPickupsResponseDTO
object
Data Transfer Object for a pickup synchronize result.
7 properties
DLPackageProcessParmsDTO
object
Process parameters for a package. Specifies which operations have to be performed on a package.
5 properties
4 required
DLCarrierInfoTextDTO
object
Information about an additional info text a carrier offers.
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
DLCuboidDimensionsDTO
object
DLCuboidDimensionsDTO with length, width, height and identCode.
4 properties
4 required
DLProcessPickupRequestDTO
object
Request DTO for the printDocumentsForPickup business facade method
9 properties
2 required
DLPersonDTO
object
DLPersonDTO containing contact data.
4 properties
DLValueAddedServiceDTO
object
Response information about a value added service.
3 properties
DLAddShipmentAttachmentsResponseDTO
object
Response DTO for the addShipmentAttachments business facade method
4 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from AEB 12
Other APIs AEB publishes across the network.
AEB AEB Delivery API
AEB Billing API
AEB Billing Scenario API
AEB BIS Audit BF Bean API
AEB BISBF Bean API
AEB BSM Carrier API
AEB BSM International Customs API
AEB BSM Sync API
AEB Carrier API
AEB Carrier Definition API
AEB Carrier Description API
AEB Carrier Event Service BF Bean API
#Shipping
Where this information came from
This is an independent, third-party profile of AEB Shipping 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.