Log in
Interface

OrderStatusHistoryInterface

Magento\Sales\Api\Data\OrderStatusHistoryInterface

What it does

This interface defines the contract for order status history entries in Magento 2.

Developers use it to track and manage status changes of orders, including comments, timestamps, customer notifications, and visibility settings.

It's essential when programmatically adding status updates to orders, retrieving order history, or implementing custom order tracking features.

Public Methods

  • getComment()
  • getCreatedAt()
  • setCreatedAt()
  • getEntityId()
  • setEntityId()
  • getEntityName()
  • getIsCustomerNotified()
  • getIsVisibleOnFront()
  • getParentId()
  • getStatus()
  • setParentId()
  • setIsCustomerNotified()
  • setIsVisibleOnFront()
  • setComment()
  • setStatus()
  • setEntityName()
  • getExtensionAttributes()
  • setExtensionAttributes()