ePages 6.11.0 - DE_EPAGES/ExternalShipping/API/Object/ShippingTransaction.pm

Package DE_EPAGES::ExternalShipping::API::Object::ShippingTransaction

object interface for ShippingTransaction.

Base
DE_EPAGES::Object::API::Object::Object

Functions

className
dbPackage
export
exportDriver
importHandler
importTracking
issueShippingOrder
items
prepareShippingOrder
redirectTransaction
validateTransaction

className

Returns the class name, used for DAL access.

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

dbPackage

Returns the database package, used for DAL access.

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

export

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

Syntax
$ShippingTransaction->export();

exportDriver

Returns shipping label export driver

Syntax
$Transaction->exportDriver( );
Return
$Driver (string)
Export driver classname

importHandler

Returns shipping label import handler

Syntax
$Transaction->importHandler( );
Return
$Handler (string)
Import handler classname

importTracking

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
$Transaction->importTracking( );
Input
$ImportFile (object)
reference to an import file

issueShippingOrder

saves shipping order to ShippingTransactions folder and sets alias to match current date.

Syntax
$Transaction->issueShippingOrder();
Input
$hInfo (ref.hash)
save info

items

Returns all shipping label IDs of one shipping transaction. Used for exporting shipping transactions

Syntax
$Transaction->items();
Return
$ShippingLabelIDs (ref.array.integer)
shipping label objectids

prepareShippingOrder

Sets IsTestTransaction to match current settings on ShippingFulfillmentMethod

Syntax
$Transaction->prepareShippingOrder( $Input1 );

redirectTransaction

Does a redirect if ShippingFulfillment integration uses redirection for generating shipping labels. Has to be implemented in child class, if ShippingFulfillmentType.IntegrationType=Redirect

Syntax
$Transaction->redirectTransaction();
Input
$Servlet (object)
servlet

validateTransaction

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

Syntax
$Transaction->validateTransaction();