AEB BSM Carrier API

openapi: 3.2.0
info:
  title: BSM (TEST2) HTTP BSM Carrier API
  description: Thank you for using our HTTP API documentation.
  version: '1.0'
servers:
- url: https://rz3.aeb.de/test2bsm/rest
security:
- SWAGGER_AUTH_KEY: []
- BASIC_AUTH: []
tags:
- name: BSM Carrier
  description: The API for BSM Carrier operations
paths:
  /BSMCarrierBFBean/createShipment:
    post:
      tags:
      - BSM Carrier
      summary: createShipment
      description: Creates a shipment with the data specified in the shipment request
      operationId: createShipment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/BSMDLCreateShipmentRequestDTO'
          application/xml:
            schema:
              $ref: '#/components/schemas/BSMDLCreateShipmentRequestDTO'
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DLCreateShipmentResponseDTO'
            application/xml:
              schema:
                $ref: '#/components/schemas/DLCreateShipmentResponseDTO'
      security:
      - BASIC_AUTH: []
  /BSMCarrierBFBean/getQuotes:
    post:
      tags:
      - BSM Carrier
      summary: getQuotes
      description: Get the quotes for the requested shipment data
      operationId: getQuotes
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetQuotesRequestDTO'
          application/xml:
            schema:
              $ref: '#/components/schemas/GetQuotesRequestDTO'
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetQuotesResponseDTO'
            application/xml:
              schema:
                $ref: '#/components/schemas/GetQuotesResponseDTO'
      security:
      - BASIC_AUTH: []
  /BSMCarrierBFBean/getShipment:
    post:
      tags:
      - BSM Carrier
      summary: getShipment
      description: Get the shipment data including the quotes for a service
      operationId: getShipment
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/GetShipmentRequestDTO'
          application/xml:
            schema:
              $ref: '#/components/schemas/GetShipmentRequestDTO'
      responses:
        default:
          description: default response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetShipmentResponseDTO'
            application/xml:
              schema:
                $ref: '#/components/schemas/GetShipmentResponseDTO'
      security:
      - BASIC_AUTH: []
components:
  schemas:
    DLShipmentItemResponseDataDTO:
      type: object
      properties:
        itemNumber:
          type: integer
          description: The shipment item number internally generated by the carrier engine. <p> length=4 </p>
          format: int32
        itemTransactionId:
          type: string
          description: The unique transaction id of the item maintained by the client system. <p> length=50 </p>
        referenceNumber1:
          type: string
          description: The first reference number of the item. <p> length=50 </p>
        referenceNumber2:
          type: string
          description: The second reference number of the item. <p> length=50 </p>
        boStatus:
          $ref: '#/components/schemas/ComboboxEntryDTO'
        customsTariffNumber:
          type: string
          description: The customs tariff number of the shipping item's contents. <p> length=11 </p>
        description:
          type: string
          description: The shipping item's description. <p> length=250 </p>
        exportLicense:
          type: string
          description: Export license. <p> length=50 </p>
        countryOfOriginsISOCode:
          type: string
          description: Country of origins. <p> length=2 </p>
        certificateOfOrigins:
          type: string
          description: Certificate of origins. <p> length=50 </p>
        quantity:
          $ref: '#/components/schemas/QuantityDTO'
        netWeight:
          $ref: '#/components/schemas/QuantityDTO'
        grossWeight:
          $ref: '#/components/schemas/QuantityDTO'
        customsValue:
          $ref: '#/components/schemas/AmountOfMoneyDTO'
        goodsValue:
          $ref: '#/components/schemas/AmountOfMoneyDTO'
        despatchProcedureIdentCode:
          type: string
          description: '<p> The despatch procedure. When filled, possible values are: <li>T1 <li>T2 <li>NONE </p> <br> <p> length=10 </p>'
        despatchProcedureNames:
          type: array
          description: The names of the despatch procedure in the requested result languages.
          items:
            $ref: '#/components/schemas/TextInLanguageDTO'
        referencesTexts:
          type: array
          description: Further references texts of the item.
          items:
            $ref: '#/components/schemas/DLShipmentItemReferenceTextDTO'
        additionalValues:
          $ref: '#/components/schemas/GenericDataRecordDTO'
        hazardousGoodsItems:
          type: array
          description: Hazardous goods items.
          items:
            $ref: '#/components/schemas/DLHazardousGoodsItemResponseDataDTO'
      description: DTO for shipment item data in a response.
    GetQuotedDataDTO:
      type: object
      properties:
        netPrice:
          $ref: '#/components/schemas/AmountOfMoneyDTO'
        priceItemsDescription:
          type: string
          description: Length 2048 - Human-readable description of price details of the carrier, with multiple possibly indented lines.
        transitDate:
          type: string
          description: 'Length 10 - The delivery date of the quoted service using the quotedService data. May be empty. This is a close approximation to a guaranteed delivery date, if provided by the carrier. Format: yyyy-mm-dd'
        transitTime:
          type: string
          description: Length 8 - The delivery time of the quoted service using the quotedService data. May be empty. This is a close approximation to a guaranteed delivery time, if provided by the carrier. Format HH:MM:SS
        messages:
          type: array
          description: Messages and alerts referring to the quoted service. Provided by the carrier or generated by the quotes API.
          items:
            $ref: '#/components/schemas/QuotedServiceMessageDTO'
      description: The total net price of the quoted service. Contains the price negotiated with the carrier for the account, if possible; otherwise the list price is used. May be empty if the carrier does not provide a price or if the price is formatted incorrectly.
    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.
    GetQuotesRequestDTO:
      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"]'
        shipment:
          $ref: '#/components/schemas/DLShipmentRequestDataDTO'
        shippingTime:
          type: string
          description: 'Length 8 - In addition to the shipment data the shipping time is relevant. Format: HH:MM:SS'
      description: The data needed to request quoted services for a shipment.
    DLShipmentAccountInfoResponseDataDTO:
      type: object
      properties:
        identCode:
          type: string
          description: Ident code of the account.  <p>length=50</p>
        customerNumberAtCarrier:
          type: string
          description: Account number of the shipper assigned from the carrier.  <p>length=25</p>
        singlePackageHandlingActivated:
          type: boolean
          description: Indicates whether package by package printing is possible for the carrier.
      description: Holds information from the account used for the shipment
    DLShipmentTotalsResponseDataDTO:
      type: object
      properties:
        numberOfPackages:
          type: integer
          description: The exact number of packages of the shipment. This value only is available when the shipment has been completed, so that the number of packages is known for sure. <p> length=5 </p>
          format: int32
        numberOfPackagesExpected:
          type: integer
          description: 'The expected number of packages entered by user or ERP system Used to print the total number of packages on the label when documents are printed before all packages are available. Note: Should not be changed after the first label is printed. Otherwise the data on the label will be inconsistent. <p> length=5 </p>'
          format: int32
        grossWeight:
          $ref: '#/components/schemas/QuantityDTO'
        grossWeightExpected:
          $ref: '#/components/schemas/QuantityDTO'
        loadingMeters:
          type: number
          description: The loading meters needed for the shipment. This value is only reliable when the shipment has been completed, so that all packages are known for sure. <p> length=10, scale=3 </p>
        palletPlaces:
          type: number
          description: The pallet places meters needed for the shipment. This value is only reliable when the shipment has been completed, so that all packages are known for sure. <p>length=10, scale=3</p>
      description: DTO for shipment totals in a request.
    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.
    DLShipmentResponseDataDTO:
      type: object
      properties:
        hasErrors:
          type: boolean
          description: True, if there are any error messages. If an error has occured the messages contain more details about the errors.
        hasWarnings:
          type: boolean
          description: True, if there are any warning messages.
        messages:
          type: array
          description: Messages for the whole request, e.g. for errors or warnings.<br>
          items:
            $ref: '#/components/schemas/ResponseMessageDTO'
        syncId:
          type: string
          description: Sync Id of the shipment. <p> length=20 </p>
        transactionId:
          type: string
          description: <p> ID uniquely referencing the corresponding business transaction in the client system. </p> <p> length=250 </p>
        organizationUnitClientSystem:
          type: string
          description: Additional criteria two separate different organisational units within one Engine's client. <p> length=255 </p>
        shipmentNumber:
          type: string
          description: The shipment number internally generated by the carrier engine. <p> length=20 </p>
        carrierShipmentNumber:
          type: string
          description: The carrier tracking number of the shipment. <p> length=50 </p>
        carrierShipmentNumberReturn:
          type: string
          description: The additional return tracking number given by the carrier, if the data for the possible return shipment are to be generated with the initial shipping data. <p> length=50 </p>
        carrierTrackingURL:
          type: string
          description: The tracking URL of the shipment.<p> length=512 </p>
        carrierTrackingURLReturn:
          type: string
          description: The additional return tracking URL of the shipment.<p> length=512 </p>
        bulkMasterShipmentNumber:
          type: string
          description: The internally generated shipment number of the bulk master if applicable. Must be used to access the bulk master shipment e.g. for adding packages, etc.  <p> length=20 </p>
        revisionNumber:
          type: integer
          description: Revision number. <p> length=3 </p>
          format: int32
        referenceNumber1:
          type: string
          description: Reference number 1. <p> length=50 </p>
        referenceNumber2:
          type: string
          description: Reference number 2. <p> length=50 </p>
        customsRegistrationNumber:
          type: string
          description: Registration number (MRN, etc.) of the customs declaration.  The number is assigned by the customs authorities. <p> length=35 </p>
          deprecated: true
        transportRegistrationNumber:
          type: string
          description: Transport registration number like EKAER (Hungary) or SENT (Poland). The number is assigned by the local authorities. <p> length=35 </p>
          deprecated: true
        shopId:
          type: string
          description: The ID of the shop to which the shipping order is sent. <p> length=35 </p>
          deprecated: true
        shipToServicePointID:
          type: string
          description: The ID of the service point at which the consignee can pick up his shipping order. <p> length=35 </p>
        shipFromServicePointID:
          type: string
          description: The ID of the service point at which the shipper can deliver the shipping order for the carrier to pick up. <p> length=35 </p>
        remark:
          type: string
          description: Optional textual remark. Used for internal purposes only. The information is not forwarded to any carrier. <p> length=1000 </p>
        pickupNumber:
          type: string
          description: Pickup number. Is empty, when the shipment is not yet assigned to a pickup. <p> length=20 </p>
        pickupTransactionId:
          type: string
          description: <p> ID uniquely referencing the corresponding pickup in the client system. Is empty, when the shipment is not yet assigned to a pickup. </p> <p> length=250 </p>
        boStatus:
          $ref: '#/components/schemas/ComboboxEntryDTO'
        isCompleted:
          type: boolean
          description: <p> Indicates that the shipment is complete. </p>
        carrierNames:
          type: array
          description: <p>The name of the carrier in the requested languages.</p> <p> length (of the texts in TextInLanguageDTO) = 50 </p>
          items:
            $ref: '#/components/schemas/TextInLanguageDTO'
        carrierIdentCode:
          type: string
          description: The unique code of the carrier. <p> length=50 </p>
        carrierServiceNames:
          type: array
          description: The name of the carrier service, for example 'DHL Express National 08:00' in the requested languages. <p> length (of the texts in TextInLanguageDTO) = 50 </p>
          items:
            $ref: '#/components/schemas/TextInLanguageDTO'
        carrierServiceCode:
          type: string
          description: The unique code of the carrier service. <p> length=50 </p>
        freightCosts:
          $ref: '#/components/schemas/AmountOfMoneyDTO'
        shippingDate:
          type: string
          description: Shipping date in the format 'yyyy-MM-dd'. <p> length=10 </p>
        shippingPt:
          $ref: '#/components/schemas/DLPartyDTO'
        shippingPtContact:
          $ref: '#/components/schemas/DLPersonDTO'
        consignee:
          $ref: '#/components/schemas/DLPartyDTO'
        consigneeContact:
          $ref: '#/components/schemas/DLPersonDTO'
        altInvoiceRecipient:
          $ref: '#/components/schemas/DLPartyDTO'
        altInvoiceRecipientContact:
          $ref: '#/components/schemas/DLPersonDTO'
        termsOfDeliveryCode:
          type: string
          description: IdentCode of the terms of delivery. Valid values are depending on the client's terms of delivery in the master file data. <p> length=20 </p>
        incotermDestination:
          type: string
          description: The incoterm destination of the shipment. The incoterm is included within the terms of delivery. Depending on the incoterm, it makes sense to specify a incoterm destination. <p> length=50 </p>
        portOfLoadingCode:
          type: string
          description: The code of the port or airport where the goods are loaded. The field is only relevant for air or sea freight shipments. <p> length=5 </p>
        portOfLoading:
          type: string
          description: The name of the port or airport where the goods are loaded. The field is only relevant for air or sea freight shipments. <p> length=50 </p>
        portOfDischargeCode:
          type: string
          description: The code of the port or airport where the goods are unloaded. The field is only relevant for air or sea freight shipments. <p> length=5 </p>
        portOfDischarge:
          type: string
          description: The name of the port or airport where the goods are unloaded. The field is only relevant for air or sea freight shipments. <p> length=50 </p>
        securityStatus:
          type: string
          description: '<p> The security status of air freight for cargo/post or passenger aircraft transport. Valid values are: <li>NOTSPECIFIED <li>SECURE <li>UNSECURE </p> <br> <p> length=12 </p>'
        fixedDate:
          type: string
          description: Fixed delivery date of the shipment in the format 'yyyy-MM-dd'. <p> <b>Important:</b> Only the date portion is transmitted to the carrier interfaces. The time portion is ignored, so it does not matter which time is passed. </p> <p> length=10 </p>
        latestRequestedDeliveryDate:
          type: string
          description: Latest requested delivery date of the shipment in the format 'yyyy-MM-dd HH:mm:ss' or 'yyyyMMddHHmm'. The date is expected to be in timezone 'UTC'. <p> length=19 </p>
        earliestRequestedDeliveryDate:
          type: string
          description: Earliest requested delivery date of the shipment in the format 'yyyy-MM-dd HH:mm:ss' or 'yyyyMMddHHmm'. The date is expected to be in timezone 'UTC'. <p> length=19 </p>
        latestCollectionBookingDate:
          type: string
          description: Latest collection booking date of the shipment in the format 'yyyy-MM-dd HH:mm:ss' or 'yyyyMMddHHmm'. The date is expected to be in timezone 'UTC'. <p> length=19 </p>
        earliestCollectionBookingDate:
          type: string
          description: Earliest collection booking date of the shipment in the format 'yyyy-MM-dd HH:mm:ss' or 'yyyyMMddHHmm'. The date is expected to be in timezone 'UTC'. <p> length=19 </p>
        collectionBookingNumber:
          type: string
          description: The booking number of a requested collection booking assigned from carrier to this shipment. <p> length=20 </p>
        pickupAddress:
          $ref: '#/components/schemas/DLPartyDTO'
        pickupAddressContact:
          $ref: '#/components/schemas/DLPersonDTO'
        altReturnAddress:
          $ref: '#/components/schemas/DLPartyDTO'
        altReturnAddressContact:
          $ref: '#/components/schemas/DLPersonDTO'
        notifyAddress:
          $ref: '#/components/schemas/DLPartyDTO'
        notifyAddressContact:
          $ref: '#/components/schemas/DLPersonDTO'
        coverAddress:
          $ref: '#/components/schemas/DLPartyDTO'
        coverAddressContact:
          $ref: '#/components/schemas/DLPersonDTO'
        customsAgent:
          $ref: '#/components/schemas/DLPartyDTO'
        customsAgentContact:
          $ref: '#/components/schemas/DLPersonDTO'
        alternativeCarrierAddress:
          $ref: '#/components/schemas/DLPartyDTO'
        alternativeCarrierAddressContact:
          $ref: '#/components/schemas/DLPersonDTO'
        importerAddress:
          $ref: '#/components/schemas/DLPartyDTO'
        importerAddressContact:
          $ref: '#/components/schemas/DLPersonDTO'
        exporterAddress:
          $ref: '#/components/schemas/DLPartyDTO'
        exporterAddressContact:
          $ref: '#/components/schemas/DLPersonDTO'
        valueAddedServices:
          type: array
          description: Value added services of the shipment.
          items:
            $ref: '#/components/schemas/DLValueAddedServiceDTO'
        carrierInfoTexts:
          type: array
          description: Carrier info texts for the shipment.
          items:
            $ref: '#/components/schemas/DLShipmentCarrierInfoTextDTO'
        payerOfChargRole:
          type: string
          description: '<p> The payer of charges. Possible values are: <li>SHIPPER <li>RECEIVER <li>THIRDPARTY </p> <br> <p> length=10 </p>'
        payerOfCharg:
          $ref: '#/components/schemas/DLPartyDTO'
        payerOfChargContact:
          $ref: '#/components/schemas/DLPersonDTO'
        payerOfChargAccountNo:
          type: string
          description: The payer of charges account number. <p> length=50 </p>
        payerOfDutRole:
          type: string
          description: '<p> The payer of duties and taxes. Possible values are: <li>SHIPPER <li>RECEIVER <li>THIRDPARTY </p> <br> <p> length=10 </p>'
        payerOfDut:
          $ref: '#/components/schemas/DLPartyDTO'
        payerOfDutContact:
          $ref: '#/components/schemas/DLPersonDTO'
        payerOfDutAccountNo:
          type: string
          description: The payer of duties and taxes account number. <p> length=50 </p>
        altPayerOfTaxRole:
          type: string
          description: '<p> The alternative payer of taxes. Possible values are: <li>SHIPPER <li>RECEIVER <li>THIRDPARTY </p> <br> <p> length=10 </p>'
        altPayerOfTax:
          $ref: '#/components/schemas/DLPartyDTO'
        altPayerOfTaxContact:
          $ref: '#/components/schemas/DLPersonDTO'
        altPayerOfTaxAccountNo:
          type: string
          description: The alternative payer of taxes account number. <p> length=50 </p>
        contents:
          type: string
          description: Additional content discription <p> length=250 </p>
        goodsValue:
          $ref: '#/components/schemas/AmountOfMoneyDTO'
        customsValue:
          $ref: '#/components/schemas/AmountOfMoneyDTO'
        insuranceValue:
          $ref: '#/components/schemas/AmountOfMoneyDTO'
        codValue:
          $ref: '#/components/schemas/AmountOfMoneyDTO'
        isDocumentShipment:
          type: boolean
          description: <p> Indicates whether the shipment is a document shipment or not. </p> <p> Note that this flag also defines which services can be used for the shipment. </p>
        numberOfPackages:
          type: integer
          description: The number of packages <p> length=5 </p>
          format: int32
        shipmentTotals:
          $ref: '#/components/schemas/DLShipmentTotalsResponseDataDTO'
        accountInfo:
          $ref: '#/components/schemas/DLShipmentAccountInfoResponseDataDTO'
        additionalValues:
          $ref: '#/components/schemas/GenericDataRecordDTO'
        packages:
          type: array
          description: Information about the packages of the shipment.
          items:
            $ref: '#/components/schemas/DLPackageResponseDataDTO'
        items:
          type: array
          description: Information about the items of the shipment.
          items:
            $ref: '#/components/schemas/DLShipmentItemResponseDataDTO'
        referencesTexts:
          type: array
          description: Further references and texts for the shipment. Multiple references or texts with same type are allowed (e.g. to specify all different delivery note numbers contained in the shipment).
          items:
            $ref: '#/components/schemas/DLReferenceTextDTO'
        transportEquipments:
          type: array
          description: The transport equipment of the shipment.
          items:
            $ref: '#/components/schemas/DLTransportEquipmentDTO'
        templateName:
          type: string
          description: Information about the template initially used when creating the shipment. Empty if no template was used.
        isHazardousGoodsShipment:
          type: boolean
          description: Indicates whether the shipment is a hazardous goods shipment or not.
        isContainingSpecialSubstances:
          type: boolean
          description: Indicates whether the shipment is containing special substances or not.
        documents:
          type: array
          description: Documents for the shipment
          items:
            $ref: '#/components/schemas/DLDocumentDTO'
        houseAirwaybillNumber:
          type: string
          description: The house airwaybill number identifies a single shipping order within the cargo of an aircraft. <p> length=35 </p>
        masterAirwaybillNumber:
          type: string
          description: The master airwaybill number identifies the cargo of a complete aircraft. <p> length=35 </p>
        airline:
          type: string
          description: The name of the airline company. <p> length=35 </p>
        flightNumber:
          type: string
          description: The flight number specifies a specific flight of an airline. <p> length=20 </p>
      description: DTO for response information of a DLShipment.<br> Contains also errors that occurred during carrier data preparation (performed asynchronously by a job). These are returned as warnings.<br> Validation errors may also occur. For possible codes see DLCreateShipmentResponseDTO.
    DLHazardousGoodsItemResponseDataDTO:
      type: object
      properties:
        unNumber:
          type: string
          description: UN number <p> length=8 </p>
        hazardRegulation:
          type: string
          description: 'Hazardous regulation to be applied. Valid values are: <ul> <li>ADR</li> <li>ADG</li> <li>NZDG</li> <li>IATA</li> <li>IMDG</li> <li>TDG</li> <li>CFR</li> </ul> <p> length=10 <p>'
        technicalName:
          type: string
          description: Technical name <p> length=250 </p>
        hazardAdditionalDescription:
          type: string
          description: Additional description <p> length=250 <p>
        hazardousGoodsType:
          type: string
          description: "The type of hazardous goods. Possible values are: <li>UNDEFINED (not defined, the type is determined by the hazardous good's package) <li>NORMAL \t(hazardous goods) <li>EQ\t\t(excepted quantities) <li>LQ\t\t(limited quantities)"
        hazardClass:
          type: string
          description: 'Hazardous class. Valid values are: <ul> <li>1</li> <li>1.1</li> <li>1.2</li> <li>1.3</li> <li>1.4</li> <li>1.5</li> <li>1.6</li> <li>2</li> <li>2.1</li> <li>2.2</li> <li>2.3</li> <li>3</li> <li>4</li> <li>4.1</li> <li>4.2</li> <li>4.3</li> <li>5</li> <li>5.1</li> <li>5.2</li> <li>6</li> <li>6.1</li> <li>6.2</li> <li>7</li> <li>7A</li> <li>7B</li> <li>7C</li> <li>7E</li> <li>8</li> <li>9</li> <li>NONE</li> </ul> <p> length=10 <p>'
        subriskClass1:
          type: string
          description: 'Sub risk 1 hazardous class. Valid values are: <ul> <li>1</li> <li>1.1</li> <li>1.2</li> <li>1.3</li> <li>1.4</li> <li>1.5</li> <li>1.6</li> <li>2</li> <li>2.1</li> <li>2.2</li> <li>2.3</li> <li>3</li> <li>4</li> <li>4.1</li> <li>4.2</li> <li>4.3</li> <li>5</li> <li>5.1</li> <li>5.2</li> <li>6</li> <li>6.1</li> <li>6.2</li> <li>7</li> <li>7A</li> <li>7B</li> <li>7C</li> <li>7E</li> <li>8</li> <li>9</li> <li>NONE</li> </ul> <p> length=10 <p>'
        subriskClass2:
          type: string
          description: 'Sub risk 2 hazardous class.Valid values are: <ul> <li>1</li> <li>1.1</li> <li>1.2</li> <li>1.3</li> <li>1.4</li> <li>1.5</li> <li>1.6</li> <li>2</li> <li>2.1</li> <li>2.2</li> <li>2.3</li> <li>3</li> <li>4</li> <li>4.1</li> <li>4.2</li> <li>4.3</li> <li>5</li> <li>5.1</li> <li>5.2</li> <li>6</li> <li>6.1</li> <li>6.2</li> <li>7</li> <li>7A</li> <li>7B</li> <li>7C</li> <li>7E</li> <li>8</li> <li>9</li> <li>NONE</li> </ul> <p> length=10 <p>'
        classificationCode:
          type: string
          description: Classification code <p> length=4 <p>
        tunnelCode:
          type: string
          description: Tunnel code <p> length=10 <p>
        packagingGroup:
          type: string
          description: 'Hazardous packaging group. Valid values are: <ul> <li>NONE</li> <li>I</li> <li>II</li> <li>III</li> </ul> <p> length=10 <p>'
        packingInstruction:
          type: string
          description: IATA packing instruction. Consists of the instruction code (up to three digits with optional prefix Y) optionally followed by a section identification (up to two upper case characters). <p> length=10 </p>
        specialProvision:
          type: string
          description: 'Special provisions for the carriage of hazardous goods. Consists of the provision code (up to three digits) or the chapter specification (up to three digits), optionally followed by sub-chapters (up to two digits or one digit and an upper case character). Chapter and subchapters must be separated by a dot. Also possible are 3 capital letters + hyphen, followed by further numbers or letters or 1 capital letter followed by numbers. Example Values are: <ul> <li>188</li> <li>2.2.9.1.7</li> <li>63.3A</li> <li>USG-...</li> <li>A213</li> </ul> <p> length=20 </p>'
        multiplicator:
          type: string
          description: Hazardous multiplicator <p> length=10 <p>
        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>
        hazardWeight:
          $ref: '#/components/schemas/QuantityDTO'
        hazardNetQuantity:
          $ref: '#/components/schemas/QuantityDTO'
        netExp

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