API Documentation
Back to top  

OrderStatusHistoryListItem

Class OrderStatusHistoryListItem

category

System
package

Order
subpackage

Entities

Methods

OrderStatusHistoryListItem constructor.

__construct(\IdType $orderStatusHistoryId, \IdType $orderStatusId, \DateTime $dateAdded, \StringType $comment, \BoolType $customerNotified, \IdType $customerId = null)

Arguments

$orderStatusHistoryId

\IdType

Order status history ID.

$orderStatusId

\IdType

Order status ID.

$dateAdded

\DateTime

Order status history item creation date time.

$comment

\StringType

Optional comment of the order status history item.

$customerNotified

\BoolType

Customer notified flag.

$customerId

\IdType

Customer ID of the admin account.

Returns the comment of the order status history item.

getComment() : string

Response

string

Comment of the order status history item.

Returns the customer ID of the admin account.

getCustomerId() : integer

Response

integer

Customer ID of admin account.

Returns the order status history item creation date time.

getDateAdded() : \DateTime

Response

\DateTime

Order status history item creation date time.

Returns the ID of the order status history item.

getOrderStatusHistoryId() : integer

Response

integer

Order status history item ID.

Returns the ID of the order status.

getOrderStatusId() : integer

Response

integer

Order status ID.

Returns the value of customer notified flag.

isCustomerNotified() : boolean

Response

boolean

Customer is notified?

Properties

ID of the order status history item.

orderStatusHistoryId : integer
var

Type(s)

integer

ID of the order status.

orderStatusId : integer
var

Type(s)

integer

Order status history item creation date time.

dateAdded : \DateTime
var

Type(s)

\DateTime

Optional comment of the order status history item.

comment : string
var

Type(s)

string

Customer notified flag.

customerNotified : boolean
var

Type(s)

boolean

Customer ID of the admin account.

customerId : integer
var

Type(s)

integer