ePages 6.17.12 - DE_EPAGES/USPS/API/Object/ShippingLabelUSPS.pm

Package DE_EPAGES::USPS::API::Object::ShippingLabelUSPS

object interface for ShippingLabelUSPS.

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

Functions

className
dbPackage
generateTrackingLink
isValid
validateLabel

className

Returns the class name, used for DAL access.

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

dbPackage

Returns the database package, used for DAL access.

Syntax
$DbPackage = $ShippingLabelUSPS->dbPackage;
Return
$DbPackage (String)
database package 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();