Don't miss out Virtual Happy Hour today (April 26).

Try our conversational search powered by Generative AI!

AI OnAI Off

Class OrderSearchFilter

Filter class used to filter which orders to retrieve.

Inheritance
System.Object
OrderSearchFilter
CartFilter
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: EPiServer.Commerce.Order
Assembly: Mediachase.Commerce.dll
Version: 13.30.0
Syntax
public class OrderSearchFilter

Constructors

OrderSearchFilter()

Initializes a new instance of OrderSearchFilter

Declaration
public OrderSearchFilter()

Properties

CreatedFrom

Specifies the time that returned orders were created after.

Declaration
public DateTime CreatedFrom { get; set; }
Property Value
Type Description
System.DateTime

CreatedTo

Specifies the time that returned orders were created before.

Declaration
public DateTime CreatedTo { get; set; }
Property Value
Type Description
System.DateTime

CustomerId

Specifies that only carts/orders created by specified customer should be returned.

Declaration
public Guid CustomerId { get; set; }
Property Value
Type Description
System.Guid

MarketId

Specified that only orders created in specified market should be returned.

Declaration
public string MarketId { get; set; }
Property Value
Type Description
System.String

ModifiedFrom

Specifies the time that returned orders were modified after.

Declaration
public DateTime ModifiedFrom { get; set; }
Property Value
Type Description
System.DateTime

ModifiedTo

Specifies the time that returned orders were modified before.

Declaration
public DateTime ModifiedTo { get; set; }
Property Value
Type Description
System.DateTime

ParentOrderGroupId

This can be used to relate purchase orders to a payment plan or other order.

Declaration
public int ParentOrderGroupId { get; set; }
Property Value
Type Description
System.Int32

RecordsToRetrieve

Gets or sets the number of records to retrieve.

Declaration
public int RecordsToRetrieve { get; set; }
Property Value
Type Description
System.Int32

ReturnTotalCount

Flag to indicate if the search should return the total count of matched orders/carts.

Declaration
public bool ReturnTotalCount { get; set; }
Property Value
Type Description
System.Boolean
Remarks

If true, the true total records count will be return, otherwise, set to 0.

StartingIndex

Gets or sets the starting index.

Declaration
public int StartingIndex { get; set; }
Property Value
Type Description
System.Int32

Statuses

Specified that only orders having statuses should be returned.

Declaration
public IEnumerable<OrderStatus> Statuses { get; set; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<OrderStatus>