ePages 6.11.0 - DE_EPAGES/ExternalShipping/API/Shop.pm

Package DE_EPAGES::ExternalShipping::API::Shop

Public API Methods for Shop class

Base
Exporter
@EXPORT_OK
GetShippingFulfillmentMethodsFolder
GetShippingTransactionsFolder
GetShippingOrdersFolder
GetCurrentShippingOrder
GetShippingOrderLabels
ShippingOrderToTransaction

Functions

GetCurrentShippingOrder
GetShippingFulfillmentMethodsFolder
GetShippingOrderLabels
GetShippingOrdersFolder
GetShippingTransactionsFolder

GetCurrentShippingOrder

Returns the ShippingTransaction containing the current ShippingOrder

Syntax
$Transaction = GetCurrentShippingOrder( $Shop, $ShippingFulfillmentType );
Input
$Shop (object)
shop object
$ShippingFulfillmentType (object)
ShippingFulfillmentType
Return
$Folder (object)
folder object for ShippingTransactions

GetShippingFulfillmentMethodsFolder

Returns the folder of ShippingFulfillment methods

Syntax
$Folder = GetShippingFulfillmentMethodsFolder( $Shop );
Input
$Shop (object)
shop object
Return
$Folder (object)
folder object for ShippingFulfillment methods

GetShippingOrderLabels

returns the list of ShippingLabel objects, that are currently in our shipping order

Syntax
$aLabels = GetShippingOrderLabels( $Shop );
Input
$Shop (object)
shop object
$ShippingFulfillmentType (object)
ShippingFulfillmentType
Return
$aLabels (ref.array.object)
all shipping labels in shipping order

GetShippingOrdersFolder

Returns the folder where all active shippingorders are stored.

Syntax
GetShippingOrdersFolder( $Shop, $ShippingFulfillmentType );
Input
$Shop (object)
shop
$ShippingFulfillmentType (object)
ShippingFulfillmentType
Return
$Folder (object)
folder

GetShippingTransactionsFolder

Returns the folder of ShippingTransactions

Syntax
$Folder = GetShippingTransactionsFolder( $Shop );
Input
$Shop (object)
shop object
$ShippingFulfillmentType (object)
ShippingFulfillmentType
Return
$Folder (object)
folder object for ShippingTransactions