ePages 6.17.39 - DE_EPAGES/DHL/API/TLE/DHLHandler.pm

Package DE_EPAGES::DHL::API::TLE::DHLHandler

TLE Handler for DHL Tracking Information

Functions

DHLGetDisplayNameByProductID
DHLIsDeliveryDestInDB
DHLTrackingEvents
tle

DHLGetDisplayNameByProductID

Get display name for product id

Syntax
#DHLGetDisplayNameByProductID(#ProductId)
Example
#DHLGetDisplayNameByProductID(#ProductId)
Input
$Processor (object)
TLE processor
$aParams (array)
#ProductId
Return
#DisplayName (string)
Display name for product id

DHLIsDeliveryDestInDB

Checks if the delivery destination can be found the database. If not the merchant has to get his shipping label via DHL marketplace

Syntax
#DHLIsDeliveryDestInDB(#ShippingLabelID)
Example
#IF(NOT #DHLIsDeliveryDestInDB(#DHLShippingLabel.ID)) .. #ENDIF
Input
$Processor (object)
TLE processor
$aParams (array)
#ShippingLabelID
Return
$InDB (boolean)
1 if delivery destination is in the DB

DHLTrackingEvents

Loops over a list of all DHL shipping labels for one order to find all available tracking events. Available keys are:

  • IssueDate - ShippingLabel.IssueDate
  • LabelId - ShippingLabel.LabelId
  • ShipmentId - ShippingLabel.ShipmentId
  • NoTracking - true if no tracking information is available

    Syntax
    #DHLTrackingEvents(#OrderID)
    Example
    #LOOP(#DHLTrackingEvents(#OrderID)) .. #ENDLOOP
    Input
    $Processor (object)
    TLE processor
    $aParams (array)
    #OrderID
    Return
    @List (array)
    list of tracking events

    tle

    Register TLEs: #DHLMinShippingLengthFromDB
    #DHLMaxShippingLengthFromDB
    #DHLMinShippingWidthFromDB
    #DHLMaxShippingWidthFromDB
    #DHLMinShippingHeightFromDB
    #DHLMaxShippingHeightFromDB
    #DHLMinShippingWeightFromDB
    #DHLMaxShippingWeightFromDB

    Syntax
    $Value = $Handler->tle( $Processor, $TLEName);
    Input
    $Processor (object)
    tle processor
    $TLEName (string)
    tle name
    Return
    $Value (integer)
    return value