Class DLPackageResponseDataDTO

java.lang.Object
de.aeb.xnsg.foundation.bf.AbstractResponseItemDTO
de.aeb.xnsg.dl.bf.DLPackageResponseDataDTO

public class DLPackageResponseDataDTO extends AbstractResponseItemDTO
DTO for response information of a DLPackage.
Contains also errors that occurred during carrier data preparation (performed asynchronously by a job). These are returned as warnings.
Validation errors may also occur. For possible codes see DLPackageProcessingResultDTO
  • Field Details

    • DL_PREPARATION_NO_CARRIER_PACKAGE_NUMBER

      public static final String DL_PREPARATION_NO_CARRIER_PACKAGE_NUMBER
      Possible messageIdentCode: "DL_PREPARATION_NO_CARRIER_PACKAGE_NUMBER": The carrier's package number (tracking number) could not be computed.
      See Also:
    • packageNumber

      public Integer packageNumber
      The unique package number of the package generated by the carrier engine.

      length=4

    • packageTransactionId

      public String packageTransactionId
      The unique transaction id of the package maintained by the client system.

      length=50

    • referenceNumber1

      public String referenceNumber1
      The first reference number of the package.

      length=50

    • referenceNumber2

      public String referenceNumber2
      The second reference number of the package.

      length=50

    • carrierPackageNumber

      public String carrierPackageNumber
      The package number given by the carrier. Usually the tracking number.

      length=50

    • carrierPackageIdentBarcode

      public String carrierPackageIdentBarcode
      The content of the barcode identifying the package as defined by the carrier. The carrierPackageNumber is most likely part of the carrierPackageIdentBarcode and for same carrier it is identical. However, this depends solely on the carriers' specification. NOTE: this is currently in BETA phase and only supported for a very small number of carriers.

      length=50

    • carrierPackageNumberReturn

      public String carrierPackageNumberReturn
      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.

      length=50

    • carrierTrackingURL

      public String carrierTrackingURL
      The tracking URL of the package.

      length=512

    • carrierTrackingURLReturn

      public String carrierTrackingURLReturn
      The additional return tracking URL of the package.

      length=512

    • packageTypeIdentCode

      public String packageTypeIdentCode
      IdentCode of the package type. Valid values are depending on the client's package types in the master file data.

      length=20

    • contents

      public String contents
      The description of the contents (goods) the package contains.

      length=250

    • dimensions

      public DLCuboidDimensionsDTO dimensions
      Dimensions
    • grossWeight

      public QuantityDTO grossWeight
      Gross weight
    • codValue

      public AmountOfMoneyDTO codValue
      The cash on delivery value. Only filled when carrier needs them on package level.
    • insuranceValue

      public AmountOfMoneyDTO insuranceValue
      Insurance value of the package
    • boStatus

      public ComboboxEntryDTO boStatus

      The package's current status. Possible values are:

    • NEW This status is reached as soon as the package is created.
    • DATAREADY Package status "data ready for printing labels". This status is reached when the package is ready for printing labels.

    • additionalValues

      public GenericDataRecordDTO additionalValues
      The additional values for the package. For the semantics of the returned field names lookup customizing in GUI or use the getCarrierProperties business facade call.
    • documents

      public DLDocumentDTO[] documents
      The documents for the package. Only filled when asked for in request.
    • hazardousGoodsData

      public DLPackageHazardousGoodsDataResponseDTO hazardousGoodsData
      Hazardous goods data concerning the package. Only relevant when shipping hazardous goods.
    • marks

      public String marks
      Marks and numbers for identification of a package.

      length=50

    • stackability

      public String stackability

      The possibility to stack this package. If there is no such information, the value will be empty. Otherwise the possible values are:

    • STACKABLE
    • UNSTACKABLE


    • freightClass

      public String freightClass
      The freight class of the package according to the NMFC (National Motor Freight Classification) specification. Relevant for US carriers. Valid values are:
      • 50
      • 55
      • 60
      • 65
      • 70
      • 77.5
      • 85
      • 92.5
      • 100
      • 110
      • 125
      • 150
      • 175
      • 200
      • 250
      • 300
      • 400
      • 500
      • NONE
    • nmfcCode

      public String nmfcCode
      The NMFC code of the package. Relevant for US carriers.

      length=10

    • nmfcSubCode

      public String nmfcSubCode
      The NMFC subcode of the package. Relevant for US carriers.

      length=2

  • Constructor Details

    • DLPackageResponseDataDTO

      public DLPackageResponseDataDTO()