AEB

AEB Shipping API

API for the CarrierEngine service

GitHub OpenAPI

Operations 21

POST /DLCarrierBFBean/addShipmentAttachments addShipmentAttachments #
POST /DLCarrierBFBean/cancelShipment cancelShipment #
POST /DLCarrierBFBean/createPickup createPickup #
POST /DLCarrierBFBean/createShipment createShipment #
POST /DLCarrierBFBean/deleteItem deleteItem #
POST /DLCarrierBFBean/deletePackage deletePackage #
POST /DLCarrierBFBean/deletePickup deletePickup #
POST /DLCarrierBFBean/getAllCarriers getAllCarriers #
POST /DLCarrierBFBean/getCarrierPortfolioNames getCarrierPortfolioNames #
POST /DLCarrierBFBean/getCarrierPortfolioDetails getCarrierPortfolioDetails #
POST /DLCarrierBFBean/getCarrierProperties getCarrierProperties #
POST /DLCarrierBFBean/getPickups getPickups #
POST /DLCarrierBFBean/getShipments getShipments #
POST /DLCarrierBFBean/processPackage processPackage #
POST /DLCarrierBFBean/processPackageReturnEnclosedLabel processPackageReturnEnclosedLabel #
POST /DLCarrierBFBean/processPickup processPickup #
POST /DLCarrierBFBean/processShipment processShipment #
POST /DLCarrierBFBean/syncPickups syncPickups #
POST /DLCarrierBFBean/syncShipments syncShipments #
POST /DLCarrierBFBean/updateCustomsData updateCustomsData #
POST /DLCarrierBFBean/validateShipment validateShipment #

Documentation

📖
Documentation
https://customsmanagement.docs.developers.aeb.com/
📖
APIReference
https://customsmanagement.docs.developers.aeb.com/reference/how-to-use-the-api-reference
📖
GettingStarted
https://customsmanagement.docs.developers.aeb.com/docs/your-first-consignment
📖
Documentation
https://customsmanagement.docs.developers.aeb.com/docs/about-product-classification
📖
Documentation
https://trade-compliance.docs.developers.aeb.com/
📖
APIReference
https://trade-compliance.docs.developers.aeb.com/reference/compliance-foundation
📖
GettingStarted
https://trade-compliance.docs.developers.aeb.com/docs/accessing-the-rest-services
📖
Documentation
https://transport-freight-management.docs.developers.aeb.com/
📖
APIReference
https://transport-freight-management.docs.developers.aeb.com/reference/shipping
📖
APIReference
https://transport-freight-management.docs.developers.aeb.com/reference/createroutingtask
📖
APIReference
https://transport-freight-management.docs.developers.aeb.com/reference/getshipmentsevents
📖
Documentation
https://transport-freight-management.docs.developers.aeb.com/docs/carrier-event-service/llms.txt
📖
APIReference
https://transport-freight-management.docs.developers.aeb.com/reference/getbillingscenario
📖
Documentation
https://transport-freight-management.docs.developers.aeb.com/docs/logistics-cost-management/llms.txt
📖
APIReference
https://transport-freight-management.docs.developers.aeb.com/reference/getworkstations
📖
Documentation
https://transport-freight-management.docs.developers.aeb.com/docs/document-service/llms.txt
📖
Documentation
https://sap-plugins.docs.developers.aeb.com/

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/aeb/refs/heads/main/openapi/aeb-shipping-api-openapi.yml

SDKs

📦
GitHubRepository
https://github.com/AEB-labs/docs-trade-compliance
📦
GitHubRepository
https://github.com/AEB-labs/docs-transport-freight-management
📦
GitHubRepository
https://github.com/AEB-labs/docs-bsm

Other Resources

🔗
ChangeLog
https://customsmanagement.docs.developers.aeb.com/changelog
🔗
SOAP
https://rz3.aeb.de/test2ici/servlet/bf
🔗
SOAP
https://rz3.aeb.de/test2cim/servlet/bf
🔗
SOAP
https://rz3.aeb.de/test2broker/servlet/bf
🔗
SOAP
https://rz3.aeb.de/test2cl/servlet/bf
🔗
Pricing
https://www.aeb.com/en/carrier-connect/carrier-connect-api.php
🔗
Integrations
https://www.aeb.com/en/carrier-connect/all-transport-service-providers-carriers.php

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/aeb-shipping-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

aeb-shipping-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Aeb Shipping API
  version: '1.0'
  description: 'Operations tagged Shipping across 2 of this provider''s published API definitions: aeb-bsm-openapi.json, aeb-carrier-connect-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://rz3.aeb.de/test2bsm/rest
- url: https://rz3.aeb.de/demo1cai/rest
security:
- SWAGGER_AUTH_KEY: []
- BASIC_AUTH: []
tags:
- name: Shipping
  description: API for the CarrierEngine service
paths:
  /DLCarrierBFBean/addShipmentAttachments:
    servers:
    - url: https://rz3.aeb.de/test2bsm/rest
    post:
      tags:
      - Shipping
      summary: addShipmentAttachments
      description: Adds attachments to a shipment (e.g. invoices, origin documents, etc.).
      operationId: addShipmentAttachments
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DLAddShipmentAttachmentsRequestDTO'
          application/xml:
            schema:
              $ref: '#/components/schemas/DLAddShipmentAttachmentsRequestDTO'
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DLAddShipmentAttachmentsResponseDTO'
            application/xml:
              schema:
                $ref: '#/components/schemas/DLAddShipmentAttachmentsResponseDTO'
      security:
      - BASIC_AUTH: []
  /DLCarrierBFBean/cancelShipment:
    servers:
    - url: https://rz3.aeb.de/test2bsm/rest
    post:
      tags:
      - Shipping
      summary: cancelShipment
      description: Cancels a shipment.
      operationId: cancelShipment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DLCancelShipmentRequestDTO'
          application/xml:
            schema:
              $ref: '#/components/schemas/DLCancelShipmentRequestDTO'
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DLCancelShipmentResponseDTO'
            application/xml:
              schema:
                $ref: '#/components/schemas/DLCancelShipmentResponseDTO'
      security:
      - BASIC_AUTH: []
  /DLCarrierBFBean/createPickup:
    servers:
    - url: https://rz3.aeb.de/test2bsm/rest
    post:
      tags:
      - Shipping
      summary: createPickup
      description: Creates a new pickup for the shipments specified in the request.<br> Depending on the request, an error may be returned when the shipments can't form a single pickup, e.g. when they have different carriers.<br> Optionally the new pickup can be manifested. That means that the EDI is sent to the carrier if necessary and the pickup will be closed.<br> When specified in request, the manifest documents are printed.
      operationId: createPickup
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DLCreatePickupRequestDTO'
          application/xml:
            schema:
              $ref: '#/components/schemas/DLCreatePickupRequestDTO'
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DLCreatePickupResponseDTO'
            application/xml:
              schema:
                $ref: '#/components/schemas/DLCreatePickupResponseDTO'
      security:
      - BASIC_AUTH: []
  /DLCarrierBFBean/createShipment:
    servers:
    - url: https://rz3.aeb.de/test2bsm/rest
    post:
      tags:
      - Shipping
      summary: createShipment
      description: Creates a shipment with the data specified in the shipment request.<br> An error will be returned when the shipment exists already.<br> Optionally various operations like label preparation and label output can be applied on the shipment. A complete processing including the pickup assignment is also possible.<br> The operations are handled asynchronously, so operation processing errors and label documents are not part of the response. They can be retrieved with a <code>syncShipments</code> or <code>getShipments</code> call.
      operationId: createShipment_1
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DLCreateShipmentRequestDTO'
          application/xml:
            schema:
              $ref: '#/components/schemas/DLCreateShipmentRequestDTO'
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DLCreateShipmentResponseDTO'
            application/xml:
              schema:
                $ref: '#/components/schemas/DLCreateShipmentResponseDTO'
      security:
      - BASIC_AUTH: []
  /DLCarrierBFBean/deleteItem:
    servers:
    - url: https://rz3.aeb.de/test2bsm/rest
    post:
      tags:
      - Shipping
      summary: deleteItem
      description: Deletes an existing item. Packages containing items remain in the shipment and can be packed again with processShipment. Deleting a item is not always possible. It mainly depends on the status of the package containing the item and the shipment.
      operationId: deleteItem
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DLDeleteItemRequestDTO'
          application/xml:
            schema:
              $ref: '#/components/schemas/DLDeleteItemRequestDTO'
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DLDeleteItemResponseDTO'
            application/xml:
              schema:
                $ref: '#/components/schemas/DLDeleteItemResponseDTO'
      security:
      - BASIC_AUTH: []
  /DLCarrierBFBean/deletePackage:
    servers:
    - url: https://rz3.aeb.de/test2bsm/rest
    post:
      tags:
      - Shipping
      summary: deletePackage
      description: Deletes an existing package. Packed items remain unpacked in the shipment and can be packaged again with processShipment. Deleting a package is not always possible. It mainly depends on the status of the package and the shipment.
      operationId: deletePackage
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DLDeletePackageRequestDTO'
          application/xml:
            schema:
              $ref: '#/components/schemas/DLDeletePackageRequestDTO'
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DLDeletePackageResponseDTO'
            application/xml:
              schema:
                $ref: '#/components/schemas/DLDeletePackageResponseDTO'
      security:
      - BASIC_AUTH: []
  /DLCarrierBFBean/deletePickup:
    servers:
    - url: https://rz3.aeb.de/test2bsm/rest
    post:
      tags:
      - Shipping
      summary: deletePickup
      description: 'Cancels an existing pickup. All shipments are removed from the pickup and must be assigned to a new pickup by another <code>createPickup</code> call.<br> Warning: EDI data for the existing pickup might have already been sent to the carrier. So check with the carrier that it''s fine to cancel the pickup and create a new (differing) one.'
      operationId: deletePickup
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DLDeletePickupRequestDTO'
          application/xml:
            schema:
              $ref: '#/components/schemas/DLDeletePickupRequestDTO'
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DLDeletePickupResponseDTO'
            application/xml:
              schema:
                $ref: '#/components/schemas/DLDeletePickupResponseDTO'
      security:
      - BASIC_AUTH: []
  /DLCarrierBFBean/getAllCarriers:
    servers:
    - url: https://rz3.aeb.de/test2bsm/rest
    post:
      tags:
      - Shipping
      summary: getAllCarriers
      description: Returns a list of all carrier available for the requested client.
      operationId: getAllCarriers
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DLGetAllCarriersRequestDTO'
          application/xml:
            schema:
              $ref: '#/components/schemas/DLGetAllCarriersRequestDTO'
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DLGetAllCarriersResponseDTO'
            application/xml:
              schema:
                $ref: '#/components/schemas/DLGetAllCarriersResponseDTO'
      security:
      - BASIC_AUTH: []
  /DLCarrierBFBean/getCarrierPortfolioNames:
    servers:
    - url: https://rz3.aeb.de/test2bsm/rest
    post:
      tags:
      - Shipping
      summary: getCarrierPortfolioNames
      description: Returns a list of the names of all supported carriers.
      operationId: getCarrierPortfolioDetails
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DLGetCarrierPortfolioDetailsRequestDTO'
          application/xml:
            schema:
              $ref: '#/components/schemas/DLGetCarrierPortfolioDetailsRequestDTO'
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DLGetCarrierPortfolioDetailsResponseDTO'
            application/xml:
              schema:
                $ref: '#/components/schemas/DLGetCarrierPortfolioDetailsResponseDTO'
      security:
      - BASIC_AUTH: []
  /DLCarrierBFBean/getCarrierPortfolioDetails:
    servers:
    - url: https://rz3.aeb.de/test2bsm/rest
    post:
      tags:
      - Shipping
      summary: getCarrierPortfolioDetails
      description: Returns detailed information about the requested carriers.
      operationId: getCarrierPortfolioNames
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DLGetCarrierPortfolioNamesRequestDTO'
          application/xml:
            schema:
              $ref: '#/components/schemas/DLGetCarrierPortfolioNamesRequestDTO'
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DLGetCarrierPortfolioNamesResponseDTO'
            application/xml:
              schema:
                $ref: '#/components/schemas/DLGetCarrierPortfolioNamesResponseDTO'
      security:
      - BASIC_AUTH: []
  /DLCarrierBFBean/getCarrierProperties:
    servers:
    - url: https://rz3.aeb.de/test2bsm/rest
    post:
      tags:
      - Shipping
      summary: getCarrierProperties
      description: Returns the properties of the requested carrier.
      operationId: getCarrierProperties
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DLGetCarrierPropertiesRequestDTO'
          application/xml:
            schema:
              $ref: '#/components/schemas/DLGetCarrierPropertiesRequestDTO'
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DLGetCarrierPropertiesResponseDTO'
            application/xml:
              schema:
                $ref: '#/components/schemas/DLGetCarrierPropertiesResponseDTO'
      security:
      - BASIC_AUTH: []
  /DLCarrierBFBean/getPickups:
    servers:
    - url: https://rz3.aeb.de/test2bsm/rest
    post:
      tags:
      - Shipping
      summary: getPickups
      description: Returns detail information about specific pickups.
      operationId: getPickups
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DLGetPickupsRequestDTO'
          application/xml:
            schema:
              $ref: '#/components/schemas/DLGetPickupsRequestDTO'
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DLGetPickupsResponseDTO'
            application/xml:
              schema:
                $ref: '#/components/schemas/DLGetPickupsResponseDTO'
      security:
      - BASIC_AUTH: []
  /DLCarrierBFBean/getShipments:
    servers:
    - url: https://rz3.aeb.de/test2bsm/rest
    post:
      tags:
      - Shipping
      summary: getShipments
      description: Returns detail information about specific shipments.
      operationId: getShipments
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DLGetShipmentsRequestDTO'
          application/xml:
            schema:
              $ref: '#/components/schemas/DLGetShipmentsRequestDTO'
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DLGetShipmentsResponseDTO'
            application/xml:
              schema:
                $ref: '#/components/schemas/DLGetShipmentsResponseDTO'
      security:
      - BASIC_AUTH: []
  /DLCarrierBFBean/processPackage:
    servers:
    - url: https://rz3.aeb.de/test2bsm/rest
    post:
      tags:
      - Shipping
      summary: processPackage
      description: Allows to perform various operations on an existing package. Especially document preparation and document (label) output can be triggered.<br> When the request is specified to handle the operations asynchronously, operation processing errors and label documents are not part of the response. They can be retrieved with a further <code>processPackage</code> call, a <code>syncShipments</code> or <code>getShipments</code> call.
      operationId: processPackage
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DLProcessPackageRequestDTO'
          application/xml:
            schema:
              $ref: '#/components/schemas/DLProcessPackageRequestDTO'
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DLProcessPackageResponseDTO'
            application/xml:
              schema:
                $ref: '#/components/schemas/DLProcessPackageResponseDTO'
      security:
      - BASIC_AUTH: []
  /DLCarrierBFBean/processPackageReturnEnclosedLabel:
    servers:
    - url: https://rz3.aeb.de/test2bsm/rest
    post:
      tags:
      - Shipping
      summary: processPackageReturnEnclosedLabel
      description: Returns a return enclosed label in case of a return shipment.
      operationId: processPackageReturnEnclosedLabel
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DLProcessPackageReturnEnclosedLabelRequestDTO'
          application/xml:
            schema:
              $ref: '#/components/schemas/DLProcessPackageReturnEnclosedLabelRequestDTO'
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DLProcessPackageReturnEnclosedLabelResponseDTO'
            application/xml:
              schema:
                $ref: '#/components/schemas/DLProcessPackageReturnEnclosedLabelResponseDTO'
      security:
      - BASIC_AUTH: []
  /DLCarrierBFBean/processPickup:
    servers:
    - url: https://rz3.aeb.de/test2bsm/rest
    post:
      tags:
      - Shipping
      summary: processPickup
      description: Prints or reprints the manifest documents for the pickup. Mainly to be used, when manifest documents were not printed with the <code>createPickup</code> call or if a reprint of the documents is necessary.
      operationId: processPickup
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DLProcessPickupRequestDTO'
          application/xml:
            schema:
              $ref: '#/components/schemas/DLProcessPickupRequestDTO'
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DLProcessPickupResponseDTO'
            application/xml:
              schema:
                $ref: '#/components/schemas/DLProcessPickupResponseDTO'
      security:
      - BASIC_AUTH: []
  /DLCarrierBFBean/processShipment:
    servers:
    - url: https://rz3.aeb.de/test2bsm/rest
    post:
      tags:
      - Shipping
      summary: processShipment
      description: Allows to add packages or perform various operations on an existing shipment. Especially document preparation and document (label) output can be triggered.<br> When the request is specified to handle the operations asynchronously, operation processing errors and label documents are not part of the response. They can be retrieved with a <code>syncShipments</code> or <code>getShipments</code> call.
      operationId: processShipment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DLProcessShipmentRequestDTO'
          application/xml:
            schema:
              $ref: '#/components/schemas/DLProcessShipmentRequestDTO'
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DLProcessShipmentResponseDTO'
            application/xml:
              schema:
                $ref: '#/components/schemas/DLProcessShipmentResponseDTO'
      security:
      - BASIC_AUTH: []
  /DLCarrierBFBean/syncPickups:
    servers:
    - url: https://rz3.aeb.de/test2bsm/rest
    post:
      tags:
      - Shipping
      summary: syncPickups
      description: Allows the synchronization of client system transactions with the engine pickups. By the use of a syncId it is possible to return only pickups that have changed between two syncPickups calls.
      operationId: syncPickups
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DLSyncPickupsRequestDTO'
          application/xml:
            schema:
              $ref: '#/components/schemas/DLSyncPickupsRequestDTO'
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DLSyncPickupsResponseDTO'
            application/xml:
              schema:
                $ref: '#/components/schemas/DLSyncPickupsResponseDTO'
      security:
      - BASIC_AUTH: []
  /DLCarrierBFBean/syncShipments:
    servers:
    - url: https://rz3.aeb.de/test2bsm/rest
    post:
      tags:
      - Shipping
      summary: syncShipments
      description: Allows the synchronization of client system transactions with the engine shipments. By the use of a syncId it is possible to return only shipments that have changed between two syncShipments calls.
      operationId: syncShipments
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DLSyncShipmentsRequestDTO'
          application/xml:
            schema:
              $ref: '#/components/schemas/DLSyncShipmentsRequestDTO'
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DLSyncShipmentsResponseDTO'
            application/xml:
              schema:
                $ref: '#/components/schemas/DLSyncShipmentsResponseDTO'
      security:
      - BASIC_AUTH: []
  /DLCarrierBFBean/updateCustomsData:
    servers:
    - url: https://rz3.aeb.de/test2bsm/rest
    post:
      tags:
      - Shipping
      summary: updateCustomsData
      description: Updates customs data for one existing shipment. Updates data on shipment and item level. Updates customs relevant data only.
      operationId: updateCustomsData
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DLUpdateCustomsDataRequestDTO'
          application/xml:
            schema:
              $ref: '#/components/schemas/DLUpdateCustomsDataRequestDTO'
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DLUpdateCustomsDataResponseDTO'
            application/xml:
              schema:
                $ref: '#/components/schemas/DLUpdateCustomsDataResponseDTO'
      security:
      - BASIC_AUTH: []
  /DLCarrierBFBean/validateShipment:
    servers:
    - url: https://rz3.aeb.de/test2bsm/rest
    post:
      tags:
      - Shipping
      summary: validateShipment
      description: Validates a shipment with the data specified in the shipment request.<br> Various validation operations can be applied on the shipment to determine, whether the shipment can be processed.
      operationId: validateShipment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DLValidateShipmentRequestDTO'
          application/xml:
            schema:
              $ref: '#/components/schemas/DLValidateShipmentRequestDTO'
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DLValidateShipmentResponseDTO'
            application/xml:
              schema:
                $ref: '#/components/schemas/DLValidateShipmentResponseDTO'
      security:
      - BASIC_AUTH: []
components:
  schemas:
    DLShipmentCarrierInfoTextDTO:
      required:
      - identCode
      type: object
      properties:
        identCode:
          type: string
          description: Carrier info text ident code.<br> <p>length=20</p>
        parameter:
          type: string
          description: An (optional) parameter for the info text.  <p> length=512 </p>
      description: DTO specifying a carrier's info text for a shipment.
    DLGetAllCarriersRequestDTO:
      type: object
      properties:
        clientSystemId:
          type: string
          description: '<p>Id of the sending client system.</p><p>e.g. Installation ID of the sending host or ERP system.</p><p>Maximum length: 20</p>'
          example: TEST_ID
        clientIdentCode:
          type: string
          description: '<p>Client identification code.</p><p>Maximum length: 10</p>'
          example: APITEST
        userName:
          type: string
          description: <p>User who initiated the request from the client system.</p><p>If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.</p><p>If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.</p><p>Actual authentication is handled separately via the request's headers, so no password is required in the request's data.</p>
          example: API_TEST
        resultLanguageIsoCodes:
          type: array
          description: <p>2-letter ISO codes of the languages in which texts will be returned.</p><p>English ('en') and German ('de') are typically supported by default. Other languages may be supported.</p><p>Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.</p>
          example:
          - en
          - de
          items:
            type: string
            description: <p>2-letter ISO codes of the languages in which texts will be returned.</p><p>English ('en') and German ('de') are typically supported by default. Other languages may be supported.</p><p>Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.</p>
            example: '["en","de"]'
      description: Request DTO to retrieve the codes and names of all available carriers for a client.
      xml:
        name: getAllCarriersRequestDTO
    DLPackageCumulationRequestDataDTO:
      required:
      - numberOfPackages
      - packageTypeIdentCode
      type: object
      properties:
        numberOfPackages:
          type: integer
          description: The number of packages. <p> length=3 </p>
          format: int32
        packageTypeIdentCode:
          type: string
          description: IdentCode of the package type. Valid values are depending on the client's package types in the master file data. <p> length=20 </p>
        packageSpecificeContents:
          type: string
          description: The content description of the package. If left empty, the content description supplied in field 'contents' on shipment level will be used for this package. <p> length=250 </p>
        weight:
          $ref: '#/components/schemas/QuantityDTO'
        volume:
          $ref: '#/components/schemas/QuantityDTO'
        loadingMeters:
          type: number
          description: The loading meters needed for the packages. <p>length=10, scale=3</p>
        palletPlaces:
          type: number
          description: The pallet places needed for the packages. <p>length=10, scale=3</p>
      description: DTO for package cumulation data.
    DLAddShipmentAttachmentsRequestDTO:
      required:
      - shipmentReference
      type: object
      properties:
        clientSystemId:
          type: string
          description: '<p>Id of the sending client system.</p><p>e.g. Installation ID of the sending host or ERP system.</p><p>Maximum length: 20</p>'
          example: TEST_ID
        clientIdentCode:
          type: string
          description: '<p>Client identification code.</p><p>Maximum length: 10</p>'
          example: APITEST
        userName:
          type: string
          description: <p>User who initiated the request from the client system.</p><p>If the user is found either in the system's user management or in a connected LDAP directory, the request runs under this user's roles.</p><p>If the user is not found, the request is only granted the basic 'I_EVERYONE' role. The user name may be used for logging purposes in this case.</p><p>Actual authentication is handled separately via the request's headers, so no password is required in the request's data.</p>
          example: API_TEST
        resultLanguageIsoCodes:
          type: array
          description: <p>2-letter ISO codes of the languages in which texts will be returned.</p><p>English ('en') and German ('de') are typically supported by default. Other languages may be supported.</p><p>Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.</p>
          example:
          - en
          - de
          items:
            type: string
            description: <p>2-letter ISO codes of the languages in which texts will be returned.</p><p>English ('en') and German ('de') are typically supported by default. Other languages may be supported.</p><p>Translations will be looked up in the order of the provided language codes. If a translation is not available in one language, the next language is used instead.</p>
            example: '["en","de"]'
        shipmentReference:
          $ref: '#/components/schemas/DLShipmentReferenceDTO'
        mode:
          type: string
          description: 'Manages how the system should react if an attachment already exists. If empty mode ''ADD'' will be used. The filter criteria for an existing attachment is the file name and an existing content.<p> Possible values: <ul> <li> ADD</li> <li> UPDATE</li> <li> SKIP</li> </ul> </p>'
        attachments:
          type: array
          description: List of attachments to add.
          items:
            $ref: '#/components/schemas/DLAttachmentDTO'
      description: Request DTO for the addShipmentAttachments business facade method
      xml:
        name: addShipmentAttachmentsRequestDTO
    DLShipmentPickupEDIDTO:
      type: object
      properties:
        ediNumber:
          type: string
          description: <p>Unique number of EDI message.</p> <p>length = 25</p>
        ediDescription:
          type: string
          description: <p>Description of the EDI message (and of the EDI setup).</p> <p>length = 500</p>
        carrierEDINumber:
          type: string
          description: <p>Number uniquely identifying the EDI message for carrier.</p> <p>length = 50</p>
        isManifested:
          type: boolean
          description: <p>Indicates that the EDI message has been transmitted to the carrier.</p>
        isManifestedWithErrors:
          type: boolean
          description: <p>Indicates that an error occurred while transmitting the EDI message.</p>
        isManifestedWithWarnings:
          type: boolean
          description: <p>Indicates that warnings occurred while transmitting the EDI message. However, the EDI message has been accepted by the carrier. The reasons for the warnings should be corrected during the next transmissions.</p>
        unconfirmedErrorCode:
          type: string
          description: <p>If an error occurred while transmitting the EDI message and an error code was available, it is return in this field.</p> <p>length = 10</p>
        unconfirmedMessage:
          type: string
          description: <p>If an error occurred while transmitting the EDI message, its message is returned in this field.</p> <p>length = 999</p>
        ediSetupIdentCode:
          type: string
          description: <p>Unique identifier of the EDI definition.</p> <p>length = 20</p>
        boStatus:
          $ref: '#/components/schemas/ComboboxEntryDTO'
        numberOfShipmentsInEDI:
          type: integer
          description: <p>The number of shipping orders contained in the EDI message.</p>
          format: int32
        shipmentReferences:
          type: array
          description: <p>The shipments included in the EDI message.</p>
          items:
            $ref: '#/components/schemas/DLShipmentReferenceDTO'
      description: Response-DTO for an EDI message for a pickup.
    DLShipmentItemReferenceTextUCDDTO:
      type: object
      properties:
        type:
          type: string
          description: '<p>

            The type of the reference number or text. Valid values are:

            <li>MERCHANT_PRODUCT_ID - Merchant product identifier.</li>

            <li>MFR_PRODUCT_ID_NONSTD - Non-standardised manufacturer product identifier.</li>

            <li>MFR_PRODUCT_ID_STD - Standardised manufacturer product identifier.</li>

            </p>

            <p>length=30</p>

            '
        value:
          type: string
          description: The value of the reference number or text. <p> length=500 </p>
      description: DTO for reference numbers and texts of a certain (predefined) type. This is the same DTO like DLShipmentItemReferenceTextDTO, but supports fewer types.
    DLShipmentCreationParmsDTO:
      required:
      - creationMode
      type: object
      properties:
        creationMode:
          type: string
          description: '<p> Controls the creation of the shipment and/or it''s packages as a transaction in the carrier engine. This is necessary

# --- truncated at 32 KB (256 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/aeb/refs/heads/main/openapi/aeb-shipping-api-openapi.yml