Shipment

What it does

This class represents a shipment entity in Magento 2's order fulfillment workflow.

Developers use it to create, manage, and track product shipments for orders, including adding shipment items, tracking numbers, comments, and managing shipping labels.

It provides methods to associate a shipment with its parent order, register shipment quantities, and handle all shipment-related data and relationships.

Public Methods

• loadByIncrementId()
• setOrder()
• getProtectCode()
• getOrder()
• getEntityType()
• getBillingAddress()
• getShippingAddress()
• register()
• getItemsCollection()
• getAllItems()
• getItemById()
• addItem()
• getTracksCollection()
• getAllTracks()
• getTrackById()
• addTrack()
• addComment()
• getCommentsCollection()
• getStore()
• setShippingLabel()
• getShippingLabel()
• getIncrementId()
• getPackages()
• setPackages()
• getItems()
• setItems()
• getTracks()
• setTracks()
• getBillingAddressId()
• getCreatedAt()
• setCreatedAt()
• getCustomerId()
• getEmailSent()
• getOrderId()
• getShipmentStatus()
• getShippingAddressId()
• getStoreId()
• getTotalQty()
• getTotalWeight()
• getUpdatedAt()
• getComments()
• setComments()
• setStoreId()
• setTotalWeight()
• setTotalQty()
• setEmailSent()
• setOrderId()
• setCustomerId()
• setShippingAddressId()
• setBillingAddressId()
• setShipmentStatus()
• setIncrementId()
• setUpdatedAt()
• getExtensionAttributes()
• setExtensionAttributes()