OrderStatusHistoryWriterInterface
in
Interface OrderStatusHistoryWriterInterface
Tags
Table of Contents
- addStatusUpdate() : mixed
- Adds an order status history item.
- deleteHistory() : mixed
- Deletes all order status history items which are associated with the given order item ID.
Methods
addStatusUpdate()
Adds an order status history item.
public
addStatusUpdate(IdType $orderId, IntType $newOrderStatusId, StringType $comment, BoolType $customerNotified[, IdType $customerId = null ]) : mixed
Parameters
- $orderId : IdType
-
Order ID.
- $newOrderStatusId : IntType
-
New order status ID.
- $comment : StringType
-
Comment.
- $customerNotified : BoolType
-
Is customer notified?
- $customerId : IdType = null
-
Customer ID of the admin account.
Return values
mixed —deleteHistory()
Deletes all order status history items which are associated with the given order item ID.
public
deleteHistory(IdType $orderId) : mixed
Parameters
- $orderId : IdType
-
Order ID.