- Introduction
-
Catalog
-
Catalog Category
- catalog_category.assignedProducts
- catalog_category.assignProduct
- catalog_category.create
- catalog_category.currentStore
- catalog_category.delete
- catalog_category.info
- catalog_category.level
- catalog_category.move
- catalog_category.removeProduct
- catalog_category.tree
- catalog_category.update
- catalog_category.updateProduct
- Catalog Category Attributes
- Catalog Product
- Catalog Product Attribute
-
Catalog Product Attribute
Media - Catalog Product Attribute Set
-
Catalog Product Custom
Option - Catalog Product Custom Option Value
- Catalog Product Downloadable Link
- Catalog Product Link
- Catalog Product Tag
- Catalog Product Tier Price
- Catalog Product Types
-
Catalog Category
- Catalog Inventory
- Checkout
- Create Your Own API
- Customer
- Directory
- Sales
- Enterprise Customer Balance
- Enterprise Gift Card
- Enterprise Gift Message
- Miscellaneous
- WS-I Compliance
Module: Order Credit Memo API
Resource: sales_order_creditmemo
Aliases: order_creditmemo
Method:
- order_creditmemo.cancel (SOAP V1)
- salesOrderCreditmemoCancel (SOAP V2)
Allows you to cancel an existing credit memo.
Arguments:
| Type | Name | Description |
|---|---|---|
| string | sessionId | Session ID |
| string | creditmemoIncrementId | Credit memo increment ID |
Return:
| Type | Name | Description |
|---|---|---|
| string | result | Result of canceling the credit memo |
Faults:
| Fault Code | Fault Message |
|---|---|
| 100 | Requested credit memo does not exist. |
| 104 | Credit memo status not changed. |
Examples
Request Example SOAP V1
$proxy = new SoapClient('http://magentohost/api/soap/?wsdl');
$sessionId = $proxy->login('apiUser', 'apiKey');
$creditmemoIncrementId = '100000637'; //increment id of existing credit memo
$isCreditMemoCanceled = $proxy->call($sessionId, 'order_creditmemo.cancel', array($creditmemoIncrementId));