Class Mage_Sales_Model_Order_Shipment_Api_V2

Description
Description | Vars | Methods (details)

Sales order shippment API V2

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

Mage_Api_Model_Resource_Abstract
   |
   --Mage_Sales_Model_Api_Resource
      |
      --Mage_Sales_Model_Order_Shipment_Api
         |
         --Mage_Sales_Model_Order_Shipment_Api_V2
Method Summary
Description | Vars | Methods (details)
string create (string $orderIncrementId, [array $itemsQty = array()], [string $comment = null], [booleam $email = false], [boolean $includeComment = false])
array getCarriers (string $orderIncrementId)
array items ([array $filters = null])
void _prepareItemQtyData ( $data)
Variables
Description | 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 | Vars Methods (details)
create (line 113)

Create new shipment for order

  • access: public
string create (string $orderIncrementId, [array $itemsQty = array()], [string $comment = null], [booleam $email = false], [boolean $includeComment = false])
  • string $orderIncrementId
  • array $itemsQty
  • string $comment
  • booleam $email
  • boolean $includeComment
Redefinition of:
Mage_Sales_Model_Order_Shipment_Api::create()
Create new shipment for order
getCarriers (line 160)

Retrieve allowed shipping carriers for specified order

  • access: public
array getCarriers (string $orderIncrementId)
  • string $orderIncrementId
Redefinition of:
Mage_Sales_Model_Order_Shipment_Api::getCarriers()
Retrieve allowed shipping carriers for specified order
items (line 42)

Retrive shipments by filters

  • access: public
array items ([array $filters = null])
  • array $filters
Redefinition of:
Mage_Sales_Model_Order_Shipment_Api::items()
Retrive shipments by filters
_prepareItemQtyData (line 92)
  • access: protected
void _prepareItemQtyData ( $data)
  • $data

Inherited Methods

Inherited From Mage_Sales_Model_Order_Shipment_Api

Mage_Sales_Model_Order_Shipment_Api::__construct()
Mage_Sales_Model_Order_Shipment_Api::addComment()
Mage_Sales_Model_Order_Shipment_Api::addTrack()
Mage_Sales_Model_Order_Shipment_Api::create()
Mage_Sales_Model_Order_Shipment_Api::getCarriers()
Mage_Sales_Model_Order_Shipment_Api::info()
Mage_Sales_Model_Order_Shipment_Api::infoTrack()
Mage_Sales_Model_Order_Shipment_Api::items()
Mage_Sales_Model_Order_Shipment_Api::removeTrack()
Mage_Sales_Model_Order_Shipment_Api::_getCarriers()

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 17:15:48 +0200 by phpDocumentor 1.4.3