Log in
Model

Shipment

Magento\Sales\Model\Order\Shipment

What it does

The Shipment model represents a physical shipment of products from an order in Magento 2.

Developers use this class to create shipments, manage shipment items, add tracking information, handle shipping labels, and add comments to shipments.

It's the core model for processing and managing order fulfillment operations.

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()