How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

AEB LISBF20 Bean API

Business facade for LIS, version 2.0

AEB LISBF20 Bean API is one of 67 APIs that AEB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include LISBF20Bean. 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 27 operations across 27 paths, and defines 143 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.

27 operations 27 paths 143 schemas 27 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://rz3.aeb.de/test2ici/rest
Authentication
API Key, HTTP Basic
Resource Areas
1

Authentication & Security 2

AEB LISBF20 Bean 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 27

Across 27 paths, the API surfaces 27 operations — 27 POST. Each is listed below with its method, path, parameters, and response codes.

LISBF20Bean 27

Business facade for LIS, version 2.0

POST
/LISBF20Bean/calculateTargetTime
calculateTargetTime
calculateTargetTime body → default
POST
/LISBF20Bean/getConsignments
getConsignments
getConsignments body → default
POST
/LISBF20Bean/getDocumentCategories
getDocumentCategories
getDocumentCategories body → default
POST
/LISBF20Bean/getEventDefinitions
getEventDefinitions
getEventDefinitions body → default
POST
/LISBF20Bean/getMODocument
getMODocument
getMODocument body → default
POST
/LISBF20Bean/getOrderFulfillmentPlans
getOrderFulfillmentPlans
getOrderFulfillmentPlans body → default
POST
/LISBF20Bean/getQuickSearchResult
getQuickSearchResult
getQuickSearchResult body → default
POST
/LISBF20Bean/getTrackingEvents
getTrackingEvents
getTrackingEvents body → default
POST
/LISBF20Bean/getTrackingObjectEvents
getTrackingObjectEvents
getTrackingObjectEvents body → default
POST
/LISBF20Bean/getUniqueConsignment
getUniqueConsignment
getUniqueConsignment body → default
POST
/LISBF20Bean/lisBfDummyMethod
lisBfDummyMethod
lisBfDummyMethod 1 param → default
POST
/LISBF20Bean/receiveAreaDependSchedule
receiveAreaDependSchedule
receiveAreaDependSchedule body → default
POST
/LISBF20Bean/receiveConsignment
receiveConsignment
receiveConsignment body → default
POST
/LISBF20Bean/receiveConsignmentWithTransports
receiveConsignmentWithTransports
receiveConsignmentWithTransports body → default
POST
/LISBF20Bean/receiveEventCodeList
receiveEventCodeList
receiveEventCodeList body → default
POST
/LISBF20Bean/receiveHandlingUnits
receiveHandlingUnits
receiveHandlingUnits body → default
POST
/LISBF20Bean/receiveMaterialMasterFile
receiveMaterialMasterFile
receiveMaterialMasterFile body → default
POST
/LISBF20Bean/receiveMultiReferenceTrackingObjectDocuments
receiveMultiReferenceTrackingObjectDocuments
receiveMultiReferenceTrackingObjectDocuments body → default
POST
/LISBF20Bean/receiveOrder
receiveOrder
receiveOrder body → default
POST
/LISBF20Bean/receivePhysicalTransport
receivePhysicalTransport
receivePhysicalTransport body → default
POST
/LISBF20Bean/receiveTrackingEvent
receiveTrackingEvent
receiveTrackingEvent body → default
POST
/LISBF20Bean/receiveTrackingEventList
receiveTrackingEventList
receiveTrackingEventList body → default
POST
/LISBF20Bean/receiveTrackingObjectDocuments
receiveTrackingObjectDocuments
receiveTrackingObjectDocuments body → default
POST
/LISBF20Bean/receiveTransport
receiveTransport
receiveTransport body → default
POST
/LISBF20Bean/receiveTransportUnit
receiveTransportUnit
receiveTransportUnit body → default
POST
/LISBF20Bean/resetConsignmentWithTransports
resetConsignmentWithTransports
resetConsignmentWithTransports body → default
POST
/LISBF20Bean/syncConsignments
syncConsignments
syncConsignments body → default

Schemas 143

The contract defines 143 schemas that model the data the API accepts and returns. The most detailed are LISConsignmentHead20DTO (58 properties), LISExpConsignmentHead20DTO (54 properties), LISTransportHead20DTO (52 properties), LISOrderItem20DTO (50 properties). Each schema is shown below with its type and property counts.

LISMODocumentCategoryDTO
object
A single binary document category.
1 property
LISExpConsignmentHead20DTO
object
The consignment header data to be sent to a partner system.
54 properties
LISHandlingUnitWrapper20DTO
object
DTO that bundles a handling unit together to documents.
3 properties
LISHUTrackingEventExternalTargetDateDTO
object
DTO containing the event code of a milestone and new target date for this milestone. Additionally a reference to a transport as it is connected to a handling u…
3 properties
LISEventCodeListHeadDTO
object
Header data of the event code list.
2 properties
LISExpConsignmentList20DTO
object
A list of consignments e.g. as result of a search.
2 properties
LISTransport20DTO
object
A transport message sent by the supplier or buyer. It is usually sent to a forwarder to request the transportation of goods. Version 2.0
5 properties
LISExpOrderItem20DTO
object
An item of a purchase order.
38 properties
LISExpTrackingEvent20DTO
object
DTO to export trackingevent data to partner systems like the Message Engine Logistics.
22 properties
LISDurationDTO
object
DTO for Duration
3 properties
LISFileSystemSettingsReferenceDTO
object
The reference to file system storage settings in the VCP
2 properties
TargetTimeCalculationPlanStepHandlingDTO
object
Handling data of a target time calculation step
2 properties
GetDocumentCategoriesResponseDTO
object
Response for a document categories request.
5 properties
LISRequestIdentification20DTO
object
DTO suppliying the identification information for making requests.
3 properties 3 required
LISOrder20DTO
object
DTO for order messages Version 2.0
7 properties
LISArchiveDocumentDTO
object
DTO for document data that has been stored in an archive system e.g. Assist4ContentStorage and shall be accessed via VCP
8 properties
LISOrderFulfillmentPlan20DTO
object
DTO representing an order fulfillment plan
4 properties
LISTrackingObjectDocuments20DTO
object
A document message for a tracking object.
5 properties
LISHandlingUnitReceiveRequest20DTO
object
RequestDTO for handling of handling units, used in ILISBF20.
4 properties
LISUniqueConsignmentRequest20DTO
object
DTO with parameters to request details for a specific consignment
3 properties
LISAreaDependScheduleFilterLCHandlingDTO
object
DTO for handling AreaDependScheduleFilters
7 properties
LISEventDefinitionRequest20DTO
object
Contains alle fields that are necessary to return a collection of LISEventDefinition20DTO's
3 properties
LISExpMODocumentCategoryIdentifierDTO
object
A unique identifier for a document category.
1 property
LISTransportUnit20DTO
object
A transport unit message send by a partner.
4 properties
LISTrackingObjectFilterLCStorageDTO
object
DTO for TOFLCStorage. Not for the location: Only 'countryISOCode', 'globLocationNo', and 'postcodeStreet' are relevant for the filter.
2 properties
TargetTimeCalculationPlanResultDTO
object
Result of a target time calculation
7 properties
LISDimensionsDTO
object
DTO for Dimensions length, width, height and a quantity unit.
4 properties
GetDocumentCategoriesRequestDTO
object
Response for a document categories request.
4 properties
LISPhysicalTransport20DTO
object
Phyiscal transport message.
7 properties
DateAndZoneDTO
object
Date and timezone.
2 properties
LISExpConsignmentListEntry20DTO
object
An entry in a consignment list e.g. retrieved by a search request. A consignment list entry is similar to a consignment head DTO, but contains only a small sub…
4 properties
LISConsignmentSyncRequestDTO
object
Request DTO for consignment synchronization.
6 properties
LISExpMODocumentCategoryTextDTO
object
Texts for a document category
3 properties 1 required
LISConsignmentWithTransports20DTO
object
DTO for a consignment with all transports.
10 properties
LISPeriodicStartScheduleDTO
object
DTO for Peridodic start schedules
3 properties
LISTrackingObjectFilterHandlingUnitDTO
object
DTO for CTOFHandlingUnit.
3 properties
LISExpHandlingUnitHazardousGoodsData20DTO
object
DTO that contains hazardous goods data.
2 properties
LISExpHUTransportLeg20DTO
object
DTO to export handling unit transport data to partner systems like the Message Engine Logistics.
37 properties
LISCESDocumentDTO
object
DTO for document data that has been stored in a CES partner server and shall be accessed via VCP
11 properties
LISAreaDependScheduleFilterOrderItemDTO
object
DTO for order item AreaDependScheduleFilters
7 properties
LISTrackingEventReferenceField20DTO
object
DTO for a single reference field with fieldName and the number
2 properties
LISOrderHead20DTO
object
The head of a order. Information in the head applies to all items, unless corresponding item fields are not null, i.e. explicitly different from the head. An o…
31 properties
LISTextTranslationItemDTO
object
DTO for a single text translation. E.g. the german translation of a material description.
2 properties
TargetTimeCalculationResponseDTO
object
Response of a target time calculation
6 properties
LISTrackingObjectEventRequest20DTO
object
DTO with parameters to request the tracking events for a specific tracking object
2 properties
LISMaterialMasterFileHeadDTO
object
DTO for the material master file items.
30 properties 1 required
LISAreaDependScheduleFilterOrderDTO
object
DTO for order AreaDependScheduleFilters
7 properties
LISPartyShortDTO
object
Data transfer object to denote parties, e.g. buyer or seller, without address data.
5 properties
GetMODocumentResponseDTO
object
Data Transfer Object for a get document result.
5 properties
LISTransportHead20DTO
object
DTO for transport legs.
52 properties
LISTrackingEventExportRequest20DTO
object
The request DTO for a tracking event export
8 properties 1 required
GetMODocumentRequestDTO
object
Data transfer object to request one or several documents.
5 properties 1 required
LISTextTranslationDTO
object
DTO for text translations.
1 property
LISTrackingEvent20DTO
object
DTO for Tracking events (envelope)
7 properties
LISHazardousGoodsItem20DTO
object
This DTO describes a hazardous goods item.
36 properties
LISTrackingObjectFilterConsignmentDTO
object
DTO for TOFConsignment
14 properties
LISExpMODocumentCategoryDTO
object
A single document category.
2 properties
TargetTimeCalculationPlanResultStepDTO
object
A single step of a target time calculation, identifiable by sequence number or host code
6 properties
LISAreaDependScheduleFilterLCStorageDTO
object
DTO for storage AreaDependScheduleFilters
7 properties
LISConsignmentHead20DTO
object
Header data of the consignment. Valid for all items unless redefined there. Version 2.0 Renamed fields compared to 1.0: suppliersRefNumberForwarder = shipperRe…
58 properties
LISLocationDTO
object
DTO for a location.
6 properties
LISTimeDTO
object
Contains a time.
1 property
LISExpTrackingEventListEntry20DTO
object
The event header for the export to a partner system.
7 properties
LISMultiReferenceTrackingObjectDocuments20DTO
object
A document message for multiple tracking objects. @see LISTrackingObjectDocuments20DTO
5 properties
TargetTimeCalculationDiagnosisLogDTO
object
Diagnosis log data of a plan, identified by hostcode
2 properties
LISHandlingUnitHazardousGoodsData20DTO
object
DTO that contains hazardous goods data.
2 properties
LISPhysicalTransportHead20DTO
object
DTO for physical transport.
33 properties
TargetTimeCalculationPlanStepTransportDTO
object
Transport data of a target time calculation step
7 properties
LISTrackingObjectReference20DTO
object
DTO for reference numbers. Every DTO should have all information to find a specific object of a certain class.
2 properties
ResponseMessageDTO
object
Result messages like errors or warnings.
4 properties
LISExpConsignmentItem20DTO
object
The consignment item data to be sent to a partner system
40 properties
LISTrackingEventExternalTargetDateDTO
object
DTO containing the event code of a milestone and new target date for this milestone.
2 properties
LISExpStatus20DTO
object
DTO to export status data
4 properties
LISOFSTransport20DTO
object
DTO containing the data for an order fulfillment step of type transport
6 properties
LISExpHandlingUnit20DTO
object
The handling unit data to be sent to a partner system
26 properties
LISTrackingObjectFilterOrderDTO
object
DTO for CTOFOrder
3 properties
LISMaterialDTO
object
DTO which references a material
19 properties
LISTrackingObjectReferenceField20DTO
object
DTO for a single reference field with fieldName and the number
2 properties
LISBinaryRoleDTO
object
A single binary role.
1 property
LISConsignmentItem20DTO
object
This DTO describes a consignment item.
45 properties
LISAreaDependScheduleFilterTransportDTO
object
DTO for transport AreaDependScheduleFilters
7 properties
LISBinaryDTO
object
DTO for binaries e.g. document, images.
7 properties
LISDayTypeScheduleDTO
object
DTO for day type schedules.
5 properties
LISOrderItem20DTO
object
An item of an order.
50 properties
LISFileSystemDocumentDTO
object
DTO for document data which has already been stored in the file system
9 properties
LISEventCodeListEntryDTO
object
This DTO describes a eventCodeList entry.
3 properties
LISQuantityDTO
object
DTO denoting a quantity
4 properties
LISTrackingEventReference20DTO
object
DTO for reference numbers. Every DTO should have all informations to find one or more TrackingObjects of a certain class. To find the matching tracking object…
3 properties
TargetTimeCalculationRequestDTO
object
Request for target time calculation of multiple plans.
6 properties
LISWarehouseDTO
object
DTO denoting a particular warehouse
8 properties
LISTrackingObjectFilterOrderItemDTO
object
DTO for CTOFOrderItem
10 properties
LISAreaDependScheduleHeadDTO
object
DTO for main data of TTCSAreaDependSchedule.
9 properties
LISExpOrderHead20DTO
object
The head of a order. Information in the head applies to all items, unless corresponding item fiels are not null, i.e. explicitly different from the head.
20 properties
LISPartyDTO
object
Data transfer object to denote parties, e.g. buyer, seller, with full address data.
17 properties
LISEventDefinition20DTO
object
Event Definition data
4 properties
LISOrderFulfillmentStep20DTO
object
Abstract DTO as a superclass for classes representing steps in an order fulfillment plan
7 properties
LISTrackingEventUpdateField20DTO
object
Class to hold values for updates of the tracking objects generically with fieldname
2 properties
LISExpConsignment20DTO
object
DTO to export consignment data to partner systems like the Message Engine Logistics.
11 properties
LISDateAndZoneDTO
object
Contains a date and a timezone.
2 properties
LISTransportTypeDTO
object
DTO for transport types
1 property
TextInLanguageDTO
object
A translated text in one of the specified languages.
2 properties
LISExpDocumentMetadata20DTO
object
DTO to provide the meta data of documents that are connected to the higher level structure.
6 properties
LISMessageMetaDataDTO
object
Meta data of a message
9 properties 7 required
LISExpMODocument20DTO
object
DTO to export document data to partner systems like the Message Engine Logistics. @see LISBinaryDTO
6 properties
LISTrackingObjectFilterTransportDTO
object
DTO for CTOFTransportLeg
11 properties
LISTrackingEventHead20DTO
object
DTO for main tracking event data
10 properties
LISAdditionalFieldDTO
object
DTO to implement additional fields not found in the standard DTOs The fields can have any name or value, but the target system must know how to handle these fi…
2 properties
LISConsignmentReferenceWithClientDTO
object
Reference fields for identifying a LISConsignment.
3 properties
LISOrderFulfillmentRequest20DTO
object
DTO for order fulfillment plan requests. Version 2.0
6 properties
LISMeansOfTransportDTO
object
DTO for means of transports.
5 properties
LISServiceTypeDTO
object
DTO denoting a serivce type of forwarders
2 properties
LISTermsOfDeliveryDTO
object
Describes terms of delivery.
4 properties
LISAmountOfMoneyDTO
object
An amount of mone with a value and a currency
5 properties
LISQuickSearchRequest20DTO
object
The request parameters for a quick search.
4 properties 2 required
LISTransportUnitHead20DTO
object
DTO for transport units
33 properties
LISPartyLongDTO
object
Data transfer object for parties that contain contact information
18 properties
LISOrderFulfillmentResult20DTO
object
Result DTO for an order fulfillment request
1 property
LISAreaDependScheduleFilterConsignmentDTO
object
DTO for consignment AreaDependScheduleFilters
7 properties
LISHandlingUnitExt20DTO
object
Extension class for LISHandlingUnit20DTO that adds additional fields so that the resulting LISHandlingUnitExt20DTO can be used stand alone and independent from…
45 properties
LISExpQuickSearchResult20DTO
object
Contains the result of a quick search.
7 properties
LISHandlingUnit20DTO
object
This DTO describes a handling unit as send e.g. with the EANCOM message DESADV.
28 properties
LISTrackingEventList20DTO
object
DTO to receive a list of tracking events
5 properties
LISExpTransportHead20DTO
object
DTO to export transport data to partner systems like the Message Engine Logistics.
48 properties
LISAreaDependScheduleFilterHandlingUnitDTO
object
DTO for handling unit AreaDependScheduleFilters
7 properties
LISExpConsItemInHandlingUnit20DTO
object
DTO to export consigment item in handling units data to partner systems like the Message Engine Logistics.
3 properties
LISTrackingObjectFilterLCHandlingDTO
object
DTO for TOFLCHandling. Note for the location: Only 'countryISOCode', 'globLocationNo', and 'postcodeStreet' are relevant for the filter.
2 properties
LISEventCodeListDTO
object
DTO for an event code list
3 properties
LISConsignmentSyncResponseDTO
object
Data Transfer Object for a consignment synchronize result.
7 properties
TargetTimeCalculationPlanStepDTO
object
A step of a target time calculation plan
5 properties
LISConsItemInHandlingUnit20DTO
object
This DTO connects a consignment and handling unit. This means that the consignment item can be found in the defined handling unit.
5 properties
LISExpTrackingEventList20DTO
object
A list of exported LISExpTrackingEventListEntry20DTO's
2 properties
LISExpTrackingObjectEventList20DTO
object
DTO to export the events of a tracking object to partner systems like the Message Engine Logistics.
1 property
LISEquipmentTypeDTO
object
DTO for equipment types
2 properties
LISExpHazardousGoodsItem20DTO
object
This DTO describes a hazardous goods item.
36 properties
LISExpTrackingInfo20DTO
object
DTO to deliver tracking information for a tracking object
7 properties
LISConsignment20DTO
object
DTO for consigment messages Version 2.0
9 properties
TargetTimeCalculationPlanDTO
object
A plan for a target time calculation. A plan represents a route or a chain of steps that will be calculated successively.
6 properties 1 required
GetMODocumentDTO
object
Data transfer object for a document.
9 properties
ContactDTO
object
Contains data for contacting a person.
4 properties
LISAreaDependScheduleDTO
object
DTO for TTCSAreaDependSchedule.
3 properties
LISConsignmentRequest20DTO
object
DTO with parameters to request a list of consignments
10 properties 3 required
LISDespatchTypeDTO
object
DTO for the despatch type.
2 properties
LISMaterialMasterFileDTO
object
DTO for the master file materials.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

aeb-lisbf20bean-api-openapi.yml Raw ↑

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
Where this information came from

This is an independent, third-party profile of AEB LISBF20 Bean 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.