PHP Class Smalot\Magento\Order\OrderShipment

Inheritance: extends Smalot\Magento\MagentoModuleAbstract
Show file Open project: smalot/magento-client

Public Methods

Method Description
addComment ( string $shipmentIncrementId, string $comment = null, string $email = null, string $includeInEmail = null ) : Smalot\Magento\ActionInterface Allows you to add a new comment to the order shipment.
addTrack ( string $shipmentIncrementId, string $carrier, string $title, string $trackNumber ) : Smalot\Magento\ActionInterface Allows you to add a new tracking number to the order shipment.
create ( string $orderIncrementId, string $itemsQty = null, string $comment = null, integer $email = null, integer $includeComment = null ) : Smalot\Magento\ActionInterface Allows you to create a new shipment for an order.
getCarriers ( string $orderIncrementId ) : Smalot\Magento\ActionInterface Allows you to retrieve the list of allowed carriers for an order.
getInfo ( $shipmentIncrementId ) : Smalot\Magento\ActionInterface Allows you to retrieve the shipment information.
getList ( array $filters ) : Smalot\Magento\ActionInterface Allows you to retrieve the list of order shipments.
removeTrack ( string $shipmentIncrementId, string $trackId ) : Smalot\Magento\ActionInterface Allows you to remove a tracking number from the order shipment.

Method Details

addComment() public method

Allows you to add a new comment to the order shipment.
public addComment ( string $shipmentIncrementId, string $comment = null, string $email = null, string $includeInEmail = null ) : Smalot\Magento\ActionInterface
$shipmentIncrementId string
$comment string
$email string
$includeInEmail string
return Smalot\Magento\ActionInterface

addTrack() public method

Allows you to add a new tracking number to the order shipment.
public addTrack ( string $shipmentIncrementId, string $carrier, string $title, string $trackNumber ) : Smalot\Magento\ActionInterface
$shipmentIncrementId string
$carrier string
$title string
$trackNumber string
return Smalot\Magento\ActionInterface

create() public method

Allows you to create a new shipment for an order.
public create ( string $orderIncrementId, string $itemsQty = null, string $comment = null, integer $email = null, integer $includeComment = null ) : Smalot\Magento\ActionInterface
$orderIncrementId string
$itemsQty string
$comment string
$email integer
$includeComment integer
return Smalot\Magento\ActionInterface

getCarriers() public method

Allows you to retrieve the list of allowed carriers for an order.
public getCarriers ( string $orderIncrementId ) : Smalot\Magento\ActionInterface
$orderIncrementId string
return Smalot\Magento\ActionInterface

getInfo() public method

Allows you to retrieve the shipment information.
public getInfo ( $shipmentIncrementId ) : Smalot\Magento\ActionInterface
$shipmentIncrementId
return Smalot\Magento\ActionInterface

getList() public method

Additional filters can be applied.
public getList ( array $filters ) : Smalot\Magento\ActionInterface
$filters array
return Smalot\Magento\ActionInterface

removeTrack() public method

Allows you to remove a tracking number from the order shipment.
public removeTrack ( string $shipmentIncrementId, string $trackId ) : Smalot\Magento\ActionInterface
$shipmentIncrementId string
$trackId string
return Smalot\Magento\ActionInterface