ePages 6.17.40 - DE_EPAGES/GLS/API/Object/ShippingFulfillmentMethodGLSFreight.pm

Package DE_EPAGES::GLS::API::Object::ShippingFulfillmentMethodGLSFreight

Class for shipping fulfillment connection

Base
DE_EPAGES::ExternalShipping::API::Object::ShippingFulfillmentMethod

Functions

areMandatoryShippingFieldsSet
exportTransaction
featureName
importTransaction
isUsable
webserviceDoTransaction

areMandatoryShippingFieldsSet

Checks if mandatory shipping address fields are set into basket registration settings

Syntax
$areMandatoryShippingFieldsSet = $ShippingFulfillmentMethod->areMandatoryShippingFieldsSet( );
Return
$areMandatoryShippingFieldsSet (boolean)
True if mandatory shipping address fields are set

exportTransaction

Does a csv export if ShippingFulfillment integration uses an export file for generating shipping labels. Has to be implemented in child class, if ShippingFulfillmentType.IntegrationType =~ m/Export/

Syntax
$ShippingFulfillmentMethod->exportTransaction( $Transaction );
Input
$Transaction (object)
shipping transaction

featureName

Returns undef as no feature is connected to this ShippingFulfillmentMethod.

Syntax
$FeatureName = $ShippingFulfillmentMethod->featureName;
Return
$FeatureName (String)
feature name (undef means no feature count)

importTransaction

Does an import if ShippingFulfillment integration uses an import file for assigning tracking numbers to orders. Has to be implemented in child class, if ShippingFulfillmentType.IntegrationType =~ m/Import/

Syntax
$ShippingFulfillmentMethod->importTransaction( $Transaction );
Input
$Transaction (object)
shipping transaction
$ImportFile (object)
reference to an import file

isUsable

Checks if ShippingFulfillmentMethod is usable

Syntax
$isUsable = $ShippingFulfillmentMethod->isUsable( );
Return
$IsUsable (boolean)
True if ShippingFulfillmentMethod is usable

webserviceDoTransaction

Calls execution webservice for one transaction. Has to be implemented in child class, if ShippingFulfillmentType.IntegrationType=Webservice

Syntax
($success, $errorMsg) = $ShippingFulfillmentMethod->webserviceDoTransaction( $Transaction );
Input
$Transaction (object)
shipping transaction
Return
$success (boolean)
boolean indicating if transaction process was successful
$errorMsg (string)
string indicating why the transaction was unsuccessful