Shipment Class Reference

Inheritance diagram for Shipment:

Public Member Functions
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Framework\Api\ExtensionAttributesFactory $extensionFactory, AttributeValueFactory $customAttributeFactory, \Magento\Sales\Model\ResourceModel\Order\Shipment\Item\CollectionFactory $shipmentItemCollectionFactory, \Magento\Sales\Model\ResourceModel\Order\Shipment\Track\CollectionFactory $trackCollectionFactory, \Magento\Sales\Model\Order\Shipment\CommentFactory $commentFactory, \Magento\Sales\Model\ResourceModel\Order\Shipment\Comment\CollectionFactory $commentCollectionFactory, \Magento\Sales\Api\OrderRepositoryInterface $orderRepository, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])
	loadByIncrementId ($incrementId)
	setOrder (\Magento\Sales\Model\Order $order)
	getProtectCode ()
	getOrder ()
	getEntityType ()
	getBillingAddress ()
	getShippingAddress ()
	getItemsCollection ()
	getAllItems ()
	getItemById ($itemId)
	addItem (\Magento\Sales\Model\Order\Shipment\Item $item)
	getTracksCollection ()
	getAllTracks ()
	getTrackById ($trackId)
	addTrack (\Magento\Sales\Model\Order\Shipment\Track $track)
	addComment ($comment, $notify=false, $visibleOnFront=false)
	getCommentsCollection ($reload=false)
	getStore ()
	setShippingLabel ($label)
	getShippingLabel ()
	getIncrementId ()
	getPackages ()
	setPackages (array $packages=null)
	getItems ()
	setItems ($items)
	getTracks ()
	setTracks ($tracks)
	getBillingAddressId ()
	getCreatedAt ()
	setCreatedAt ($createdAt)
	getCustomerId ()
	getEmailSent ()
	getOrderId ()
	getShipmentStatus ()
	getShippingAddressId ()
	getStoreId ()
	getTotalQty ()
	getTotalWeight ()
	getUpdatedAt ()
	getComments ()
	setComments ($comments=null)
	setStoreId ($id)
	setTotalWeight ($totalWeight)
	setTotalQty ($qty)
	setEmailSent ($emailSent)
	setOrderId ($id)
	setCustomerId ($id)
	setShippingAddressId ($id)
	setBillingAddressId ($id)
	setShipmentStatus ($shipmentStatus)
	setIncrementId ($id)
	setUpdatedAt ($timestamp)
	getExtensionAttributes ()
	setExtensionAttributes (\Magento\Sales\Api\Data\ShipmentExtensionInterface $extensionAttributes)
Public Member Functions inherited from AbstractModel
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Framework\Api\ExtensionAttributesFactory $extensionFactory, AttributeValueFactory $customAttributeFactory, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])
	getEventObject ()
Public Member Functions inherited from AbstractExtensibleModel
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, ExtensionAttributesFactory $extensionFactory, AttributeValueFactory $customAttributeFactory, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])
	getCustomAttributes ()
	getCustomAttribute ($attributeCode)
	setCustomAttributes (array $attributes)
	setCustomAttribute ($attributeCode, $attributeValue)
	setData ($key, $value=null)
	unsetData ($key=null)
	getData ($key='', $index=null)
	setId ($value)
	__sleep ()
	__wakeup ()
Public Member Functions inherited from AbstractModel
	__construct (\Magento\Framework\Model\Context $context, \Magento\Framework\Registry $registry, \Magento\Framework\Model\ResourceModel\AbstractResource $resource=null, \Magento\Framework\Data\Collection\AbstractDb $resourceCollection=null, array $data=[])
	__sleep ()
	__wakeup ()
	setIdFieldName ($name)
	getIdFieldName ()
	getId ()
	setId ($value)
	isDeleted ($isDeleted=null)
	hasDataChanges ()
	setData ($key, $value=null)
	unsetData ($key=null)
	setDataChanges ($value)
	getOrigData ($key=null)
	setOrigData ($key=null, $data=null)
	dataHasChangedFor ($field)
	getResourceName ()
	getResourceCollection ()
	getCollection ()
	load ($modelId, $field=null)
	beforeLoad ($identifier, $field=null)
	afterLoad ()
	isSaveAllowed ()
	setHasDataChanges ($flag)
	save ()
	afterCommitCallback ()
	isObjectNew ($flag=null)
	beforeSave ()
	validateBeforeSave ()
	getCacheTags ()
	cleanModelCache ()
	afterSave ()
	delete ()
	beforeDelete ()
	afterDelete ()
	afterDeleteCommit ()
	getResource ()
	getEntityId ()
	setEntityId ($entityId)
	clearInstance ()
	getStoredData ()
	getEventPrefix ()
Public Member Functions inherited from DataObject
	__construct (array $data=[])
	addData (array $arr)
	setData ($key, $value=null)
	unsetData ($key=null)
	getData ($key='', $index=null)
	getDataByPath ($path)
	getDataByKey ($key)
	setDataUsingMethod ($key, $args=[])
	getDataUsingMethod ($key, $args=null)
	hasData ($key='')
	toArray (array $keys=[])
	convertToArray (array $keys=[])
	toXml (array $keys=[], $rootName='item', $addOpenTag=false, $addCdata=true)
	convertToXml (array $arrAttributes=[], $rootName='item', $addOpenTag=false, $addCdata=true)
	toJson (array $keys=[])
	convertToJson (array $keys=[])
	toString ($format='')
	__call ($method, $args)
	isEmpty ()
	serialize ($keys=[], $valueSeparator='=', $fieldSeparator=' ', $quote='"')
	debug ($data=null, &$objects=[])
	offsetSet ($offset, $value)
	offsetExists ($offset)
	offsetUnset ($offset)
	offsetGet ($offset)
Public Member Functions inherited from ShipmentInterface
	getEntityId ()
	setEntityId ($entityId)
	setExtensionAttributes (\Magento\Sales\Api\Data\ShipmentExtensionInterface $extensionAttributes)

Data Fields
const	STATUS_NEW = 1
const	REPORT_DATE_TYPE_ORDER_CREATED = 'order_created'
const	REPORT_DATE_TYPE_SHIPMENT_CREATED = 'shipment_created'
const	XML_PATH_STORE_ADDRESS1 = 'shipping/origin/street_line1'
const	XML_PATH_STORE_ADDRESS2 = 'shipping/origin/street_line2'
const	XML_PATH_STORE_CITY = 'shipping/origin/city'
const	XML_PATH_STORE_REGION_ID = 'shipping/origin/region_id'
const	XML_PATH_STORE_ZIP = 'shipping/origin/postcode'
const	XML_PATH_STORE_COUNTRY_ID = 'shipping/origin/country_id'
Data Fields inherited from CustomAttributesDataInterface
const	CUSTOM_ATTRIBUTES = 'custom_attributes'
Data Fields inherited from ExtensibleDataInterface
const	EXTENSION_ATTRIBUTES_KEY = 'extension_attributes'
Data Fields inherited from ShipmentInterface
const	ENTITY_ID = 'entity_id'
const	STORE_ID = 'store_id'
const	TOTAL_WEIGHT = 'total_weight'
const	TOTAL_QTY = 'total_qty'
const	EMAIL_SENT = 'email_sent'
const	ORDER_ID = 'order_id'
const	CUSTOMER_ID = 'customer_id'
const	SHIPPING_ADDRESS_ID = 'shipping_address_id'
const	BILLING_ADDRESS_ID = 'billing_address_id'
const	SHIPMENT_STATUS = 'shipment_status'
const	INCREMENT_ID = 'increment_id'
const	CREATED_AT = 'created_at'
const	UPDATED_AT = 'updated_at'
const	PACKAGES = 'packages'
const	SHIPPING_LABEL = 'shipping_label'
const	ITEMS = 'items'
const	TRACKS = 'tracks'
const	COMMENTS = 'comments'

Protected Member Functions
	_construct ()
Protected Member Functions inherited from AbstractExtensibleModel
	filterCustomAttributes ($data)
	initializeCustomAttributes ()
	convertCustomAttributeValues (array &$customAttributes)
	getCustomAttributesCodes ()
	_setExtensionAttributes (\Magento\Framework\Api\ExtensionAttributesInterface $extensionAttributes)
	_getExtensionAttributes ()
Protected Member Functions inherited from AbstractModel
	_construct ()
	_init ($resourceModel)
	_setResourceModel ($resourceName, $collectionName=null)
	_getResource ()
	_getEventData ()
	_beforeLoad ($modelId, $field=null)
	_afterLoad ()
	_hasModelChanged ()
	_getValidatorBeforeSave ()
	_createValidatorBeforeSave ()
	_getValidationRulesBeforeSave ()
	_clearReferences ()
	_clearData ()
Protected Member Functions inherited from DataObject
	_getData ($key)
	_underscore ($name)

Protected Attributes
	$entityType = 'shipment'
	$_order
	$_eventPrefix = 'sales_order_shipment'
	$_eventObject = 'shipment'
	$_shipmentItemCollectionFactory
	$_trackCollectionFactory
	$_commentFactory
	$_commentCollectionFactory
	$orderRepository
Protected Attributes inherited from AbstractExtensibleModel
	$extensionAttributesFactory
	$extensionAttributes
	$customAttributeFactory
	$customAttributesCodes = null
	$customAttributesChanged = false
Protected Attributes inherited from AbstractModel
	$_eventPrefix = 'core_abstract'
	$_eventObject = 'object'
	$_idFieldName = 'id'
	$_hasDataChanges = false
	$_origData
	$_isDeleted = false
	$_resource
	$_resourceCollection
	$_resourceName
	$_collectionName
	$_cacheTag = false
	$_dataSaveAllowed = true
	$_isObjectNew = null
	$_validatorBeforeSave = null
	$_eventManager
	$_cacheManager
	$_registry
	$_logger
	$_appState
	$_actionValidator
	$storedData = []
Protected Attributes inherited from DataObject
	$_data = []

Additional Inherited Members
Static Protected Attributes inherited from DataObject
static	$_underscoreCache = []

Detailed Description

Sales order shipment model

@api @method \Magento\Sales\Model\Order\Invoice setSendEmail(bool $value) @method \Magento\Sales\Model\Order\Invoice setCustomerNote(string $value) @method string getCustomerNote() @method \Magento\Sales\Model\Order\Invoice setCustomerNoteNotify(bool $value) @method bool getCustomerNoteNotify() @SuppressWarnings(PHPMD.CouplingBetweenObjects) @SuppressWarnings(PHPMD.ExcessivePublicCount)

Since

100.0.2

Definition at line 27 of file Shipment.php.

Constructor & Destructor Documentation

__construct()

__construct	(	\Magento\Framework\Model\Context	$context,
		\Magento\Framework\Registry	$registry,
		\Magento\Framework\Api\ExtensionAttributesFactory	$extensionFactory,
		AttributeValueFactory	$customAttributeFactory,
		\Magento\Sales\Model\ResourceModel\Order\Shipment\Item\CollectionFactory	$shipmentItemCollectionFactory,
		\Magento\Sales\Model\ResourceModel\Order\Shipment\Track\CollectionFactory	$trackCollectionFactory,
		\Magento\Sales\Model\Order\Shipment\CommentFactory	$commentFactory,
		\Magento\Sales\Model\ResourceModel\Order\Shipment\Comment\CollectionFactory	$commentCollectionFactory,
		\Magento\Sales\Api\OrderRepositoryInterface	$orderRepository,
		\Magento\Framework\Model\ResourceModel\AbstractResource	$resource = null,
		\Magento\Framework\Data\Collection\AbstractDb	$resourceCollection = null,
		array	$data = []
	)

Parameters

\Magento\Framework\Model\Context	$context
\Magento\Framework\Registry	$registry
\Magento\Framework\Api\ExtensionAttributesFactory	$extensionFactory
AttributeValueFactory	$customAttributeFactory
\Magento\Sales\Model\ResourceModel\Order\Shipment\Item\CollectionFactory	$shipmentItemCollectionFactory
\Magento\Sales\Model\ResourceModel\Order\Shipment\Track\CollectionFactory	$trackCollectionFactory
Shipment\CommentFactory	$commentFactory
\Magento\Sales\Model\ResourceModel\Order\Shipment\Comment\CollectionFactory	$commentCollectionFactory
\Magento\Sales\Api\OrderRepositoryInterface	$orderRepository
\Magento\Framework\Model\ResourceModel\AbstractResource	$resource
\Magento\Framework\Data\Collection\AbstractDb	$resourceCollection
array	$data	@SuppressWarnings(PHPMD.ExcessiveParameterList)

Definition at line 122 of file Shipment.php.

      {
        $this->_shipmentItemCollectionFactory = $shipmentItemCollectionFactory;
        $this->_trackCollectionFactory = $trackCollectionFactory;
        $this->_commentFactory = $commentFactory;
        $this->_commentCollectionFactory = $commentCollectionFactory;
        $this->orderRepository = $orderRepository;
        parent::__construct(
            $context,
            $registry,
            $extensionFactory,
            $customAttributeFactory,
            $resource,
            $resourceCollection,
            $data
        );
    }

Member Function Documentation

_construct()

_construct ( )

protected

Initialize shipment resource model

Returns

void

Definition at line 157 of file Shipment.php.

    {
        $this->_init(\Magento\Sales\Model\ResourceModel\Order\Shipment::class);
    }

addComment()

addComment	(		$comment,
			$notify = false,
			$visibleOnFront = false
	)

Adds comment to shipment with option to send it to customer via email and show it in customer account

Parameters

\Magento\Sales\Model\Order\Shipment\Comment | string	$comment
bool	$notify
bool	$visibleOnFront

Returns

$this

Definition at line 433 of file Shipment.php.

    {
        if (!$comment instanceof \Magento\Sales\Model\Order\Shipment\Comment) {
            $comment = $this->_commentFactory->create()
                ->setComment($comment)
                ->setIsCustomerNotified($notify)
                ->setIsVisibleOnFront($visibleOnFront);
        }
        $comment->setShipment($this)
            ->setParentId($this->getId())
            ->setStoreId($this->getStoreId());
        if (!$comment->getId()) {
            $this->getCommentsCollection()->addItem($comment);
        }
        $comments = $this->getComments();
        $comments[] = $comment;
        $this->setComments($comments);
        $this->_hasDataChanges = true;
        return $this;
    }

addItem()

addItem

(

\Magento\Sales\Model\Order\Shipment\Item

$item

)

Adds an item to the shipment

Parameters

\Magento\Sales\Model\Order\Shipment\Item

$item

Returns

$this

Definition at line 337 of file Shipment.php.

    {
        $item->setShipment($this)->setParentId($this->getId())->setStoreId($this->getStoreId());
        if (!$item->getId()) {
            $this->setItems(array_merge(
                $this->getItems() ?? [],
                [$item]
            ));
        }
        return $this;
    }

addTrack()

addTrack

(

\Magento\Sales\Model\Order\Shipment\Track

$track

)

Addes a track to the collection and associates the shipment to the track

Parameters

\Magento\Sales\Model\Order\Shipment\Track

$track

Returns

$this

Track saving is implemented in _afterSave() This enforces \Magento\Framework\Model\AbstractModel::save() not to skip _afterSave()

Definition at line 401 of file Shipment.php.

    {
        $track->setShipment(
            $this
        )->setParentId(
            $this->getId()
        )->setOrderId(
            $this->getOrderId()
        )->setStoreId(
            $this->getStoreId()
        );
        if (!$track->getId()) {
            $this->getTracksCollection()->addItem($track);
        }

        $this->_hasDataChanges = true;

        return $this;
    }

getAllItems()

getAllItems

(

)

Retrieves all non-deleted items from the shipment

Returns

array

Definition at line 304 of file Shipment.php.

    {
        $items = [];
        foreach ($this->getItemsCollection() as $item) {
            if (!$item->isDeleted()) {
                $items[] = $item;
            }
        }
        return $items;
    }

getAllTracks()

getAllTracks

(

)

Retrieves all available tracks in the collection that aren't deleted

Returns

array

Definition at line 368 of file Shipment.php.

    {
        $tracks = [];
        foreach ($this->getTracksCollection() as $track) {
            if (!$track->isDeleted()) {
                $tracks[] = $track;
            }
        }
        return $tracks;
    }

getBillingAddress()

getBillingAddress

(

)

Retrieve billing address

Returns

Address

Definition at line 232 of file Shipment.php.

    {
        return $this->getOrder()->getBillingAddress();
    }

getBillingAddressId()

getBillingAddressId

(

)

Returns billing_address_id

Returns

int

Implements ShipmentInterface.

Definition at line 616 of file Shipment.php.

    {
        return $this->getData(ShipmentInterface::BILLING_ADDRESS_ID);
    }

getComments()

getComments

(

)

Returns comments

Returns

\Magento\Sales\Api\Data\ShipmentCommentInterface[]

Implements ShipmentInterface.

Definition at line 734 of file Shipment.php.

    {
        if (!$this->getId()) {
            return $this->getData(ShipmentInterface::COMMENTS);
        }

        if ($this->getData(ShipmentInterface::COMMENTS) == null) {
            $collection = $this->_commentCollectionFactory->create()
                ->setShipmentFilter($this->getId());

            foreach ($collection as $item) {
                $item->setShipment($this);
            }
            $this->setData(ShipmentInterface::COMMENTS, $collection->getItems());
        }
        return $this->getData(ShipmentInterface::COMMENTS);
    }

getCommentsCollection()

getCommentsCollection

(

$reload = false

)

Retrieves comments collection.

Parameters

bool

$reload

Returns

CommentsCollection

Definition at line 460 of file Shipment.php.

    {
        if ($this->commentsCollection === null || $reload) {
            $this->commentsCollection = $this->_commentCollectionFactory->create();
            if ($this->getId()) {
                $this->commentsCollection->setShipmentFilter($this->getId())
                    ->setCreatedAtOrder();

                foreach ($this->commentsCollection as $comment) {
                    $comment->setShipment($this);
                }
            }
        }

        return $this->commentsCollection;
    }

getCreatedAt()

getCreatedAt

(

)

Returns created_at

Returns

string

Implements ShipmentInterface.

Definition at line 626 of file Shipment.php.

    {
        return $this->getData(ShipmentInterface::CREATED_AT);
    }

getCustomerId()

getCustomerId

(

)

Returns customer_id

Returns

int

Implements ShipmentInterface.

Definition at line 644 of file Shipment.php.

    {
        return $this->getData(ShipmentInterface::CUSTOMER_ID);
    }

getEmailSent()

getEmailSent

(

)

Returns email_sent

Returns

int

Implements ShipmentInterface.

Definition at line 654 of file Shipment.php.

    {
        return $this->getData(ShipmentInterface::EMAIL_SENT);
    }

getEntityType()

getEntityType

(

)

Return order history item identifier

@codeCoverageIgnore

Returns

string

Definition at line 222 of file Shipment.php.

    {
        return $this->entityType;
    }

getExtensionAttributes()

getExtensionAttributes

(

)

Retrieve existing extension attributes object or create a new one.

Returns

\Magento\Sales\Api\Data\ShipmentExtensionInterface|null

Returns

\Magento\Sales\Api\Data\ShipmentExtensionInterface|null

Implements ShipmentInterface.

Definition at line 856 of file Shipment.php.

    {
        return $this->_getExtensionAttributes();
    }

getIncrementId()

getIncrementId

(

)

Returns increment id

@codeCoverageIgnore

Returns

string

Implements ShipmentInterface.

Definition at line 520 of file Shipment.php.

    {
        return $this->getData('increment_id');
    }

getItemById()

getItemById

(

$itemId

)

Retrieves an item from the shipment using its ID

Parameters

string | int

$itemId

Returns

bool|\Magento\Sales\Model\Order\Shipment\Item

Definition at line 321 of file Shipment.php.

    {
        foreach ($this->getItemsCollection() as $item) {
            if ($item->getId() == $itemId) {
                return $item;
            }
        }
        return false;
    }

getItems()

getItems

(

)

Returns items

Returns

\Magento\Sales\Api\Data\ShipmentItemInterface[]

Implements ShipmentInterface.

Definition at line 551 of file Shipment.php.

    {
        if ($this->getData(ShipmentInterface::ITEMS) === null) {
            $collection =  $this->_shipmentItemCollectionFactory->create()->setShipmentFilter($this->getId());
            if ($this->getId()) {
                foreach ($collection as $item) {
                    $item->setShipment($this);
                }
                $this->setData(ShipmentInterface::ITEMS, $collection->getItems());
            }
        }
        $shipmentItems = $this->getData(ShipmentInterface::ITEMS);
        if ($shipmentItems !== null && !is_array($shipmentItems)) {
            $shipmentItems = $shipmentItems->getItems();
        }
        return $shipmentItems;
    }

getItemsCollection()

getItemsCollection

(

)

Retrieves the collection used to track the shipment's items

Returns

mixed

Definition at line 284 of file Shipment.php.

    {
        if (!$this->hasData(ShipmentInterface::ITEMS)) {
            $this->setItems($this->_shipmentItemCollectionFactory->create()->setShipmentFilter($this->getId()));

            if ($this->getId()) {
                foreach ($this->getItems() as $item) {
                    $item->setShipment($this);
                }
            }
        }

        return $this->getItems();
    }

getOrder()

getOrder

(

)

Retrieve the order the shipment for created for

Returns

\Magento\Sales\Model\Order

Definition at line 207 of file Shipment.php.

    {
        if (!$this->_order instanceof \Magento\Sales\Model\Order) {
            $this->_order = $this->orderRepository->get($this->getOrderId());
        }
        return $this->_order->setHistoryEntityName($this->entityType);
    }

getOrderId()

getOrderId

(

)

Returns order_id

Returns

int

Implements ShipmentInterface.

Definition at line 664 of file Shipment.php.

    {
        return $this->getData(ShipmentInterface::ORDER_ID);
    }

getPackages()

getPackages

(

)

Returns packages

@codeCoverageIgnore

Returns

string

Implements ShipmentInterface.

Definition at line 532 of file Shipment.php.

    {
        return $this->getData(ShipmentInterface::PACKAGES);
    }

getProtectCode()

getProtectCode

(

)

Retrieve hash code of current order

Returns

string

Definition at line 197 of file Shipment.php.

    {
        return (string)$this->getOrder()->getProtectCode();
    }

getShipmentStatus()

getShipmentStatus

(

)

Returns shipment_status

Returns

int

Implements ShipmentInterface.

Definition at line 674 of file Shipment.php.

    {
        return $this->getData(ShipmentInterface::SHIPMENT_STATUS);
    }

getShippingAddress()

getShippingAddress

(

)

Retrieve shipping address

Returns

Address

Definition at line 242 of file Shipment.php.

    {
        return $this->getOrder()->getShippingAddress();
    }

getShippingAddressId()

getShippingAddressId

(

)

Returns shipping_address_id

Returns

int

Implements ShipmentInterface.

Definition at line 684 of file Shipment.php.

    {
        return $this->getData(ShipmentInterface::SHIPPING_ADDRESS_ID);
    }

getShippingLabel()

getShippingLabel

(

)

Get shipping label and decode by db adapter

Returns

mixed

Implements ShipmentInterface.

Definition at line 504 of file Shipment.php.

    {
        $label = $this->getData('shipping_label');
        if ($label) {
            return $this->getResource()->getConnection()->decodeVarbinary($label);
        }
        return $label;
    }

getStore()

getStore

(

)

Retrieve store model instance

Returns

\Magento\Store\Model\Store

Definition at line 482 of file Shipment.php.

    {
        return $this->getOrder()->getStore();
    }

getStoreId()

getStoreId

(

)

Returns store_id

Returns

int

Implements ShipmentInterface.

Definition at line 694 of file Shipment.php.

    {
        return $this->getData(ShipmentInterface::STORE_ID);
    }

getTotalQty()

getTotalQty

(

)

Returns total_qty

Returns

float

Implements ShipmentInterface.

Definition at line 704 of file Shipment.php.

    {
        return $this->getData(ShipmentInterface::TOTAL_QTY);
    }

getTotalWeight()

getTotalWeight

(

)

Returns total_weight

Returns

float

Implements ShipmentInterface.

Definition at line 714 of file Shipment.php.

    {
        return $this->getData(ShipmentInterface::TOTAL_WEIGHT);
    }

getTrackById()

getTrackById

(

$trackId

)

Retrieves a track using its ID

Parameters

string | int

$trackId

Returns

bool|\Magento\Sales\Model\Order\Shipment\Track

Definition at line 385 of file Shipment.php.

    {
        foreach ($this->getTracksCollection() as $track) {
            if ($track->getId() == $trackId) {
                return $track;
            }
        }
        return false;
    }

getTracks()

getTracks

(

)

Returns tracks

Returns

\Magento\Sales\Api\Data\ShipmentTrackInterface[]

Implements ShipmentInterface.

Definition at line 587 of file Shipment.php.

    {
        if ($this->getData(ShipmentInterface::TRACKS) === null) {
            foreach ($this->getTracksCollection() as $item) {
                $item->setShipment($this);
            }
            $this->setData(ShipmentInterface::TRACKS, $this->getTracksCollection()->getItems());
        }
        return $this->getData(ShipmentInterface::TRACKS);
    }

getTracksCollection()

getTracksCollection

(

)

Retrieve tracks collection.

Returns

\Magento\Sales\Model\ResourceModel\Order\Shipment\Track\Collection

Definition at line 354 of file Shipment.php.

    {
        if ($this->tracksCollection === null) {
            $this->tracksCollection = $this->_trackCollectionFactory->create()->setShipmentFilter($this->getId());
        }

        return $this->tracksCollection;
    }

getUpdatedAt()

getUpdatedAt

(

)

Returns updated_at

Returns

string

Implements ShipmentInterface.

Definition at line 724 of file Shipment.php.

    {
        return $this->getData(ShipmentInterface::UPDATED_AT);
    }

loadByIncrementId()

loadByIncrementId

(

$incrementId

)

Load shipment by increment id

Parameters

string

$incrementId

Returns

$this

Definition at line 168 of file Shipment.php.

    {
        $ids = $this->getCollection()->addAttributeToFilter('increment_id', $incrementId)->getAllIds();

        if (!empty($ids)) {
            reset($ids);
            $this->load(current($ids));
        }
        return $this;
    }

setBillingAddressId()

setBillingAddressId

(

$id

)

Sets the billing address ID for the shipment.

Parameters

int

$id

Returns

$this

Implements ShipmentInterface.

Definition at line 822 of file Shipment.php.

    {
        return $this->setData(ShipmentInterface::BILLING_ADDRESS_ID, $id);
    }

setComments()

setComments

(

$comments = null

)

Sets comments

Parameters

Implements ShipmentInterface.

Definition at line 758 of file Shipment.php.

    {
        return $this->setData(ShipmentInterface::COMMENTS, $comments);
    }

setCreatedAt()

setCreatedAt

(

$createdAt

)

Sets the created-at timestamp for the shipment.

Parameters

string

$createdAt

timestamp

Returns

$this

Implements ShipmentInterface.

Definition at line 634 of file Shipment.php.

    {
        return $this->setData(ShipmentInterface::CREATED_AT, $createdAt);
    }

setCustomerId()

setCustomerId

(

$id

)

Sets the customer ID for the shipment.

Parameters

int

$id

Returns

$this

Implements ShipmentInterface.

Definition at line 806 of file Shipment.php.

    {
        return $this->setData(ShipmentInterface::CUSTOMER_ID, $id);
    }

setEmailSent()

setEmailSent

(

$emailSent

)

Sets the email-sent flag value for the shipment.

Parameters

int

$emailSent

Returns

$this

Implements ShipmentInterface.

Definition at line 790 of file Shipment.php.

    {
        return $this->setData(ShipmentInterface::EMAIL_SENT, $emailSent);
    }

setExtensionAttributes()

setExtensionAttributes

(

\Magento\Sales\Api\Data\ShipmentExtensionInterface

$extensionAttributes

)

Parameters

\Magento\Sales\Api\Data\ShipmentExtensionInterface

$extensionAttributes

Returns

$this

Definition at line 867 of file Shipment.php.

    {
        return $this->_setExtensionAttributes($extensionAttributes);
    }

setIncrementId()

setIncrementId

(

$id

)

Sets the increment ID for the shipment.

Parameters

string

$id

Returns

$this

Implements ShipmentInterface.

Definition at line 838 of file Shipment.php.

    {
        return $this->setData(ShipmentInterface::INCREMENT_ID, $id);
    }

setItems()

setItems

(

$items

)

Sets items

@codeCoverageIgnore

Parameters

mixed

$items

Returns

$this

Implements ShipmentInterface.

Definition at line 577 of file Shipment.php.

    {
        return $this->setData(ShipmentInterface::ITEMS, $items);
    }

setOrder()

setOrder

(

\Magento\Sales\Model\Order

$order

)

Declare order for shipment

Parameters

\Magento\Sales\Model\Order

$order

Returns

$this

Definition at line 185 of file Shipment.php.

    {
        $this->_order = $order;
        $this->setOrderId($order->getId())->setStoreId($order->getStoreId());
        return $this;
    }

setOrderId()

setOrderId

(

$id

)

Sets the order ID for the shipment.

Parameters

int

$id

Returns

$this

Implements ShipmentInterface.

Definition at line 798 of file Shipment.php.

    {
        return $this->setData(ShipmentInterface::ORDER_ID, $id);
    }

setPackages()

setPackages

(

array

$packages = null

)

Sets any packages for the shipment.

Parameters

@codeCoverageIgnore

Implements ShipmentInterface.

Definition at line 541 of file Shipment.php.

    {
        return $this->setData(ShipmentInterface::PACKAGES, $packages);
    }

setShipmentStatus()

setShipmentStatus

(

$shipmentStatus

)

Sets the shipment status.

Parameters

int

$shipmentStatus

Returns

$this

Implements ShipmentInterface.

Definition at line 830 of file Shipment.php.

    {
        return $this->setData(ShipmentInterface::SHIPMENT_STATUS, $shipmentStatus);
    }

setShippingAddressId()

setShippingAddressId

(

$id

)

Sets the shipping address ID for the shipment.

Parameters

int

$id

Returns

$this

Implements ShipmentInterface.

Definition at line 814 of file Shipment.php.

    {
        return $this->setData(ShipmentInterface::SHIPPING_ADDRESS_ID, $id);
    }

setShippingLabel()

setShippingLabel

(

$label

)

Set shipping label

Parameters

string

$label

label representation (image or pdf file)

Returns

$this

Implements ShipmentInterface.

Definition at line 493 of file Shipment.php.

    {
        $this->setData('shipping_label', $label);
        return $this;
    }

setStoreId()

setStoreId

(

$id

)

Sets the store ID for the shipment.

Parameters

int

$id

Returns

$this

Implements ShipmentInterface.

Definition at line 766 of file Shipment.php.

    {
        return $this->setData(ShipmentInterface::STORE_ID, $id);
    }

setTotalQty()

setTotalQty

(

$qty

)

Sets the total quantity for the shipment.

Parameters

float

$qty

Returns

$this

Implements ShipmentInterface.

Definition at line 782 of file Shipment.php.

    {
        return $this->setData(ShipmentInterface::TOTAL_QTY, $qty);
    }

setTotalWeight()

setTotalWeight

(

$totalWeight

)

Sets the total weight for the shipment.

Parameters

float

$totalWeight

Returns

$this

Implements ShipmentInterface.

Definition at line 774 of file Shipment.php.

    {
        return $this->setData(ShipmentInterface::TOTAL_WEIGHT, $totalWeight);
    }

setTracks()

setTracks

(

$tracks

)

Returns tracks

Parameters

Implements ShipmentInterface.

Definition at line 606 of file Shipment.php.

    {
        return $this->setData(ShipmentInterface::TRACKS, $tracks);
    }

setUpdatedAt()

setUpdatedAt

(

$timestamp

)

Sets the updated-at timestamp for the shipment.

Parameters

string

$timestamp

Returns

$this

Implements ShipmentInterface.

Definition at line 846 of file Shipment.php.

    {
        return $this->setData(ShipmentInterface::UPDATED_AT, $timestamp);
    }

Field Documentation

$_commentCollectionFactory

$_commentCollectionFactory

protected

Definition at line 90 of file Shipment.php.

$_commentFactory

$_commentFactory

protected

Definition at line 85 of file Shipment.php.

$_eventObject

$_eventObject = 'shipment'

protected

Definition at line 70 of file Shipment.php.

$_eventPrefix

$_eventPrefix = 'sales_order_shipment'

protected

Definition at line 65 of file Shipment.php.

$_order

$_order

protected

Definition at line 60 of file Shipment.php.

$_shipmentItemCollectionFactory

$_shipmentItemCollectionFactory

protected

Definition at line 75 of file Shipment.php.

$_trackCollectionFactory

$_trackCollectionFactory

protected

Definition at line 80 of file Shipment.php.

$entityType

$entityType = 'shipment'

protected

Definition at line 55 of file Shipment.php.

$orderRepository

$orderRepository

protected

Definition at line 95 of file Shipment.php.

REPORT_DATE_TYPE_ORDER_CREATED

const REPORT_DATE_TYPE_ORDER_CREATED = 'order_created'

Definition at line 31 of file Shipment.php.

REPORT_DATE_TYPE_SHIPMENT_CREATED

const REPORT_DATE_TYPE_SHIPMENT_CREATED = 'shipment_created'

Definition at line 33 of file Shipment.php.

STATUS_NEW

const STATUS_NEW = 1

Definition at line 29 of file Shipment.php.

XML_PATH_STORE_ADDRESS1

const XML_PATH_STORE_ADDRESS1 = 'shipping/origin/street_line1'

Store address

Definition at line 38 of file Shipment.php.

XML_PATH_STORE_ADDRESS2

const XML_PATH_STORE_ADDRESS2 = 'shipping/origin/street_line2'

Definition at line 40 of file Shipment.php.

XML_PATH_STORE_CITY

const XML_PATH_STORE_CITY = 'shipping/origin/city'

Definition at line 42 of file Shipment.php.

XML_PATH_STORE_COUNTRY_ID

const XML_PATH_STORE_COUNTRY_ID = 'shipping/origin/country_id'

Definition at line 48 of file Shipment.php.

XML_PATH_STORE_REGION_ID

const XML_PATH_STORE_REGION_ID = 'shipping/origin/region_id'

Definition at line 44 of file Shipment.php.

XML_PATH_STORE_ZIP

const XML_PATH_STORE_ZIP = 'shipping/origin/postcode'

Definition at line 46 of file Shipment.php.

---

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

• vendor/magento/module-sales/Model/Order/Shipment.php