Class Mage_Sales_Model_Order_Shipment_Api

Sales order shippment API

Mage_Sales_Model_Order_Shipment_Api

Direct known subclasses

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/Shipment/Api.php

Methods summary
`public`	# `__construct( )`
`public array`	# `items( null\|object\|array $filters = null )` Retrieve shipments by filters Retrieve shipments by filters Parameters `$filters` `null\|object\|array` $filters Returns `array`
`public array`	# `info( string $shipmentIncrementId )` Retrieve shipment information Retrieve shipment information Parameters `$shipmentIncrementId` `string` $shipmentIncrementId Returns `array`
`public string`	# `create( string $orderIncrementId, array $itemsQty = array(), string $comment = null, booleam $email = false, boolean $includeComment = false )` Create new shipment for order Create new shipment for order Parameters `$orderIncrementId` `string` $orderIncrementId `$itemsQty` `array` $itemsQty `$comment` `string` $comment `$email` `booleam` $email `$includeComment` `boolean` $includeComment Returns `string`
`public integer`	# `addTrack( string $shipmentIncrementId, string $carrier, string $title, string $trackNumber )` Add tracking number to order Add tracking number to order Parameters `$shipmentIncrementId` `string` $shipmentIncrementId `$carrier` `string` $carrier `$title` `string` $title `$trackNumber` `string` $trackNumber Returns `integer`
`public boolean`	# `removeTrack( string $shipmentIncrementId, integer $trackId )` Remove tracking number Remove tracking number Parameters `$shipmentIncrementId` `string` $shipmentIncrementId `$trackId` `integer` $trackId Returns `boolean`
`public boolean`	# `sendInfo( string $shipmentIncrementId, string $comment = '' )` Send email with shipment data to customer Send email with shipment data to customer Parameters `$shipmentIncrementId` `string` $shipmentIncrementId `$comment` `string` $comment Returns `boolean`
`public mixed`	# `infoTrack( string $shipmentIncrementId, integer $trackId )` Retrieve tracking number info Retrieve tracking number info Parameters `$shipmentIncrementId` `string` $shipmentIncrementId `$trackId` `integer` $trackId Returns `mixed`
`public boolean`	# `addComment( string $shipmentIncrementId, string $comment, boolean $email = false, boolean $includeInEmail = false )` Add comment to shipment Add comment to shipment Parameters `$shipmentIncrementId` `string` $shipmentIncrementId `$comment` `string` $comment `$email` `boolean` $email `$includeInEmail` `boolean` $includeInEmail Returns `boolean`
`public array`	# `getCarriers( string $orderIncrementId )` Retrieve allowed shipping carriers for specified order Retrieve allowed shipping carriers for specified order Parameters `$orderIncrementId` `string` $orderIncrementId Returns `array`
`protected array`	# `_getCarriers( Mage_Eav_Model_Entity_Abstract $object )` Retrieve shipping carriers for specified order Retrieve shipping carriers for specified order Parameters `$object` `Mage_Eav_Model_Entity_Abstract` $object Returns `array`

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_Shipment_Api

Direct known subclasses

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns