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 Shipment Objectives API

Rest API to get shipment objectives

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

Tagged areas include ShipmentObjectives. 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 1 operation across 1 path, and defines 34 schemas. It is described by OpenAPI 3.2.0, at version 3.0.

Requests are made against a single base URL, https://rz3.aeb.de/demo1cai/rest.

1 operations 1 paths 34 schemas 1 POST

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 2

AEB Shipment Objectives 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 1

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

ShipmentObjectives 1

Rest API to get shipment objectives

POST
/shipment-objectives
Returns objectives for the posted shipment data.
getShipmentObjectives body → 200

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are DLShipmentRequestDataDTO (93 properties), DLHazardousGoodsItemRequestDataDTO (37 properties), DLPackageRequestDataDTO (26 properties), DLPartyDTO (19 properties). Each schema is shown below with its type and property counts.

DLMustBeFilledDTO
object
The data for fields that must be filled.
2 properties
DLShipmentCarrierInfoTextDTO
object
DTO specifying a carrier's info text for a shipment.
2 properties 1 required
DLPackageCumulationRequestDataDTO
object
DTO for package cumulation data.
7 properties 2 required
DLShipmentObjectivePathSegmentDTO
object
The path of the objective.
2 properties
DLPackageHazardousGoodsDataRequestDTO
object
Holds hazardous goods data concerning the package.
3 properties 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
DLPossibleValuesDTO
object
A possible value for the interface.
1 property
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
ShipmentObjective
object
All accessible data of an Objective.
5 properties
DLPartyDTO
object
DLPartyDTO containing address data
19 properties
DLShipmentItemReferenceDTO
object
DTO for uniquely identifying an item within a shipment.
5 properties 1 required
GetShipmentObjectivesRequest
object
Determine the objectives of a shipment.
2 properties 1 required
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
GetShipmentObjectivesResponse
object
The determined objectives of a shipment.
2 properties
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
DLInvalidValueDTO
object
The data for fields with invalid values.
3 properties
DLObjectiveTextsDTO
object
Info texts of the objective.
4 properties
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
DLShipmentReferenceDTO
object
DTO for uniquely identifying a DLShipment within a specific client.
3 properties
DLPersonDTO
object
DLPersonDTO containing contact data.
4 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
DLShipmentRequestDataDTO
object
DTO for shipment data in a request.
93 properties 9 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

aeb-shipmentobjectives-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 Shipment Objectives 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.