PHP Class Smalot\Magento\Order\Order

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

Public Methods

Method Description
addComment ( string $orderIncrementId, string $status, string $comment = null, string $notify = null ) : Smalot\Magento\ActionInterface Allows you to add a new comment to the order.
cancel ( string $orderIncrementId ) : Smalot\Magento\ActionInterface Allows you to cancel the required order.
getInfo ( string $orderIncrementId ) : Smalot\Magento\ActionInterface Allows you to retrieve the required order information.
getList ( array $filters ) : Smalot\Magento\ActionInterface Allows you to retrieve the list of orders. Additional filters can be applied.
hold ( string $orderIncrementId ) : Smalot\Magento\ActionInterface Allows you to place the required order on hold.
unhold ( string $orderIncrementId ) : Smalot\Magento\ActionInterface Allows you to unhold the required order.

Method Details

addComment() public method

Allows you to add a new comment to the order.
public addComment ( string $orderIncrementId, string $status, string $comment = null, string $notify = null ) : Smalot\Magento\ActionInterface
$orderIncrementId string
$status string
$comment string
$notify string
return Smalot\Magento\ActionInterface

cancel() public method

Allows you to cancel the required order.
public cancel ( string $orderIncrementId ) : Smalot\Magento\ActionInterface
$orderIncrementId string
return Smalot\Magento\ActionInterface

getInfo() public method

Allows you to retrieve the required order information.
public getInfo ( string $orderIncrementId ) : Smalot\Magento\ActionInterface
$orderIncrementId string
return Smalot\Magento\ActionInterface

getList() public method

Allows you to retrieve the list of orders. Additional filters can be applied.
public getList ( array $filters ) : Smalot\Magento\ActionInterface
$filters array
return Smalot\Magento\ActionInterface

hold() public method

Allows you to place the required order on hold.
public hold ( string $orderIncrementId ) : Smalot\Magento\ActionInterface
$orderIncrementId string
return Smalot\Magento\ActionInterface

unhold() public method

Allows you to unhold the required order.
public unhold ( string $orderIncrementId ) : Smalot\Magento\ActionInterface
$orderIncrementId string
return Smalot\Magento\ActionInterface