PHP Class Smalot\Magento\Order\OrderCreditMemo

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

Public Methods

Method Description
addComment ( string $creditmemoIncrementId, string $comment = null, string $notifyCustomer = null, string $includeComment = null ) : Smalot\Magento\ActionInterface Allows you to add a new comment to an existing credit memo.
cancel ( string $creditmemoIncrementId ) : Smalot\Magento\ActionInterface Allows you to cancel an existing credit memo.
create ( string $orderIncrementId, array $creditmemoData = null, string $comment = null, integer $notifyCustomer = null, integer $includeComment = null, string $refundToStoreCreditAmount = null ) : Smalot\Magento\ActionInterface Allows you to create a new credit memo for the invoiced order.
getInfo ( string $creditmemoIncrementId ) : Smalot\Magento\ActionInterface Allows you to retrieve full information about the specified credit memo.
getList ( array $filters ) : Smalot\Magento\ActionInterface Allows you to retrieve the list of credit memos by filters.

Method Details

addComment() public method

Email notification can be sent to the user email.
public addComment ( string $creditmemoIncrementId, string $comment = null, string $notifyCustomer = null, string $includeComment = null ) : Smalot\Magento\ActionInterface
$creditmemoIncrementId string
$comment string
$notifyCustomer string
$includeComment string
return Smalot\Magento\ActionInterface

cancel() public method

Allows you to cancel an existing credit memo.
public cancel ( string $creditmemoIncrementId ) : Smalot\Magento\ActionInterface
$creditmemoIncrementId string
return Smalot\Magento\ActionInterface

create() public method

Comments can be added and an email notification can be sent to the user email.
public create ( string $orderIncrementId, array $creditmemoData = null, string $comment = null, integer $notifyCustomer = null, integer $includeComment = null, string $refundToStoreCreditAmount = null ) : Smalot\Magento\ActionInterface
$orderIncrementId string
$creditmemoData array
$comment string
$notifyCustomer integer
$includeComment integer
$refundToStoreCreditAmount string
return Smalot\Magento\ActionInterface

getInfo() public method

Allows you to retrieve full information about the specified credit memo.
public getInfo ( string $creditmemoIncrementId ) : Smalot\Magento\ActionInterface
$creditmemoIncrementId string
return Smalot\Magento\ActionInterface

getList() public method

Allows you to retrieve the list of credit memos by filters.
public getList ( array $filters ) : Smalot\Magento\ActionInterface
$filters array
return Smalot\Magento\ActionInterface