Class Mage_Sales_Model_Order_Creditmemo_Api

Credit memo API

Mage_Sales_Model_Order_Creditmemo_Api

Direct known subclasses

Mage_Sales_Model_Order_Creditmemo_Api_V2

Package: Mage\Sales
Category: Mage
Copyright: Copyright (c) 2012 Magento Inc. (http://www.magentocommerce.com)
License: Open Software License (OSL 3.0)
Author: Magento Core Team <core@magentocommerce.com>
Located at code/core/Mage/Sales/Model/Order/Creditmemo/Api.php

Methods summary
`public`	# `__construct( )` Initialize attributes mapping Initialize attributes mapping
`public array`	# `items( null\|object\|array $filters = null )` Retrieve credit memos list. Filtration could be applied Retrieve credit memos list. Filtration could be applied Parameters `$filters` `null\|object\|array` $filters Returns `array`
`public array`	# `info( string $creditmemoIncrementId )` Retrieve credit memo information Retrieve credit memo information Parameters `$creditmemoIncrementId` `string` $creditmemoIncrementId Returns `array`
`public string`	# `create( string $creditmemoIncrementId, array $creditmemoData = null, string\|null $comment = null, boolean $notifyCustomer = false, boolean $includeComment = false, string $refundToStoreCreditAmount = null )` Create new credit memo for order Create new credit memo for order Parameters `$creditmemoIncrementId` `string` $creditmemoIncrementId `$creditmemoData` `array` $creditmemoData array('qtys' => array('sku1' => qty1, ... , 'skuN' => qtyN), 'shipping_amount' => value, 'adjustment_positive' => value, 'adjustment_negative' => value) `$comment` `string\|null` $comment `$notifyCustomer` `boolean` $notifyCustomer `$includeComment` `boolean` $includeComment `$refundToStoreCreditAmount` `string` $refundToStoreCreditAmount Returns `string` $creditmemoIncrementId
`public boolean`	# `addComment( string $creditmemoIncrementId, string $comment, boolean $notifyCustomer = false, boolean $includeComment = false )` Add comment to credit memo Add comment to credit memo Parameters `$creditmemoIncrementId` `string` $creditmemoIncrementId `$comment` `string` $comment `$notifyCustomer` `boolean` $notifyCustomer `$includeComment` `boolean` $includeComment Returns `boolean`
`public boolean`	# `cancel( string $creditmemoIncrementId )` Cancel credit memo Cancel credit memo Parameters `$creditmemoIncrementId` `string` $creditmemoIncrementId Returns `boolean`
`protected array`	# `_prepareCreateData( array $data )` Hook method, could be replaced in derived classes Hook method, could be replaced in derived classes Parameters `$data` `array` $data Returns `array`
`protected Mage_Core_Model_Abstract\|Mage_Sales_Model_Order_Creditmemo`	# `_getCreditmemo( mixed $incrementId )` Load CreditMemo by IncrementId Load CreditMemo by IncrementId Parameters `$incrementId` `mixed` $incrementId Returns `Mage_Core_Model_Abstract\|Mage_Sales_Model_Order_Creditmemo`

Methods inherited from Mage_Sales_Model_Api_Resource
`_getAttributes(), _isAllowedAttribute(), _updateAttributes()`

Methods inherited from Mage_Api_Model_Resource_Abstract
`_fault(), _getConfig(), _getServer(), _getSession(), getResourceConfig(), setResourceConfig()`

Properties inherited from Mage_Sales_Model_Api_Resource
`$_attributesMap, $_ignoredAttributeCodes`

Properties inherited from Mage_Api_Model_Resource_Abstract
`$_resourceConfig`

Packages

Classes

Interfaces

Class Mage_Sales_Model_Order_Creditmemo_Api

Direct known subclasses

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns