Package DE_EPAGES::ExternalShipping::API::Object::ShippingFulfillmentMethod
object interface for ShippingFulfillmentMethod.
Base |
DE_EPAGES::Shop::API::Object::ShopObject |
Functions
- addMandatoryAddressFields
- addVisibleAddressFields
- className
- dbPackage
- getSizeUnit
- getWeightUnit
- isLineItemSupported
- isUsable
- newShippingLabel
addMandatoryAddressFields
Makes certains address fields mandatory. For now this method only supports shipping address fields but it can be extended to support other address fields such as delivery address fields or shop address fields.
Syntax |
addMandatoryAddressFields( $aShippingAddressFields ); |
Input |
|
addVisibleAddressFields
Makes certains address fields visible. For now this method only supports shipping address fields but it can be extended to support other address fields such as delivery address fields or shop address fields.
Syntax |
addVisibleAddressFields( $aShippingAddressFields ); |
Input |
|
className
Returns the class name, used for DAL access.
Syntax |
$ClassName = $ShippingFulfillmentMethod->className; |
Return |
|
dbPackage
Returns the database package, used for DAL access.
Syntax |
$DbPackage = $ShippingFulfillmentMethod->dbPackage; |
Return |
|
getSizeUnit
Returns the UnitsOfMeasurement object that represents the units system
to use for the shipping size.
By default this method returns the 'SizeUnit' attribute defined by the
ExternalShipping specific cartridge.
See in CARTRIDGE_NAME/Database/XML/ShippingFulfillmentTypes.xml
Also a cartridge could implement its own getSizeUnit() method if needs
to determine the unit dynamically (!)
Syntax |
$SizeUnit = $ShippingFulfillmentMethod->getSizeUnit() ; |
Return |
|
getWeightUnit
Returns the UnitsOfMeasurement object that represents the units system
to use for the shipping weight.
By default this method returns the 'WeightUnit' attribute defined by the
ExternalShipping specific cartridge.
See in CARTRIDGE_NAME/Database/XML/ShippingFulfillmentTypes.xml
Also a cartridge could implement its own getSizeUnit() method if needs
to determine the unit dynamically (!)
Syntax |
$WeightUnit = $ShippingFulfillmentMethod->getWeightUnit() ; |
Return |
|
isLineItemSupported
Returns true if this lineitem type is supported by this shipping fulfillment method Used for filtering out lineitems that are not meant to be shipped.
Syntax |
$ShippingFulfillmentMethod->isLineItemSupported( $LineItem ); |
Input |
|
Return |
|
isUsable
Checks if ShippingFulfillmentMethod is usable
Syntax |
isUsable( ); |
Return |
|
newShippingLabel
Creates a new shipping label, using the class ShippingType.ShippingLabelClass. This label is saved to the folder 'ShippingLabels' Either an order or an order document can be provided as template to clone from.
Syntax |
$FulfillmentMethod->newShippingLabel( $Order ); $FulfillmentMethod->newShippingLabel( $OrderDocument ); |
Input |
|
Return |
|