API Documentation
Back to top  

OrderItemRepositoryInterface

Extends

Interface OrderItemRepositoryInterface

category

System
package

Order
subpackage

Interfaces

Methods

Adds an order item to the order item repository.

addToOrder(\IdType $orderId, \OrderItemInterface $orderItem) : integer

Arguments

$orderId

\IdType

Order ID.

$orderItem

\OrderItemInterface

Order item to add.

Response

integer

ID of the StoredOrderItem

Deletes an order item from the repository by the given order item ID.

deleteItemById(\IdType $orderItemId) : \OrderItemRepositoryInterface

Arguments

$orderItemId

\IdType

Order item ID.

Response

\OrderItemRepositoryInterface

Same instance for method chaining.

Deletes order items from the repository by the given order ID.

deleteItemsByOrderId(\IdType $orderId) : \OrderItemRepositoryInterface

Arguments

$orderId

\IdType

Order ID.

Response

\OrderItemRepositoryInterface

Same instance for method chaining.

Returns a stored order ID by the given order item ID.

getItemById(\IdType $orderItemId) : \StoredOrderItemInterface

Arguments

$orderItemId

\IdType

ID of the stored order item.

Response

\StoredOrderItemInterface

Stored order item.

Returns a stored order item collection by the given order ID.

getItemsByOrderId(\IdType $orderId) : \StoredOrderItemCollection

Arguments

$orderId

\IdType

ID of the order.

Response

\StoredOrderItemCollection

Stored order item collection.

Saves the order item in the repository.

store(\StoredOrderItemInterface $storedOrderItem) : \OrderItemRepositoryInterface

Arguments

$storedOrderItem

\StoredOrderItemInterface

Order item to save.

Response

\OrderItemRepositoryInterface

Same instance for method chaining.