Mage_Sales_Model_Order_Shipment_Api_V2 Class Reference

Inheritance diagram for Mage_Sales_Model_Order_Shipment_Api_V2:

List of all members.

Public Member Functions
	items ($filters=null)
	create ($orderIncrementId, $itemsQty=array(), $comment=null, $email=false, $includeComment=false)
	getCarriers ($orderIncrementId)
Protected Member Functions
	_prepareItemQtyData ($data)

---

Detailed Description

Definition at line 34 of file V2.php.

---

Member Function Documentation

_prepareItemQtyData

(

$

data

)

[protected]

Definition at line 92 of file V2.php.

    {
        $_data = array();
        foreach ($data as $item) {
            if (isset($item->order_item_id) && isset($item->qty)) {
                $_data[$item->order_item_id] = $item->qty;
            }
        }
        return $_data;
    }

create	(	$	orderIncrementId,
		$	itemsQty = array(),
		$	comment = null,
		$	email = false,
		$	includeComment = false
	)

Create new shipment for order

Parameters:

	string	$orderIncrementId
	array	$itemsQty
	string	$comment
	booleam	$email
	boolean	$includeComment

Returns:

string

Check order existing

Check shipment create availability

Reimplemented from Mage_Sales_Model_Order_Shipment_Api.

Definition at line 113 of file V2.php.

    {
        $order = Mage::getModel('sales/order')->loadByIncrementId($orderIncrementId);
        $itemsQty = $this->_prepareItemQtyData($itemsQty);
        /**
          * Check order existing
          */
        if (!$order->getId()) {
             $this->_fault('order_not_exists');
        }

        /**
         * Check shipment create availability
         */
        if (!$order->canShip()) {
             $this->_fault('data_invalid', Mage::helper('sales')->__('Can not do shipment for order.'));
        }

        $convertor   = Mage::getModel('sales/convert_order');
        $shipment    = $convertor->toShipment($order);
         /* @var $shipment Mage_Sales_Model_Order_Shipment */

        foreach ($order->getAllItems() as $orderItem) {
            if (!$orderItem->getQtyToShip()) {
                continue;
            }
            if ($orderItem->getIsVirtual()) {
                continue;
            }
            $item = $convertor->itemToShipmentItem($orderItem);
            if (isset($itemsQty[$orderItem->getId()])) {
                $qty = $itemsQty[$orderItem->getId()];
            }
            else {
                $qty = $orderItem->getQtyToShip();
            }
            $item->setQty($qty);
            $shipment->addItem($item);
        }
        $shipment->register();
        $shipment->addComment($comment, $email && $includeComment);

        if ($email) {
            $shipment->setEmailSent(true);
        }

        $shipment->getOrder()->setIsInProcess(true);

        try {
            $transactionSave = Mage::getModel('core/resource_transaction')
                ->addObject($shipment)
                ->addObject($shipment->getOrder())
                ->save();

            $shipment->sendEmail($email, ($includeComment ? $comment : ''));
        } catch (Mage_Core_Exception $e) {
            $this->_fault('data_invalid', $e->getMessage());
        }

        return $shipment->getIncrementId();
    }

getCarriers

(

$

orderIncrementId

)

Retrieve allowed shipping carriers for specified order

Parameters:

string

$orderIncrementId

Returns:

array

Check order existing

Reimplemented from Mage_Sales_Model_Order_Shipment_Api.

Definition at line 181 of file V2.php.

    {
        $order = Mage::getModel('sales/order')->loadByIncrementId($orderIncrementId);

        /**
          * Check order existing
          */
        if (!$order->getId()) {
            $this->_fault('order_not_exists');
        }
        $carriers = array();
        foreach ($this->_getCarriers($order) as $key => $value) {
            $carriers[] = array('key' => $key, 'value' => $value);
        }

        return $carriers;
    }

items

(

$

filters = null

)

Retrive shipments by filters

Parameters:

array

$filters

Returns:

array

Reimplemented from Mage_Sales_Model_Order_Shipment_Api.

Definition at line 42 of file V2.php.

    {
        //TODO: add full name logic
        $collection = Mage::getResourceModel('sales/order_shipment_collection')
            ->addAttributeToSelect('increment_id')
            ->addAttributeToSelect('created_at')
            ->addAttributeToSelect('total_qty')
            ->joinAttribute('shipping_firstname', 'order_address/firstname', 'shipping_address_id', null, 'left')
            ->joinAttribute('shipping_lastname', 'order_address/lastname', 'shipping_address_id', null, 'left')
            ->joinAttribute('order_increment_id', 'order/increment_id', 'order_id', null, 'left')
            ->joinAttribute('order_created_at', 'order/created_at', 'order_id', null, 'left');

        $preparedFilters = array();
        if (isset($filters->filter)) {
            foreach ($filters->filter as $_filter) {
                $preparedFilters[$_filter->key] = $_filter->value;
            }
        }
        if (isset($filters->complex_filter)) {
            foreach ($filters->complex_filter as $_filter) {
                $_value = $_filter->value;
                $preparedFilters[$_filter->key] = array(
                    $_value->key => $_value->value
                );
            }
        }

        if (!empty($preparedFilters)) {
            try {
                foreach ($preparedFilters as $field => $value) {
                    if (isset($this->_attributesMap['shipment'][$field])) {
                        $field = $this->_attributesMap['shipment'][$field];
                    }

                    $collection->addFieldToFilter($field, $value);
                }
            } catch (Mage_Core_Exception $e) {
                $this->_fault('filters_invalid', $e->getMessage());
            }
        }

        $result = array();

        foreach ($collection as $shipment) {
            $result[] = $this->_getAttributes($shipment, 'shipment');
        }

        return $result;
    }

---

The documentation for this class was generated from the following file:

• app/code/core/Mage/Sales/Model/Order/Shipment/Api/V2.php