Log in
Interface

ShipmentInterface

Magento\Sales\Api\Data\ShipmentInterface

What it does

This interface defines the contract for shipment data objects in Magento 2.

Developers use it to retrieve and manipulate shipment information including items, tracking numbers, addresses, and shipping labels.

It's commonly used when creating custom shipment logic, integrating with shipping carriers, or displaying shipment details in custom modules.

Public Methods

  • getBillingAddressId()
  • getCreatedAt()
  • setCreatedAt()
  • getCustomerId()
  • getEmailSent()
  • getEntityId()
  • setEntityId()
  • getIncrementId()
  • getOrderId()
  • getPackages()
  • setPackages()
  • getShipmentStatus()
  • getShippingAddressId()
  • getShippingLabel()
  • getStoreId()
  • getTotalQty()
  • getTotalWeight()
  • getUpdatedAt()
  • getItems()
  • setItems()
  • getTracks()
  • setTracks()
  • getComments()
  • setComments()
  • setStoreId()
  • setTotalWeight()
  • setTotalQty()
  • setEmailSent()
  • setOrderId()
  • setCustomerId()
  • setShippingAddressId()
  • setBillingAddressId()
  • setShipmentStatus()
  • setIncrementId()
  • setShippingLabel()
  • setUpdatedAt()
  • getExtensionAttributes()
  • setExtensionAttributes()