Log in
Interface

ShipmentInterface

Magento\Sales\Api\Data\ShipmentInterface

What it does

This interface defines the data structure and contract for shipment records in Magento 2.

Developers use it when working with order fulfillment to create, retrieve, or modify shipment information including items being shipped, tracking numbers, shipping labels, and associated addresses.

It's essential for customizing shipment operations, integrating with shipping carriers, or building order fulfillment extensions.

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