API Documentation
Back to top  

OrderReadServiceInterface

Extends

Interface OrderReadServiceInterface

category

System
package

Order
subpackage

Interfaces

Methods

Filter the order records with specific conditions.

filterOrderList(array $filterParameters, \IntType $startIndex = null, \IntType $maxCount = null, \StringType $orderBy = null) : \OrderListItemCollection

Provide the filtering values in the conditions array in order to fetch a filtered result set.

Arguments

$filterParameters

array

Contains an array of the GET parameters to be used for filtering the order records.

$startIndex

\IntType

Start index of order list item collections which should be returned.

$maxCount

\IntType

Maximum amount of collections.

$orderBy

\StringType

Argument to specify the order.

Response

\OrderListItemCollection

Get the filtered orders count.

filterOrderListCount(array $filterParameters) : integer
Throws
\BadMethodCallException

Arguments

$filterParameters

array

Response

integer

Returns an order, depending on the provided order ID.

getOrderById(\IdType $orderId) : \Order

Arguments

$orderId

\IdType

Order ID.

Response

\Order

Found order.

Returns a stored order item, depending on the provided order item ID.

getOrderItemById(\IdType $orderItemId) : \StoredOrderItemInterface

Arguments

$orderItemId

\IdType

Order item ID.

Response

\StoredOrderItemInterface

Found stored order item interface.

Returns an OrderListItemCollection depending on the provided arguments.

getOrderList(\IntType $startIndex = null, \IntType $maxCount = null, \StringType $orderBy = null) : \OrderListItemCollection

Arguments

$startIndex

\IntType

Start index of order list item collections which should be returned.

$maxCount

\IntType

Maximum amount of collections.

$orderBy

\StringType

Argument to specify the order.

Response

\OrderListItemCollection

Order list item collection.

Returns an OrderListItemCollection depending on the provided customer ID.

getOrderListByCustomerId(\IdType $customerId, \IntType $startIndex = null, \IntType $maxCount = null, \StringType $orderBy = null) : \OrderListItemCollection

Arguments

$customerId

\IdType

Customer ID

$startIndex

\IntType

Start index of order list item collections which should be returned.

$maxCount

\IntType

Maximum amount of collections.

$orderBy

\StringType

Argument to specify the order.

Response

\OrderListItemCollection

Order list item collection.

Filter the order list by a string keyword.

getOrderListByKeyword(\StringType $keyword, \IntType $startIndex = null, \IntType $maxCount = null, \StringType $orderBy = null) : \OrderListItemCollection

Arguments

$keyword

\StringType

Keyword to be used for searching the order list items.

$startIndex

\IntType

Start index of order list item collections which should be returned.

$maxCount

\IntType

Maximum amount of collections.

$orderBy

\StringType

Argument to specify the order.

Response

\OrderListItemCollection

Order list item collection.

Get Count of orders filtered by keyword

getOrderListByKeywordCount(\StringType $keyword) : integer

Arguments

$keyword

\StringType

Keyword to be used for searching in orders list items.

Response

integer

Returns an OrderListItemCollection depending on the provided order status ID.

getOrderListByOrderStatusId(\IntType $orderStatusId, \IntType $startIndex = null, \IntType $maxCount = null, \StringType $orderBy = null) : \OrderListItemCollection

Arguments

$orderStatusId

\IntType

Order status ID

$startIndex

\IntType

Start index of order list item collections which should be returned.

$maxCount

\IntType

Maximum amount of collections.

$orderBy

\StringType

Argument to specify the order.

Response

\OrderListItemCollection

Order list item collection.

Get the total count of all orders

getOrderListCount() : integer

Response

integer

searchOrders

searchOrders(\OrderSearchCondition $searchCondition, \Pager $pager) : mixed

Arguments

$searchCondition

\OrderSearchCondition

$pager

\Pager

Response

mixed