public
Order
|
#
getOrderById( IdType $orderId )
Returns an order, depending on the provided order ID.
Returns an order, depending on the provided order ID.
Parameters
Returns
Order Found order.
|
public
StoredOrderItemInterface
|
#
getOrderItemById( IdType $orderItemId )
Returns a stored order item, depending on the provided order item ID.
Returns a stored order item, depending on the provided order item ID.
Parameters
- $orderItemId
- Order item ID.
Returns
|
public
OrderListItemCollection
|
#
getOrderList( IntType $startIndex = null, IntType $maxCount = null, StringType $orderBy = null )
Returns an OrderListItemCollection depending on the provided arguments.
Returns an OrderListItemCollection depending on the provided arguments.
Parameters
- $startIndex
- Start index of order list item collections which should be returned.
- $maxCount
- Maximum amount of collections.
- $orderBy
- Argument to specify the order.
Returns
|
public
OrderListItemCollection
|
#
filterOrderList( array $filterParameters, IntType $startIndex = null, IntType $maxCount = null, StringType $orderBy = null )
Filter the order records with specific conditions.
Filter the order records with specific conditions.
Provide the filtering values in the conditions array in order to fetch a filtered result set.
Parameters
- $filterParameters
Contains an array of the GET parameters to be used for filtering the order
records.
- $startIndex
- Start index of order list item collections which should be returned.
- $maxCount
- Maximum amount of collections.
- $orderBy
- Argument to specify the order.
Returns
|
public
integer
|
#
filterOrderListCount( array $filterParameters )
Get the filtered orders count.
Get the filtered orders count.
Parameters
Returns
integer
Throws
BadMethodCallException
|
public
OrderListItemCollection
|
#
getOrderListByCustomerId( IdType $customerId, IntType $startIndex = null, IntType $maxCount = null, StringType $orderBy = null )
Returns an OrderListItemCollection depending on the provided customer ID.
Returns an OrderListItemCollection depending on the provided customer ID.
Parameters
- $customerId
- Customer ID
- $startIndex
- Start index of order list item collections which should be returned.
- $maxCount
- Maximum amount of collections.
- $orderBy
- Argument to specify the order.
Returns
|
public
OrderListItemCollection
|
#
getOrderListByOrderStatusId( IntType $orderStatusId, IntType $startIndex = null, IntType $maxCount = null, StringType $orderBy = null )
Returns an OrderListItemCollection depending on the provided order status ID.
Returns an OrderListItemCollection depending on the provided order status ID.
Parameters
- $orderStatusId
- Order status ID
- $startIndex
- Start index of order list item collections which should be returned.
- $maxCount
- Maximum amount of collections.
- $orderBy
- Argument to specify the order.
Returns
|
public
OrderListItemCollection
|
#
getOrderListByKeyword( StringType $keyword, IntType $startIndex = null, IntType $maxCount = null, StringType $orderBy = null )
Filter the order list by a string keyword.
Filter the order list by a string keyword.
Parameters
- $keyword
- Keyword to be used for searching the order list items.
- $startIndex
- Start index of order list item collections which should be returned.
- $maxCount
- Maximum amount of collections.
- $orderBy
- Argument to specify the order.
Returns
|