ePages 6.17.39 - DE_EPAGES/UPS/API/Object/ShippingLabelUPS.pm

Package DE_EPAGES::UPS::API::Object::ShippingLabelUPS

object interface for ShippingLabelUPS.

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

Functions

className
dbPackage
generateTrackingLink
isValid
testRequest
validateLabel

className

Returns the class name, used for DAL access.

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

dbPackage

Returns the database package, used for DAL access.

Syntax
$DbPackage = $ShippingLabelUPS->dbPackage;
Return
$DbPackage (String)
database package name

generateTrackingLink

Returns tracking link

Syntax
$TrackingLink = $ShippingLabel->generateTrackingLink( );
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

testRequest

Calls the UPS Webservice

Syntax
testRequest( $ShippingLabel );
Input
$ShippingLabel (object)
ShippingLabel object
Return
$hStatus (refhash)
Some Information about the posible ShippingLable

validateLabel

Validates shipping label before the transaction will created . Throws an error if mandatory values are missing.

Syntax
$ShippingLabel->validateLabel();