API Documentation
Back to top  

OrderStatusHistoryWriterInterface

Extends

Interface OrderStatusHistoryWriterInterface

category

System
package

Order
subpackage

Interfaces

Methods

Adds an order status history item.

addStatusUpdate(\IdType $orderId, \IntType $newOrderStatusId, \StringType $comment, \BoolType $customerNotified, \IdType $customerId = null)

Arguments

$orderId

\IdType

Order ID.

$newOrderStatusId

\IntType

New order status ID.

$comment

\StringType

Comment.

$customerNotified

\BoolType

Is customer notified?

$customerId

\IdType

Customer ID of the admin account.

Deletes all order status history items which are associated with the given order item ID.

deleteHistory(\IdType $orderId)

Arguments

$orderId

\IdType

Order ID.