Interface IOrderSearchAsyncService

Namespace: EPiServer.Commerce.Order.Internal

Assembly: Mediachase.Commerce.dll

Version: 14.26.0

Syntax

public interface IOrderSearchAsyncService

Methods

FilterAsync<TOrderGroup>(String, OrderSearchFilter, CancellationToken)

Filters orders asynchronously by a set of parameters in OrderFilterResult and CustomerEmail, CustomerName or OrderId equal to or similar to filterValue for a specific TOrderGroup.

Declaration

Task<OrderFilterResult> FilterAsync<TOrderGroup>(string filterValue, OrderSearchFilter filter, CancellationToken cancellationToken)
    where TOrderGroup : class, IOrderGroup

Parameters

Type	Name	Description
System.String	filterValue	The filter value use to search. For example: CustomerEmail, CustomerName or TrackingNumber.
OrderSearchFilter	filter	The order search filter.
System.Threading.CancellationToken	cancellationToken	The cancellation instruction.

Returns

Type	Description
System.Threading.Tasks.Task<OrderFilterResult>	A task of OrderFilterResult. Contains a collection of order matching all criteria in the `filter` and CustomerEmail, CustomerName or TrackingNumber equal to or similar to `filterValue`.

Type Parameters

Name	Description
TOrderGroup	The given order type for filter.

SearchAsync<TOrderGroup>(String, OrderSearchFilter, CancellationToken)

Finds orders asynchronously by a set of parameters in OrderSearchFilter and CustomerEmail, CustomerName or CartId equal to or similar to searchValue for a specific TOrderGroup.

Declaration

Task<OrderSearchResults<TOrderGroup>> SearchAsync<TOrderGroup>(string searchValue, OrderSearchFilter filter, CancellationToken cancellationToken)
    where TOrderGroup : class, IOrderGroup

Parameters

Type	Name	Description
System.String	searchValue	The search value use to search. For example: CustomerEmail, CustomerName or TrackingNumber.
OrderSearchFilter	filter	The search filter.
System.Threading.CancellationToken	cancellationToken	The cancellation instruction.

Returns

Type	Description
System.Threading.Tasks.Task<OrderSearchResults<TOrderGroup>>	A task of OrderSearchResults<T>. Contains a collection of order matching all criteria in the `filter` and CustomerEmail, CustomerName or TrackingNumber equal to or similar to `searchValue`.

Type Parameters

Name	Description
TOrderGroup	The given order type for filter.