ePages 7.21.0 - DE_EPAGES/DHLIntraship/API/Object/ShippingLabelDHLIntraship.pm

Package DE_EPAGES::DHLIntraship::API::Object::ShippingLabelDHLIntraship

object interface for ShippingLabelDHLIntraship.

Base
DE_EPAGES::ExternalShipping::API::Object::ShippingLabel

Functions

className
generateTrackingLink
isDefined
isValid
validateLabel

className

Returns the class name, used for DAL access.

Syntax
$ClassName = $ShippingLabelDHLIntraship->className;
Return
$ClassName (String)
class name

generateTrackingLink

Returns tracking link generated from template MBO/ShippingLabel/TrackingLink.txt

Syntax
$TrackingLink = $ShippingLabel->generateTrackingLink( $LangCode );
Return
$TrackingLink (string)
tracking link

isDefined

wrapping the isValid Function from PerlTools because in the external Shipping Frame work is a second Method with the same name

Syntax
isDefined( $Value );
Input
$Value (string)
a String
Return
$Valid (boolean)
parameter is simple valid

isValid

checks that label is processable through DHL web services $ShippingLabel->validateLabel();

Syntax
$ShippingLabel->isValid();
Return
$IsValid - true if shipping label validates - boolean

validateLabel

Validates shipping label. Throws an error if mandatory values are missing.

Syntax
$ShippingLabel->validateLabel();