AEB BSM Carrier API is one of 67 APIs that AEB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include BSM Carrier. 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
3 operations
across 3 paths,
and defines 55 schemas.
It is described by OpenAPI 3.2.0, at version 1.0.
Requests are made against a single base URL, https://rz3.aeb.de/test2bsm/rest.
The identity and technical contract details declared by the specification.
DLShipmentItemResponseDataDTO
object
DTO for shipment item data in a response.
20 properties
GetQuotedDataDTO
object
The total net price of the quoted service. Contains the price negotiated with the carrier for the account, if possible; otherwise the list price is used. May b…
5 properties
DLShipmentCarrierInfoTextDTO
object
DTO specifying a carrier's info text for a shipment.
2 properties
1 required
GetQuotesRequestDTO
object
The data needed to request quoted services for a shipment.
6 properties
DLShipmentAccountInfoResponseDataDTO
object
Holds information from the account used for the shipment
3 properties
DLShipmentTotalsResponseDataDTO
object
DTO for shipment totals in a request.
6 properties
DLPackageCumulationRequestDataDTO
object
DTO for package cumulation data.
7 properties
2 required
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
DLHazardousGoodsItemResponseDataDTO
object
DTO for response information of a DLHazardousGoodsItem.
33 properties
QuotedServiceMessageDTO
object
A text with a code and a hint to the customer. Sources can be the original carrier response or generated by the service
2 properties
DLPackageHazardousGoodsDataRequestDTO
object
Holds hazardous goods data concerning the package.
3 properties
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
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
DLShipmentItemRequestDataDTO
object
DTO for shipment item data in a request.
18 properties
1 required
AmountOfMoneyDTO
object
An amount of money with a value and an currency ISO code.
2 properties
GetShipmentResponseDTO
object
The response of a getShipment call.
5 properties
BSMDLCreateShipmentRequestDTO
object
Request DTO for the createShipment business facade method
8 properties
3 required
GetQuotedServiceDTO
object
The quoted service result for one service of a carrier.
4 properties
GenericDataFieldDTO
object
A field of a generic data record.
3 properties
DLTransportEquipmentReferenceDTO
object
DTO for uniquely identifying a transport equipment within a shipment.
2 properties
1 required
ShipmentResponseDataDTO
object
The data of a shipment.
2 properties
GetQuotesResponseDTO
object
The response of a getQuotes call.
5 properties
DLPartyDTO
object
DLPartyDTO containing address data
19 properties
GetShipmentRequestDTO
object
The request to get the data of the shipment including the quoted service.
7 properties
DLShipmentItemReferenceDTO
object
DTO for uniquely identifying an item within a shipment.
5 properties
1 required
DLDocumentDTO
object
DTO for a document to be printed out by the client system.
7 properties
DLShipmentItemReferenceTextDTO
object
DTO for reference texts of shipment items.
2 properties
DLContainerDataDTO
object
DTO containing data for container package types.
3 properties
DLValueAddedServiceReferenceDTO
object
DTO to reference a value added service within a carrier.
1 property
1 required
DLPackageRequestDataDTO
object
DTO for package data.
26 properties
3 required
DLReferenceTextDTO
object
DTO for reference numbers and texts of a certain (predefined) type.
2 properties
BSInteractionControlUsecaseDTO
object
Usecase for interaction control
1 property
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
DLDocumentOutputModeDTO
object
DTO specifying the output mode for documents.
3 properties
1 required
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
GenericDataRecordDTO
object
A generic record of data. Each field is qualified by name and type and has a value.
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
ComboboxEntryDTO
object
For common use in BF methods which return combobox entries, e.g. for a list of master file data.
2 properties
DLCreateShipmentResponseDTO
object
Response DTO for the createShipment business facade method
14 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
BSInteractionControlIDDTO
object
DTO for interaction control id
2 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
DLPersonDTO
object
DLPersonDTO containing contact data.
4 properties
DLValueAddedServiceDTO
object
Response information about a value added service.
3 properties
DLHazardousGoodsItemRequestDataDTO
object
DTO for request information of a DLHazardousGoodsItem.
37 properties
1 required
BSInteractionControlDTO
object
DTO for interaction control
2 properties
TextInLanguageDTO
object
A translated text in one of the specified languages.
2 properties
DLDocumentScopeDTO
object
DTO specifying the scope of documents to be processed.
1 property
1 required
ResponseMessageDTO
object
Result messages like errors or warnings.
4 properties
DLShipmentRequestDataDTO
object
DTO for shipment data in a request.
93 properties
9 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs AEB publishes across the network.
