ePages 6.11.0 - DE_EPAGES/DHL/API/DHLShippingLabel.pm

Package DE_EPAGES::DHL::API::DHLShippingLabel

object interface for the Order Document DHLShippingLabel.

Base
Exporter
@EXPORT_OK
CreateNewDHLShippingLabel
CreateNewSubDHLShippingLabel
FindPartialShipmentItems
CheckPartialShipment

Functions

CheckPartialShipment
CreateNewDHLShippingLabel
CreateNewSubDHLShippingLabel
FindPartialShipmentItems

CheckPartialShipment

Checks if another DHL shipping label can be created using open quantities

Syntax
CheckPartialShipment( $Order );
Input
$Order (object)
order
Return
$CheckResult (boolean)
True if open quantities exist, False if none.

CreateNewDHLShippingLabel

Creates a new DHL shipping label for an order

Syntax
CreateNewDHLShippingLabel( $Order, { 'item001' => 1 } );
Input
$Order (object)
order
$hQuantities (ref.hash.integer)
force quantities for partial shipping
Return
$Label (object)
DHL shipping label

CreateNewSubDHLShippingLabel

Creates a new DHL shipping label for an order that already contains a shipping label. This requires calculating the remaining quantities of the lineitems that haven't been shipped already.

Syntax
CreateNewSubDHLShippingLabel(  $Order );
Input
$Order (object)
order
Return
$Label (object)
DHL shipping label

FindPartialShipmentItems

Returns open quantities from given orde rfor another DHL shipping label

Syntax
FindPartialShipmentItems( $Order, $DHLShippingLabelExclude );
Input
$Order (object)
order
Return
$hOpenQuantities (ref.hash.int)
open quantities list. Hash structure is:
LineItemAlias => Quantity