AEB Carrier Event Service BF Bean API

openapi: 3.2.0
info:
  title: Carrier Event Service HTTP Carrier Event Service BF Bean API
  description: Thank you for using our HTTP API documentation.
  version: '1.0'
servers:
- url: https://xnsg.dc.aeb.com/demo1ces/rest
security:
- SWAGGER_AUTH_KEY: []
- BASIC_AUTH: []
tags:
- name: CarrierEventServiceBFBean
  description: Carrier event service related business facade methods. Supports methods for shipments, events and configuration.
paths:
  /CarrierEventServiceBFBean/createShipments:
    post:
      tags:
      - CarrierEventServiceBFBean
      summary: createShipments
      description: Creates a new list of shipments.
      operationId: createShipments
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateShipmentsRequestDTO'
          application/xml:
            schema:
              $ref: '#/components/schemas/CreateShipmentsRequestDTO'
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreateShipmentsResponseDTO'
            application/xml:
              schema:
                $ref: '#/components/schemas/CreateShipmentsResponseDTO'
      security:
      - BASIC_AUTH: []
  /CarrierEventServiceBFBean/deleteCarrierTrackingConfigurations:
    post:
      tags:
      - CarrierEventServiceBFBean
      summary: deleteCarrierTrackingConfigurations
      description: Removes the carrier tracking configurations referenced in the request.
      operationId: deleteCarrierTrackingConfigurations
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/DeleteCarrierTrackingConfigurationsRequestDTO'
          application/xml:
            schema:
              $ref: '#/components/schemas/DeleteCarrierTrackingConfigurationsRequestDTO'
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteCarrierTrackingConfigurationsResponseDTO'
            application/xml:
              schema:
                $ref: '#/components/schemas/DeleteCarrierTrackingConfigurationsResponseDTO'
      security:
      - BASIC_AUTH: []
  /CarrierEventServiceBFBean/getAllConverterInformation:
    post:
      tags:
      - CarrierEventServiceBFBean
      summary: getAllConverterInformation
      description: Returns all converters of the system and its associated parameters and information.
      operationId: getAllConverterInformation
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetAllConverterInformationRequestDTO'
          application/xml:
            schema:
              $ref: '#/components/schemas/GetAllConverterInformationRequestDTO'
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetAllConverterInformationResponseDTO'
            application/xml:
              schema:
                $ref: '#/components/schemas/GetAllConverterInformationResponseDTO'
      security:
      - BASIC_AUTH: []
  /CarrierEventServiceBFBean/getEventsForReferenceNumber:
    post:
      tags:
      - CarrierEventServiceBFBean
      summary: getEventsForReferenceNumber
      description: Returns the resolved and unresolved events associated with the requested shipment reference number.
      operationId: getEventsForReferenceNumber
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetEventsForReferenceNumberRequestDTO'
          application/xml:
            schema:
              $ref: '#/components/schemas/GetEventsForReferenceNumberRequestDTO'
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetEventsForReferenceNumberResponseDTO'
            application/xml:
              schema:
                $ref: '#/components/schemas/GetEventsForReferenceNumberResponseDTO'
      security:
      - BASIC_AUTH: []
  /CarrierEventServiceBFBean/getProvidedTrackingData:
    post:
      tags:
      - CarrierEventServiceBFBean
      summary: getProvidedTrackingData
      description: Returns CESProvidedTrackingData by its digest.
      operationId: getProvidedTrackingData
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetProvidedTrackingDataRequestDTO'
          application/xml:
            schema:
              $ref: '#/components/schemas/GetProvidedTrackingDataRequestDTO'
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetProvidedTrackingDataResponseDTO'
            application/xml:
              schema:
                $ref: '#/components/schemas/GetProvidedTrackingDataResponseDTO'
      security:
      - BASIC_AUTH: []
  /CarrierEventServiceBFBean/getShipmentsEvents:
    post:
      tags:
      - CarrierEventServiceBFBean
      summary: getShipmentsEvents
      description: Returns the resolved events of the given shipments sorted by CESTrackingEventResponseDTO's eventDate in ascending order, taking the time zone into account.
      operationId: getShipmentsEvents
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetShipmentsEventsRequestDTO'
          application/xml:
            schema:
              $ref: '#/components/schemas/GetShipmentsEventsRequestDTO'
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetShipmentsEventsResponseDTO'
            application/xml:
              schema:
                $ref: '#/components/schemas/GetShipmentsEventsResponseDTO'
      security:
      - BASIC_AUTH: []
  /CarrierEventServiceBFBean/getShipmentsEventsFiltered:
    post:
      tags:
      - CarrierEventServiceBFBean
      summary: getShipmentsEventsFiltered
      description: Returns the resolved events of the shipments filtered by the requested filter sorted by CESTrackingEventResponseDTO's eventDate in ascending order, taking the time zone into account.
      operationId: getShipmentsEventsFiltered
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetShipmentsEventsFilteredRequestDTO'
          application/xml:
            schema:
              $ref: '#/components/schemas/GetShipmentsEventsFilteredRequestDTO'
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetShipmentsEventsFilteredResponseDTO'
            application/xml:
              schema:
                $ref: '#/components/schemas/GetShipmentsEventsFilteredResponseDTO'
      security:
      - BASIC_AUTH: []
  /CarrierEventServiceBFBean/getShipmentsWithEntryCertification:
    post:
      tags:
      - CarrierEventServiceBFBean
      summary: getShipmentsWithEntryCertification
      description: Returns shipments with entry certifications.
      operationId: getShipmentsWithEntryCertification
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetShipmentsWithEntryCertificationRequestDTO'
          application/xml:
            schema:
              $ref: '#/components/schemas/GetShipmentsWithEntryCertificationRequestDTO'
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetShipmentsWithEntryCertificationResponseDTO'
            application/xml:
              schema:
                $ref: '#/components/schemas/GetShipmentsWithEntryCertificationResponseDTO'
      security:
      - BASIC_AUTH: []
  /CarrierEventServiceBFBean/setCarrierTrackingConfigurations:
    post:
      tags:
      - CarrierEventServiceBFBean
      summary: setCarrierTrackingConfigurations
      description: Creates or updates the given carrier tracking configurations.
      operationId: setCarrierTrackingConfigurations
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetCarrierTrackingConfigurationRequestDTO'
          application/xml:
            schema:
              $ref: '#/components/schemas/SetCarrierTrackingConfigurationRequestDTO'
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SetCarrierTrackingConfigurationResponseDTO'
            application/xml:
              schema:
                $ref: '#/components/schemas/SetCarrierTrackingConfigurationResponseDTO'
      security:
      - BASIC_AUTH: []
  /CarrierEventServiceBFBean/synchronizeResolvedEvents:
    post:
      tags:
      - CarrierEventServiceBFBean
      summary: synchronizeResolvedEvents
      description: Synchronizes all resolved events that have occurred since the last synchronization call.
      operationId: synchronizeResolvedEvents
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SynchronizeResolvedEventsRequestDTO'
          application/xml:
            schema:
              $ref: '#/components/schemas/SynchronizeResolvedEventsRequestDTO'
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SynchronizeResolvedEventsResponseDTO'
            application/xml:
              schema:
                $ref: '#/components/schemas/SynchronizeResolvedEventsResponseDTO'
      security:
      - BASIC_AUTH: []
  /CarrierEventServiceBFBean/testProviderConnection:
    post:
      tags:
      - CarrierEventServiceBFBean
      summary: testProviderConnection
      description: Tests the connection of the requested tracking provider.
      operationId: testProviderConnection
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TestProviderConnectionRequestDTO'
          application/xml:
            schema:
              $ref: '#/components/schemas/TestProviderConnectionRequestDTO'
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TestProviderConnectionResponseDTO'
            application/xml:
              schema:
                $ref: '#/components/schemas/TestProviderConnectionResponseDTO'
      security:
      - BASIC_AUTH: []
components:
  schemas:
    GetShipmentsEventsResponseDTO:
      type: object
      properties:
        hasErrors:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>An error usually means that the request could not be performed.</p><p>Error details are provided in the messages[] array.</p>
          example: false
        hasOnlyRetryableErrors:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>Error details are provided in the messages[] array.</p>
          example: true
        hasWarnings:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>Error details are provided in the messages[] array.</p>
          example: true
        messages:
          type: array
          description: <p>Error or warning messages at the request level.</p><p>There may be additional messages[] arrays at lower data levels as specified in the documentation.</p>
          items:
            $ref: '#/components/schemas/ResponseMessageDTO'
        shipments:
          type: array
          description: Collection of shipments responses containing tracking objects and event lists.
          items:
            $ref: '#/components/schemas/CESShipmentEventResponseDTO'
      description: Response DTO for a request for shipment events.
      xml:
        name: getShipmentsEventsResponseDTO
    GetProvidedTrackingDataResponseDTO:
      type: object
      properties:
        hasErrors:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>An error usually means that the request could not be performed.</p><p>Error details are provided in the messages[] array.</p>
          example: false
        hasOnlyRetryableErrors:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>Error details are provided in the messages[] array.</p>
          example: true
        hasWarnings:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>Error details are provided in the messages[] array.</p>
          example: true
        messages:
          type: array
          description: <p>Error or warning messages at the request level.</p><p>There may be additional messages[] arrays at lower data levels as specified in the documentation.</p>
          items:
            $ref: '#/components/schemas/ResponseMessageDTO'
        providedTrackingData:
          $ref: '#/components/schemas/CESProvidedTrackingDataResponseDTO'
      description: Response DTO for a request for CESProvidedTrackingData.
      xml:
        name: getProvidedTrackingDataResponseDTO
    GetAllConverterInformationRequestDTO:
      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 get every converter in the system
      xml:
        name: getAllConverterInformationRequestDTO
    CESCarrierServiceDataDTO:
      required:
      - carrierIdentCode
      - serviceIdentCode
      type: object
      properties:
        carrierIdentCode:
          maxLength: 20
          minLength: 1
          type: string
          description: Carrier of the shipment. <p>length=20</p>
          example: DACHSER
        serviceIdentCode:
          maxLength: 20
          minLength: 1
          type: string
          description: Service requested for the shipment. Service must be available within the carrier identified by carrierIdentCode. <p>length=20</p>
          example: WEEKEND
      description: DTO to identify the service of a carrier
    CESShipmentDTO:
      required:
      - carrierService
      - endAddress
      - pickupTime
      - referenceNumber1
      - shipmentNumber
      - startAddress
      - trackingObjects
      type: object
      properties:
        trackingObjects:
          type: array
          description: Tracking objects of the shipment At least one tracking object is required. Depending weather the carrier will provide tracking events  for each single package or on shipment level the  shipment has to be created with one tracking objects per package or with one tracking object for the shipment.
          items:
            $ref: '#/components/schemas/CESTrackingObjectDTO'
        additionalReferences:
          type: array
          description: Additional reference numbers of the shipment or package <p>Since transmissions can have several reference numbers, it is possible to transfer further reference values. In the CES user interface, the shipment can then be searched with these these values.</p>
          items:
            $ref: '#/components/schemas/CESAdditionalReferenceDTO'
        shipmentNumber:
          maxLength: 20
          minLength: 1
          type: string
          description: ID uniquely referencing the corresponding business transaction in Carrier Connect. <p> length=20 </p>
          example: 0181374
        clientSystemId:
          maxLength: 20
          type: string
          description: Host system ID. The installation ID more precisely identifies the host system from which the shipping order was imported. Data for one client can be imported from different host systems. <p> length = 20 </p>
          example: PS4_100
        organizationUnitClientSystem:
          maxLength: 255
          type: string
          description: Additional organizational unit of the client system for further specification of the data source. <p> length = 255 </p>
          example: AL_US
        transactionId:
          maxLength: 250
          type: string
          description: ID uniquely referencing the corresponding business transaction in the host system.  <p> length = 250 </p>
          example: WA1-100696235133571361984584754FZOD-2110
        referenceNumber1:
          maxLength: 50
          minLength: 1
          type: string
          description: Reference number that assigns the shipment to a process in another system. <p> length=50 </p>
          example: '704503458358845172150809'
        startAddress:
          $ref: '#/components/schemas/CESAddressDTO'
        endAddress:
          $ref: '#/components/schemas/CESAddressDTO'
        pickupTime:
          $ref: '#/components/schemas/DateAndZoneDTO'
        carrierService:
          $ref: '#/components/schemas/CESCarrierServiceDataDTO'
        entryCertificateRequired:
          type: boolean
          description: If an entry certificate is required the necessary data will be transferred to content storage engine.
          example: false
      description: Represents a shipment
    CreateShipmentsResponseDTO:
      type: object
      properties:
        hasErrors:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>An error usually means that the request could not be performed.</p><p>Error details are provided in the messages[] array.</p>
          example: false
        hasOnlyRetryableErrors:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>Error details are provided in the messages[] array.</p>
          example: true
        hasWarnings:
          type: boolean
          description: <p>True, if there are any error messages.</p><p>Error details are provided in the messages[] array.</p>
          example: true
        messages:
          type: array
          description: <p>Error or warning messages at the request level.</p><p>There may be additional messages[] arrays at lower data levels as specified in the documentation.</p>
          items:
            $ref: '#/components/schemas/ResponseMessageDTO'
        shipmentResponses:
          type: array
          description: The list of shipment references that were not created.
          items:
            $ref: '#/components/schemas/CreateShipmentsResponseItemDTO'
      description: DTO for create shipments response
      xml:
        name: createShipmentsResponseDTO
    SynchronizeResolvedEventsRequestDTO:
      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"]'
        syncId:
          maxLength: 20
          type: string
          description: Synchronization ID for delta-transmission. <p>Pass this field with the value returned in SynchronizeResolvedEventsResponseDTO's syncId. For initializing of delta-transmissions pass simply null and use ageInDays.</p><p>length=20</p>
        ageInDays:
          type: integer
          description: Only for the initializing of delta-transmissions (if SynchronizeResolvedEventsRequestDTO's syncId is null) this field has to be passed. <p>Start the initializing of delta transmission with this age. Older events will not be synchronized. Journal entries are deleted after 30 days. Events whose processing lies further in the past are no longer synchronized.</p>
          format: int32
          example: 30
        blockSize:
          type:
          - integer
          - 'null'
          description: For defining the block size. Can be null. If empty the default block size of 200 is used.
          format: int32
          default: 200
        isStandardEventTextIncluded:
          type: boolean
          description: Controls, if the name and description that explain the identCode of the event is included in the response. If this option is set to true, there will be a name and a description for each requested language.
          example: true
          default: false
        isOriginalDescriptionIncluded:
          type: boolean
          description: Controls, if the description of the carriers codelist that explain the originalIdentCode and originalReason of the event is included in the response. If this option is set to true, there will be a description in the language that depends on the carrier.
          example: true
          default: false
      description: DTO with parms to synchronize resolved events
      xml:
        name: synchronizeResolvedEventsRequestDTO
    CESProvidedTrackingDataMetaDataDTO:
      type: object
      properties:
        digest:
          type: string
          description: Unique key of the CESProvidedTrackingData
        trackingConfigurationIdentCode:
          type: string
          description: "The identCode of the trackingConfiguration. This contains by convention the identcode of the carrier which gives\tkind of a hint of the original carrier."
        receivedAt:
          $ref: '#/components/schemas/DateAndZoneDTO'
        messageId:
          type: string
          description: MessagePoolId. Can give a hint about the file, but contains some guid elements to make the id unique, too.
        contentInfo:
          type: string
          description: CESProvidedTrackingData.contentInfo, e.g. "PushApi", or the converter identifier
        contentType:
          type: string
          description: CESProvidedTrackingData.contentType, e.g. EDIFACT or CSV
        contentSize:
          type: integer
          description: Size in byte of the binary content.
          format: int64
        contentSource:
          type: string
          description: Information about the technical source of the data content.
      description: Meta data of a CESProvidedTrackingData
    TestProviderConnectionRequestDTO:
      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"]'
        providerDefinition:
          type: string
          description: The serialized data format of a carrier provider definition configuration.
          format: byte
        providerSetup:
          type: string
          description: The serialized data format of a carrier provider setup configuration.
          format: byte
        parameters:
          $ref: '#/components/schemas/ConnectionTestParametersDTO'
      description: Request DTO that is submitted when requesting a connection test
      xml:
        name: testProviderConnectionRequestDTO
    CESCarrierTrackingConfigurationReferenceDTO:
      type: object
      properties:
        identCode:
          type: string
          description: Unique identCode of a carrier tracking configuration.
          example: DACHSER_FTP
      description: DTO to reference a CarrierTrackingConfiguration
    CESLocationIdentifierResponseDTO:
      type: object
      properties:
        type:
          type: string
          description: '<p>The functional type of the identifier.</p> <p>Possible values: <ul> <li>IATAAIRPORTCODE</li> <li>UNLOCODE</li> <li>GENERIC</li> <li>CARRIER_LOCATION_CODE</li> </ul> </p>'
          example: UNLOCODE
        value:
          type: string
          description: The value of the identifier. <p>length = 100</p>
          example: KRSEL
      description: Location data represented by an identifier
    CESSynchronizeResolvedEventDTO:
      required:
      - referenceNumber1
      - shipmentReference
      type: object
      properties:
        trackingNumber:
          type: string
          description: Tracking number of the event. This is a the unique number that is generated to identify the tracking object in the carriers delivery process.
          example: AB486 083 50
        trackingObjectType:
          type: string
          description: 'Type of the trackingObject. Possible types are: <ul><li>SHIPMENT</li><li>PACKAGE</li></ul>'
          example: SHIPMENT
        eventData:
          $ref: '#/components/schemas/CESTrackingEventResponseDTO'
        carrier:
          $ref: '#/components/schemas/CESCarrierReferenceDTO'
        shipmentReference:
          $ref: '#/components/schemas/CESShipmentReferenceDTO'
        referenceNumber1:
          maxLength: 50
          minLength: 1
          type: string
          description: Reference number that assigns the shipment to a process in another system. <p> length=50 </p>
          example: '704503458358845172150809'
        additionalReferences:
          type: array
          description: Additional reference numbers of the shipment or package. Since tracking objects can have several reference numbers, it is possible to transfer further reference values.
          items:
            $ref: '#/components/schemas/CESReferenceNumberDTO'
        providedTrackingDataMetaData:
          $ref: '#/components/schemas/CESProvidedTrackingDataMetaDataDTO'
        digest:
          maxLength: 40
          type: string
          description: Unique key of the tracking event within the client. <p> length=40 </p>
          example: ff0192abded20f6f69b23713e1fba775bf2b5221
      description: DTO for the resolved event with context information to enable assignment of the event to a certain business object.
    ConnectionTestParametersDTO:
      type: object
      properties:
        ftpParameters:
          $ref: '#/components/schemas/FTPConnectionTestParametersDTO'
        sftpParameters:
          $ref: '#/components/schemas/SFTPConnectionTestParametersDTO'
      description: Container class for all connection test parameter types. Only one field may be filled at the same time.
    CESAdditionalReferenceDTO:
      required:
      - referenceNumber
      type: object
      properties:
        referenceNumber:
          $ref: '#/components/schemas/CESReferenceNumberDTO'
        trackingObjectReference:
          maxLength: 250
          type:
          - string
          - 'null'
          description: A reference to a CESTrackingObjectDTO in this shipment. This is the trackingNumber of the CESTrackingObjectDTO. If provided the reference number will also be linked to the tracking object. <p> length = 250 </p>
          example: AB486 083 50
      description: Represents an additional reference field within a shipment request.
    CreateShipmentsRequestDTO:
      required:
      - shipments
      type: object
      properties:
        clientSystemId:
          type: string
          description: '<p>Id o

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