ePages 6.17.13 - DE_EPAGES/SDA/API/Object/ShippingLabelSDA.pm

Package DE_EPAGES::SDA::API::Object::ShippingLabelSDA

object interface for ShippingLabelSDA.

Base
DE_EPAGES::ExternalShipping::API::Object::ShippingLabel
@EXPORT_OK
STANDARD_SHIPPING
INTERNATIONAL_SHIPPING

Functions

className
generateTrackingLink
isValid
validateLabel

className

Returns the class name, used for DAL access.

Syntax
$ClassName = $ShippingLabelSDA->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

isValid

checks the existance of all mandatory input fields by calling $ShippingLabel->validate();

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();