AEB Routing API is one of 67 APIs that AEB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Routing. 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
10 operations
across 10 paths,
and defines 58 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/demo1routing/rest.
The identity and technical contract details declared by the specification.
RouteScheduleDTO
object
DTO to provide a result of a schedule calculation. It's values are filled depending on the calculation state and the calculation mode.
8 properties
2 required
BillingAdditionalFreightCalculationDataDTO
object
The BillingAdditionalFreightCalculationDataDTO provides data to send to Logistics Costs Management. It fills some fields BFreightTransportExtendedDataDTO, but…
7 properties
RoutingTaskLocationDTO
object
Class for location based routing task data for BF. Contains data of a complete address or a reference to a hand over point and its location/address in the mast…
2 properties
RatingProfileDTO
object
DTO representation of a rating profile
2 properties
1 required
RoutingTaskHandlingUnitDTO
object
Basic data of a handling unit which shall be transported as defined in the RoutingTaskDTO.
5 properties
4 required
CarrierDTO
object
Representation of a carrier.
3 properties
1 required
ServiceVasValidationSupplementDataDTO
object
Result of validation
1 property
1 required
ServiceDTO
object
Representation of a service classified by a service code, a provider code and value-added service codes. This DTO is used in context of creating a SupplementTa…
3 properties
2 required
GetRoutingTaskResultRequestDTO
object
Request DTO to get the a list of ranked proposals and the current calculation status for the routing task defined by the provided task id.
5 properties
1 required
GetRoutingRequirementTypesRequestDTO
object
Request DTO to access all requirement types configured for the given target client in the Routing engine.
4 properties
RoutingSupplementTypeDTO
object
Each supplement is characterized by a unique name defined by the user and its dataType. It defines one type of supplement.
2 properties
2 required
RoutingProposalDTO
object
Main DTO to hold data on a proposal. Each leg contains information on services enriched with supplements as additional information. The entirety of legs descri…
5 properties
3 required
CusBillingFieldDTO
object
This is a standard DTO class, which holds customized content. Custom field dto, send to Logistics Cost Management. Must also be defined in Logistics Cost Manag…
3 properties
3 required
RoutingLegProposalDTO
object
Describes one leg ('part') of a whole transport chain. The entirety of legs describes a set of services of one proposal. In case of direct simple routing, a pr…
9 properties
4 required
RoutingRequirementDTO
object
Representation of a requirement, classified by a requirement type and a requirement code. This DTO is used in context of creating a RoutingTasks.
2 properties
2 required
ValueRatingSupplementDataDTO
object
Holds the value rating.
1 property
1 required
WaitForRoutingTaskResultRequestDTO
object
Request DTO to get the a list of ranked proposals and the current calculation status for the routing task defined by the provided task id.
6 properties
2 required
RoutingScheduleTypeDTO
object
Holds a reference of a schedule configuration.
1 property
AmountOfMoneyDTO
object
An amount of money with a value and an currency ISO code.
2 properties
GetRoutingTaskResultResponseDTO
object
Response DTO of a routing task request.
5 properties
CreateRoutingTaskRequestDTO
object
Request DTO for create routing task.
5 properties
1 required
HopReferenceDTO
object
Representation of a handover point as a defined entity
1 property
1 required
GetHandoverPointsRequestDTO
object
Request DTO to access all handover points existing for the given target client in the Routing engine.
4 properties
GetAllCarriersRequestDTO
object
Request DTO to access all carriers existing for the given target client in the Routing engine.
4 properties
HopDTO
object
Representation of an handover point
HandoverPointDTO
object
Representation of an handover point.
3 properties
2 required
RoutingAddressDTO
object
DTO to provide address data
7 properties
5 required
RoutingRequirementInTypeDTO
object
DTO representation of a routing requirement contained in a routing requirement type. This DTO is used in context of getting a list of all available requirement…
2 properties
1 required
StarRatingSupplementDataDTO
object
Holds the star rating
1 property
1 required
RoutingTaskDTO
object
The RoutingTaskDTO is the main representation of a routing task. The data describes a set of different handling units which shall be transported in one process…
18 properties
4 required
SupplementTaskDTO
object
The SupplementTaskDTO is the main representation of a supplement task. The data describes a set of different handling units which shall be transported in one p…
18 properties
5 required
ValueAddedServiceDTO
object
Representation of a value-added service.
1 property
1 required
DangerousGoodsCodeDTO
object
Information about dangerous goods.
1 property
1 required
RoutingParmsDTO
object
Detailed settings for proposal, supplement and ranking calculations.
1 property
RouteLegScheduleDTO
object
DTO to provide a leg of a route schedule calculation. It's values are filled depending on the calculation state and the calculation mode.
4 properties
GetRoutingRequirementTypesResponseDTO
object
ResponseDTO for a request of requirement types.
5 properties
GetHandoverPointsResponseDTO
object
ResponseDTO for an access request of handover points.
5 properties
RoutingPartyDTO
object
A party contains a company with information on the address of the given party. Furthermore, the company fulfills one or more certain roles within the routing c…
2 properties
2 required
GetSupplementTaskResultRequestDTO
object
Request DTO to get the current calculation status for the supplement task defined by the provided task id.
5 properties
1 required
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
GetRatingProfilesResponseDTO
object
ResponseDTO for an access request of rating profiles.
5 properties
ServiceInfoDTO
object
DTO to provide service data
1 property
1 required
SupplementTaskResultDTO
object
Contains a list of calculated supplements and information on the current calculation status for for the routing task with the given taskId.
7 properties
4 required
CreateRoutingTaskResponseDTO
object
Response DTO for create routing rask.
5 properties
RoutingRequirementTypeDTO
object
DTO representation of a routing requirement type. This DTO is used in context of getting a list of all available requirements available for a target client.
3 properties
2 required
CreateSupplementTaskResponseDTO
object
Response DTO for create supplement task.
5 properties
PricingSupplementDataDTO
object
Price information.
3 properties
3 required
DateAndZoneDTO
object
Date and timezone.
2 properties
GetSupplementTaskResultResponseDTO
object
Response DTO of a supplement task request.
5 properties
RoutingTaskResultDTO
object
Contains a list of ranked proposals and information on the current calculation status for for the routing task with the given taskId.
6 properties
3 required
GetAllCarriersResponseDTO
object
ResponseDTO for an access request of carriers.
5 properties
RoutingSupplementDTO
object
This supplement DTO is a container for additional information. One proposal can have multiple supplements. Supplements are calculated individually. A routing t…
5 properties
3 required
GetRatingProfilesRequestDTO
object
Request DTO to access all rating profiles configured for the given target client in the Routing engine.
4 properties
CreateSupplementTaskRequestDTO
object
Request DTO for create supplement task.
5 properties
1 required
RoutingSupplementDataDTO
object
Container class for all supplement dependent data for BF. Contains additional data calculated by respective adapters based on a proposal for a routing task. De…
4 properties
CuboidDimensionsDTO
object
Dimensions of a cuboid with length, width, height and quantityUnit.
4 properties
TextInLanguageDTO
object
A translated text in one of the specified languages.
2 properties
ResponseMessageDTO
object
Result messages like errors or warnings.
4 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs AEB publishes across the network.