AEB Carrier Select API
Carrier selection and routing. Creates routing tasks for a shipment and returns the carrier, service and route determined from the customer's routing rules, rates and constraints.
AEB Carrier Select API is one of 11 APIs that AEB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Routing, Carrier Selection, Transport Planning, and Logistics. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and API documentation.
This API exposes 50 operations across 34 paths, organized into 8 resource areas, and defines 105 schemas. It is described by OpenAPI 3.0.1, at version 1.0.
Requests are made against a single base URL, https://rz3.aeb.de/demo1routing/rest.
50 operations
34 paths
105 schemas
7 DELETE17 GET18 POST8 PUT
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
AEB Carrier Select 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 50
Across 34 paths, the API surfaces 50 operations — 7 DELETE, 17 GET, 18 POST, 8 PUT. They span 8 resource areas: FoundationAFBean, Logon, DataFeedBFBean, ExternalTelemetryBFBean, Companies, WorkstationServiceAgent, Carrier, Routing. Each is listed below with its method, path, parameters, and response codes.
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.
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.
Carrier 19
Rest API for carriers
GET
/carriers/{id}
Returns the carrier with the requested ID.
PUT
/carriers/{id}
Create or update the carrier with the specified ID. If the carrier with the given ID does not exist, a new carrier is created. If the carrier exists, the existing carrier is fully updated. Not filled…
DELETE
/carriers/{id}
Delete the carrier with the specified ID.
GET
/carriers
Returns all carriers matching the given filter criteria. In case no carrier matches the given filter criteria, an empty collection is returned. If the filter field supports place holders ('' or '%'),…
GET
/carriers/{id}/info-texts
Returns all info texts of a carrier.
PUT
/carriers/{id}/info-texts
Create or update all info texts of the specified carrier. If the info text with the given ID does not exist, a new info text is created. If the info text exists, the existing info text is fully updat…
GET
/carriers/{id}/info-texts/{info-text-id}
Returns the info text of a carrier with the requested ID.
PUT
/carriers/{id}/info-texts/{info-text-id}
Create or update an info text with the specified ID. If the info text with the given ID does not exist, a new info text is created. If the info text exists, the existing info text is fully updated. N…
DELETE
/carriers/{id}/info-texts/{info-text-id}
Deletes the info text of a carrier with the requested ID.
GET
/carriers/{id}/services
Returns all services of a carrier.
PUT
/carriers/{id}/services
Create or update all services of specified carrier. If a service with a given ID does not exist, a new service is created. If the service exists, the existing service is fully updated. Not filled fie…
GET
/carriers/{id}/services/{service-id}
Returns the service of the carrier with the requested ID.
PUT
/carriers/{id}/services/{service-id}
Create or update a service with the specified ID. If the service with the given id does not exist, a new service is created. If the service exist, the existing service is fully updated. Not filled fi…
DELETE
/carriers/{id}/services/{service-id}
Deletes the service of the carrier with the requested ID.
GET
/carriers/{id}/value-added-services
Returns all value added services of a carrier.
PUT
/carriers/{id}/value-added-services
Create or update all value added services of a carrier with the requested ID. If a value added service with a given ID does not exist, a new value added service is created. If the value added service…
GET
/carriers/{id}/value-added-services/{value-added-service-id}
Returns a value added service of a carrier with the requested ID.
PUT
/carriers/{id}/value-added-services/{value-added-service-id}
Create or update a value added service of a carrier with the requested ID. If the value added service with the given ID does not exist, a new value added service is created. If the value added servic…
DELETE
/carriers/{id}/value-added-services/{value-added-service-id}
Deletes a value added service of a carrier with the requested ID.
Routing 10
API for the handling of routing tasks
POST
/RoutingBFBean/createRoutingTask
createRoutingTask
POST
/RoutingBFBean/createSupplementTask
createSupplementTask
POST
/RoutingBFBean/getAllCarriers
getAllCarriers
POST
/RoutingBFBean/getHandoverPoints
getHandoverPoints
POST
/RoutingBFBean/getRatingProfiles
getRatingProfiles
POST
/RoutingBFBean/getRejectedRoutingTaskResult
getRejectedRoutingTaskResult
POST
/RoutingBFBean/getRoutingRequirementTypes
getRoutingRequirementTypes
POST
/RoutingBFBean/getRoutingTaskResult
getRoutingTaskResult
POST
/RoutingBFBean/getSupplementTaskResult
getSupplementTaskResult
POST
/RoutingBFBean/waitForRoutingTaskResult
waitForRoutingTaskResult
Schemas 105
The contract defines 105 schemas that model the data the API accepts and returns. The most detailed are Company (24 properties), RoutingTaskDTO (18 properties), SupplementTaskDTO (18 properties), ApplicationFacadeParmsDTO (16 properties). Each schema is shown below with its type and property counts.
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
ResponseMessageDTO
object
Result messages like errors or warnings.
4 properties
TextInLanguageDTO
object
A translated text in one of the specified languages.
2 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
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
Carrier
object
4 properties
4 required
AebProblem
object
8 properties
AebProblemError
object
Array of related errors
4 properties
CarrierPage
object
2 properties
2 required
CarrierInfoText
object
2 properties
2 required
CarrierInfoTextList
object
1 property
1 required
CarrierInfoTextTextTranslation
object
2 properties
1 required
CarrierService
object
2 properties
2 required
CarrierServiceList
object
1 property
1 required
CarrierServiceTextTranslation
object
2 properties
1 required
CarrierValueAddedService
object
2 properties
2 required
CarrierValueAddedServiceList
object
1 property
1 required
CarrierValueAddedServiceTextTranslation
object
2 properties
1 required
CreateRoutingTaskResponseDTO
object
Response DTO for create routing rask.
5 properties
AmountOfMoneyDTO
object
An amount of money with a value and an currency ISO code.
2 properties
BillingAdditionalFreightCalculationDataDTO
object
The BillingAdditionalFreightCalculationDataDTO provides data to send to Logistics Costs Management. It fills some fields BFreightTransportExtendedDataDTO, but…
7 properties
CreateRoutingTaskRequestDTO
object
Request DTO for create routing task.
5 properties
1 required
CuboidDimensionsDTO
object
Dimensions of a cuboid with length, width, height and quantityUnit.
4 properties
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
DangerousGoodsCodeDTO
object
Information about dangerous goods.
1 property
1 required
HopReferenceDTO
object
Representation of a handover point as a defined entity
1 property
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
RoutingAddressDTO
object
DTO to provide address data
7 properties
5 required
RoutingParmsDTO
object
Detailed settings for proposal, supplement and ranking calculations.
1 property
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
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
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
RoutingTaskHandlingUnitDTO
object
Basic data of a handling unit which shall be transported as defined in the RoutingTaskDTO.
5 properties
4 required
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
CreateSupplementTaskResponseDTO
object
Response DTO for create supplement task.
5 properties
CreateSupplementTaskRequestDTO
object
Request DTO for create supplement task.
5 properties
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
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
CarrierDTO
object
Representation of a carrier.
3 properties
1 required
GetAllCarriersResponseDTO
object
ResponseDTO for an access request of carriers.
5 properties
ServiceInfoDTO
object
DTO to provide service data
1 property
1 required
ValueAddedServiceDTO
object
Representation of a value-added service.
1 property
1 required
GetAllCarriersRequestDTO
object
Request DTO to access all carriers existing for the given target client in the Routing engine.
4 properties
GetHandoverPointsResponseDTO
object
ResponseDTO for an access request of handover points.
5 properties
HandoverPointDTO
object
Representation of an handover point.
3 properties
2 required
GetHandoverPointsRequestDTO
object
Request DTO to access all handover points existing for the given target client in the Routing engine.
4 properties
GetRatingProfilesResponseDTO
object
ResponseDTO for an access request of rating profiles.
5 properties
RatingProfileDTO
object
DTO representation of a rating profile
2 properties
1 required
GetRatingProfilesRequestDTO
object
Request DTO to access all rating profiles configured for the given target client in the Routing engine.
4 properties
GetRoutingTaskResultResponseDTO
object
Response DTO of a routing task request.
5 properties
HopDTO
object
Representation of an handover point
PricingSupplementDataDTO
object
Price information.
3 properties
3 required
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
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
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
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
RoutingScheduleTypeDTO
object
Holds a reference of a schedule configuration.
1 property
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
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
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
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
ServiceVasValidationSupplementDataDTO
object
Result of validation
1 property
1 required
StarRatingSupplementDataDTO
object
Holds the star rating
1 property
1 required
ValueRatingSupplementDataDTO
object
Holds the value rating.
1 property
1 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
GetRoutingRequirementTypesResponseDTO
object
ResponseDTO for a request of requirement types.
5 properties
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
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
GetRoutingRequirementTypesRequestDTO
object
Request DTO to access all requirement types configured for the given target client in the Routing engine.
4 properties
GetSupplementTaskResultResponseDTO
object
Response DTO of a supplement task request.
5 properties
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
GetSupplementTaskResultRequestDTO
object
Request DTO to get the current calculation status for the supplement task defined by the provided task id.
5 properties
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
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 Connect API
AEB Carrier Event Service API
AEB Logistics Cost Management API
AEB Document Service API
AEB BSM API
#Routing#Carrier Selection#Transport Planning#Logistics
Where this information came from
This is an independent, third-party profile of AEB Carrier Select 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.