Class Mage_Sales_Model_Order_Shipment_Api

Description
Description | Descendents | Vars | Methods (details)

Sales order shippment API

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

Mage_Api_Model_Resource_Abstract
   |
   --Mage_Sales_Model_Api_Resource
      |
      --Mage_Sales_Model_Order_Shipment_Api
Direct descendents
Description | Descendents | Vars | Methods (details)
Class Description
Mage_Sales_Model_Order_Shipment_Api_V2 Sales order shippment API V2
Method Summary
Description | Descendents | Vars | Methods (details)
Mage_Sales_Model_Order_Shipment_Api __construct ()
boolean addComment (string $shipmentIncrementId, string $comment, [boolean $email = false], [boolean $includeInEmail = false])
int addTrack (string $shipmentIncrementId, string $carrier, string $title, string $trackNumber)
string create (string $orderIncrementId, [array $itemsQty = array()], [string $comment = null], [booleam $email = false], [boolean $includeComment = false])
array getCarriers (string $orderIncrementId)
array info (string $shipmentIncrementId)
mixed infoTrack (string $shipmentIncrementId, int $trackId)
array items ([array $filters = null])
boolean removeTrack (string $shipmentIncrementId, int $trackId)
array _getCarriers (Mage_Eav_Model_Entity_Abstract $object)
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_Shipment_Api __construct ()
addComment (line 287)

Add comment to shipment

  • access: public
boolean addComment (string $shipmentIncrementId, string $comment, [boolean $email = false], [boolean $includeInEmail = false])
  • string $shipmentIncrementId
  • string $comment
  • boolean $email
  • boolean $includeInEmail
addTrack (line 184)

Add tracking number to order

  • access: public
int addTrack (string $shipmentIncrementId, string $carrier, string $title, string $trackNumber)
  • string $shipmentIncrementId
  • string $carrier
  • string $title
  • string $trackNumber
create (line 134)

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
Redefined in descendants as:
getCarriers (line 315)

Retrieve allowed shipping carriers for specified order

  • access: public
array getCarriers (string $orderIncrementId)
  • string $orderIncrementId
Redefined in descendants as:
info (line 94)

Retrieve shipment information

  • access: public
array info (string $shipmentIncrementId)
  • string $shipmentIncrementId
infoTrack (line 254)

Retrieve tracking number info

  • access: public
mixed infoTrack (string $shipmentIncrementId, int $trackId)
  • string $shipmentIncrementId
  • int $trackId
items (line 53)

Retrive shipments by filters

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

Remove tracking number

  • access: public
boolean removeTrack (string $shipmentIncrementId, int $trackId)
  • string $shipmentIncrementId
  • int $trackId
_getCarriers (line 335)

Retrieve shipping carriers for specified order

  • access: protected
array _getCarriers (Mage_Eav_Model_Entity_Abstract $object)

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:35 +0200 by phpDocumentor 1.4.3