ePages 6.14.0 - DE_EPAGES/FedEx/API/Tools.pm

Package DE_EPAGES::FedEx::API::Tools

This package provides the FedEx global functionality.

@EXPORT_OK
GetLabelImagePath
IsValidCombination
IsPickPostAllowed
IsValidAddressCountry
MandatoryPickPostFieldsVisible
AreMandatoryShippingFieldsSet

Functions

AreMandatoryShippingFieldsSet
GetLabelImagePath
IsPickPostAllowed
IsValidAddressCountry
IsValidCombination

AreMandatoryShippingFieldsSet

checks all required fields are mandatory in the shop

Syntax
$IsAllowed = AreMandatoryShippingFieldsSet($Shop);
Example
my $IsAllowed  = AreMandatoryShippingFieldsSet($Shop);
Input
#Shop (object)
shop object
Return
#Value (boolean)
1 or 0

GetLabelImagePath

returns the path for the barcode image of a shipping label

Syntax
$Path = GetLabelImagePath($ShippingLabel,$FileExtension);
Example
my $Path  = GetLabelImagePath($ShippingLabel,'gif');
Input
#ShippingLabel (object)
shipping label object
#FileExtension (string)
image file extension
Return
#Path (string)
path and image name

IsPickPostAllowed

checks if the pick post delivery is allowed for this shippingmethod

Syntax
$IsAllowed = IsPickPostAllowed($ShippingMethod);
Example
my $IsAllowed  = IsPickPostAllowed($ShippingMethod);
Input
#ShippingMethod (object)
shipping method object
Return
#Value (boolean)
1 or 0

IsValidAddressCountry

checks if the shipping address is usable

Syntax
$IsAllowed = IsValidAddressCountry($Address);
Example
my $IsAllowed  = IsValidAddressCountry($Address);
Input
#Address (object)
address object
Return
#Value (boolean)
1 or 0

IsValidCombination

checks if the combination of shipping fullfilment product and shipping fullfilment option is valid

Syntax
$IsValid = IsValidCombination($ShippingFulfillmentProduct,$ShippingFulfillmentOption);
Example
my $IsValid  = IsValidCombination($ShippingFulfillmentProduct,$ShippingFulfillmentOption);
Input
#ShippingFulfillmentProduct (object)
shipping fullfillment product object
#ShippingFulfillmentOption (object)
shipping fullfillment option object
Return
#Value (boolean)
1 or 0