Class Mage_Sales_Model_Order_Api

Description
Description | Descendents | Vars | Methods (details)

Order API

Located in /Sales/Model/Order/Api.php (line 34) 

Mage_Api_Model_Resource_Abstract
   |
   --Mage_Sales_Model_Api_Resource
      |
      --Mage_Sales_Model_Order_Api
Direct descendents
Description | Descendents | Vars | Methods (details)
Class Description
Mage_Sales_Model_Order_Api_V2 Order API V2
Method Summary
Description | Descendents | Vars | Methods (details)
Mage_Sales_Model_Order_Api __construct ()
boolean addComment (string $orderIncrementId, string $status, [string $comment = null], [boolean $notify = false])
boolean cancel (string $orderIncrementId)
boolean hold (string $orderIncrementId)
array info (string $orderIncrementId)
array items ([array $filters = null])
boolean unhold (string $orderIncrementId)
Mage_Sales_Model_Order _initOrder (mixed $orderIncrementId)
Variables
Description | Descendents | Vars (details) | Methods (details)

Inherited Variables

Inherited from Mage_Sales_Model_Api_Resource

Mage_Sales_Model_Api_Resource::$_attributesMap
 Mage_Sales_Model_Api_Resource::$_ignoredAttributeCodes

Inherited from Mage_Api_Model_Resource_Abstract

Mage_Api_Model_Resource_Abstract::$_resourceConfig
Methods
Description | Descendents | Vars Methods (details)
Constructor __construct (line 36)
  • access: public
Mage_Sales_Model_Order_Api __construct ()
addComment (line 178)

Add comment to order

  • access: public
boolean addComment (string $orderIncrementId, string $status, [string $comment = null], [boolean $notify = false])
  • string $orderIncrementId
  • string $status
  • string $comment
  • boolean $notify
cancel (line 253)

Cancel order

  • access: public
boolean cancel (string $orderIncrementId)
  • string $orderIncrementId
hold (line 213)

Hold order

  • access: public
boolean hold (string $orderIncrementId)
  • string $orderIncrementId
info (line 132)

Retrieve full order information

  • access: public
array info (string $orderIncrementId)
  • string $orderIncrementId
items (line 71)

Retrieve list of orders by filters

  • access: public
array items ([array $filters = null])
  • array $filters
Redefined in descendants as:
unhold (line 233)

Unhold order

  • access: public
boolean unhold (string $orderIncrementId)
  • string $orderIncrementId
_initOrder (line 50)

Initialize basic order model

  • access: protected
Mage_Sales_Model_Order _initOrder (mixed $orderIncrementId)
  • mixed $orderIncrementId

Inherited Methods

Inherited From Mage_Sales_Model_Api_Resource

Mage_Sales_Model_Api_Resource::_getAttributes()
Mage_Sales_Model_Api_Resource::_isAllowedAttribute()
Mage_Sales_Model_Api_Resource::_updateAttributes()

Inherited From Mage_Api_Model_Resource_Abstract

Mage_Api_Model_Resource_Abstract::getResourceConfig()
Mage_Api_Model_Resource_Abstract::setResourceConfig()
Mage_Api_Model_Resource_Abstract::_fault()
Mage_Api_Model_Resource_Abstract::_getConfig()
Mage_Api_Model_Resource_Abstract::_getServer()
Mage_Api_Model_Resource_Abstract::_getSession()

Documentation generated on Fri, 11 Feb 2011 16:56:36 +0200 by phpDocumentor 1.4.3