Public Member Functions | |
| getComment () | |
| getCreatedAt () | |
| setCreatedAt ($createdAt) | |
| getEntityId () | |
| setEntityId ($entityId) | |
| getEntityName () | |
| getIsCustomerNotified () | |
| getIsVisibleOnFront () | |
| getParentId () | |
| getStatus () | |
| setParentId ($id) | |
| setIsCustomerNotified ($isCustomerNotified) | |
| setIsVisibleOnFront ($isVisibleOnFront) | |
| setComment ($comment) | |
| setStatus ($status) | |
| setEntityName ($entityName) | |
| getExtensionAttributes () | |
| setExtensionAttributes (\Magento\Sales\Api\Data\OrderStatusHistoryExtensionInterface $extensionAttributes) | |
Data Fields | |
| const | ENTITY_ID = 'entity_id' |
| const | PARENT_ID = 'parent_id' |
| const | IS_CUSTOMER_NOTIFIED = 'is_customer_notified' |
| const | IS_VISIBLE_ON_FRONT = 'is_visible_on_front' |
| const | COMMENT = 'comment' |
| const | STATUS = 'status' |
| const | CREATED_AT = 'created_at' |
| const | ENTITY_NAME = 'entity_name' |
 Data Fields inherited from ExtensibleDataInterface | |
| const | EXTENSION_ATTRIBUTES_KEY = 'extension_attributes' |
Detailed Description
Order status history interface.
An order is a document that a web store issues to a customer. Magento generates a sales order that lists the product items, billing and shipping addresses, and shipping and payment methods. A corresponding external document, known as a purchase order, is emailed to the customer. @api
- Since
- 100.0.2
Definition at line 17 of file OrderStatusHistoryInterface.php.
Member Function Documentation
◆ getComment()
| getComment | ( | ) |
◆ getCreatedAt()
| getCreatedAt | ( | ) |
Gets the created-at timestamp for the order status history.
- Returns
- string|null Created-at timestamp.
Implemented in History.
◆ getEntityId()
| getEntityId | ( | ) |
Gets the ID for the order status history.
- Returns
- int|null Order status history ID.
Implemented in History.
◆ getEntityName()
| getEntityName | ( | ) |
Gets the entity name for the order status history.
- Returns
- string|null Entity name.
Implemented in History.
◆ getExtensionAttributes()
| getExtensionAttributes | ( | ) |
Retrieve existing extension attributes object or create a new one.
- Returns
- \Magento\Sales\Api\Data\OrderStatusHistoryExtensionInterface|null
Implemented in History.
◆ getIsCustomerNotified()
| getIsCustomerNotified | ( | ) |
Gets the is-customer-notified flag value for the order status history.
- Returns
- int Is-customer-notified flag value.
Implemented in History.
◆ getIsVisibleOnFront()
| getIsVisibleOnFront | ( | ) |
Gets the is-visible-on-storefront flag value for the order status history.
- Returns
- int Is-visible-on-storefront flag value.
Implemented in History.
◆ getParentId()
| getParentId | ( | ) |
◆ getStatus()
| getStatus | ( | ) |
◆ setComment()
| setComment | ( | $comment | ) |
Sets the comment for the order status history.
- Parameters
-
string $comment
- Returns
- $this
Implemented in History.
◆ setCreatedAt()
| setCreatedAt | ( | $createdAt | ) |
Sets the created-at timestamp for the order status history.
- Parameters
-
string $createdAt timestamp
- Returns
- $this
Implemented in History.
◆ setEntityId()
| setEntityId | ( | $entityId | ) |
Sets entity ID.
- Parameters
-
int $entityId
- Returns
- $this
◆ setEntityName()
| setEntityName | ( | $entityName | ) |
Sets the entity name for the order status history.
- Parameters
-
string $entityName
- Returns
- $this
Implemented in History.
◆ setExtensionAttributes()
| setExtensionAttributes | ( | \Magento\Sales\Api\Data\OrderStatusHistoryExtensionInterface | $extensionAttributes | ) |
Set an extension attributes object.
- Parameters
-
\Magento\Sales\Api\Data\OrderStatusHistoryExtensionInterface $extensionAttributes
- Returns
- $this
◆ setIsCustomerNotified()
| setIsCustomerNotified | ( | $isCustomerNotified | ) |
Sets the is-customer-notified flag value for the order status history.
- Parameters
-
int $isCustomerNotified
- Returns
- $this
Implemented in History.
◆ setIsVisibleOnFront()
| setIsVisibleOnFront | ( | $isVisibleOnFront | ) |
Sets the is-visible-on-storefront flag value for the order status history.
- Parameters
-
int $isVisibleOnFront
- Returns
- $this
Implemented in History.
◆ setParentId()
| setParentId | ( | $id | ) |
Sets the parent ID for the order status history.
- Parameters
-
int $id
- Returns
- $this
Implemented in History.
◆ setStatus()
| setStatus | ( | $status | ) |
Sets the status for the order status history.
- Parameters
-
string $status
- Returns
- $this
Implemented in History.
Field Documentation
◆ COMMENT
| const COMMENT = 'comment' |
Definition at line 41 of file OrderStatusHistoryInterface.php.
◆ CREATED_AT
| const CREATED_AT = 'created_at' |
Definition at line 49 of file OrderStatusHistoryInterface.php.
◆ ENTITY_ID
| const ENTITY_ID = 'entity_id' |
#+ Constants for keys of data array. Identical to the name of the getter in snake case.
Definition at line 25 of file OrderStatusHistoryInterface.php.
◆ ENTITY_NAME
| const ENTITY_NAME = 'entity_name' |
Definition at line 53 of file OrderStatusHistoryInterface.php.
◆ IS_CUSTOMER_NOTIFIED
| const IS_CUSTOMER_NOTIFIED = 'is_customer_notified' |
Definition at line 33 of file OrderStatusHistoryInterface.php.
◆ IS_VISIBLE_ON_FRONT
| const IS_VISIBLE_ON_FRONT = 'is_visible_on_front' |
Definition at line 37 of file OrderStatusHistoryInterface.php.
◆ PARENT_ID
| const PARENT_ID = 'parent_id' |
Definition at line 29 of file OrderStatusHistoryInterface.php.
◆ STATUS
| const STATUS = 'status' |
Definition at line 45 of file OrderStatusHistoryInterface.php.
The documentation for this interface was generated from the following file:
- vendor/magento/module-sales/Api/Data/OrderStatusHistoryInterface.php