Class OrderSearchFilter

Namespace

Dynamicweb.Ecommerce.Orders

Assembly

Dynamicweb.Ecommerce.dll

Represents the search filter for orders, carts, ledgers, and other records in the EcomOrders table.

public class OrderSearchFilter

Inheritance

object

OrderSearchFilter

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

CaptureState

Gets or sets the capture state for filtering the search results by capture state.

public OrderSearchFilter.CaptureStates CaptureState { get; set; }

Property Value

OrderSearchFilter.CaptureStates

CaptureStatesValues

Gets or sets the capture state values for filtering the search results by capture state.

public IEnumerable<OrderSearchFilter.CaptureStates> CaptureStatesValues { get; set; }

Property Value

IEnumerable<OrderSearchFilter.CaptureStates>

Completed

Gets or sets the completed state for filtering the search results by completed state.

public OrderSearchFilter.CompletedStates Completed { get; set; }

Property Value

OrderSearchFilter.CompletedStates

CurrencyCodes

Gets or sets the currency codes for filtering the search results by currency code.

public IEnumerable<string> CurrencyCodes { get; set; }

Property Value

IEnumerable<string>

Remarks

E.g. 'EUR'

CustomerId

Gets or sets the customer ID for filtering the search results by customer.

public int CustomerId { get; set; }

Property Value

int

Remarks

E.g. 123

CustomerName

Gets or sets the customer name for filtering the search results by customer name.

public string CustomerName { get; set; }

Property Value

string

Remarks

E.g. 'john'

CustomerNumber

Gets or sets the customer number for filtering the search results by customer number.

public string CustomerNumber { get; set; }

Property Value

string

Remarks

E.g. 'ABC123'

DoSearch

Gets or sets a value indicating whether to perform the search.

public bool DoSearch { get; set; }

Property Value

bool

DoTextSearchInProducts

Gets or sets a value indicating whether to perform text search in products.

public bool DoTextSearchInProducts { get; set; }

Property Value

bool

FromCompletedDate

Gets or sets the from completed date for filtering the search results by completed date range.

public DateTime? FromCompletedDate { get; set; }

Property Value

DateTime?

Remarks

E.g. '2023-03-31'

FromDate

Gets or sets the from date for filtering the search results by date range.

public DateTime? FromDate { get; set; }

Property Value

DateTime?

Remarks

E.g. '2023-03-31'

HideCarts

Gets or sets a value indicating whether to hide carts in the search results.

public bool HideCarts { get; set; }

Property Value

bool

IncludeImpersonation

Gets or sets a value indicating whether to include impersonation records in the search results.

public bool IncludeImpersonation { get; set; }

Property Value

bool

IncludeLedgerEntries

Gets or sets a value indicating whether to include ledger entries in the search results.

public bool IncludeLedgerEntries { get; set; }

Property Value

bool

IncludeRecurringOrders

Gets or sets a value indicating whether to include recurring orders in the search results.

public bool IncludeRecurringOrders { get; set; }

Property Value

bool

IncludeUserAndSecondaryUserIds

Gets or sets a value indicating whether to include user and secondary user IDs in the search results when searching for usersids. Meaning orders made under impersonation will be included.

public bool IncludeUserAndSecondaryUserIds { get; set; }

Property Value

bool

IsCart

Gets or sets a value indicating whether the search is for carts.

public bool IsCart { get; set; }

Property Value

bool

IsLedgerEntries

Gets or sets a value indicating whether the search is for ledger entries.

public bool IsLedgerEntries { get; set; }

Property Value

bool

IsQuotes

Gets or sets a value indicating whether the search is for quotes.

public bool IsQuotes { get; set; }

Property Value

bool

IsRecurringOrder

Gets or sets a value indicating whether the search is for recurring orders.

public bool IsRecurringOrder { get; set; }

Property Value

bool

LedgerFlowStates

Gets or sets a value indicating whether the search is for ledger flows.

public IEnumerable<string> LedgerFlowStates { get; set; }

Property Value

IEnumerable<string>

LedgerType

Gets or sets a value indicating whether the search is for ledger types.

public string LedgerType { get; set; }

Property Value

string

OrderBy

Gets or sets the order by field for sorting the search results.

public string OrderBy { get; set; }

Property Value

string

Remarks

E.g. 'OrderID' - any name of a field in EcomOrders table

OrderContextIds

Gets or sets the order context IDs for filtering the search results by order context.

public IEnumerable<string> OrderContextIds { get; set; }

Property Value

IEnumerable<string>

Remarks

E.g. 'CONTEXT1'

OrderIds

Gets or sets the order IDs for filtering the search results by order ID.

public IEnumerable<string> OrderIds { get; set; }

Property Value

IEnumerable<string>

Remarks

E.g. 'ORDER1, CART3'

OrderStateId

Gets or sets the order state ID for filtering the search results by order state.

public string OrderStateId { get; set; }

Property Value

string

Remarks

E.g. 'STATE1'

OrderStateIds

Gets or sets the order state IDs for filtering the search results by order state.

public IEnumerable<string> OrderStateIds { get; set; }

Property Value

IEnumerable<string>

Remarks

E.g. 'STATE1'

PageNumber

Gets or sets the page number for pagination of the search results.

public int PageNumber { get; set; }

Property Value

int

Remarks

E.g. 2

PageSize

Gets or sets the page size for pagination of the search results.

public int PageSize { get; set; }

Property Value

int

Remarks

E.g. 12

PaymentIds

Gets or sets the payment IDs for filtering the search results by payment ID.

public IEnumerable<string> PaymentIds { get; set; }

Property Value

IEnumerable<string>

Remarks

E.g. 'PAY1'

PriceAmountFrom

Gets or sets the price amount from for filtering the search results by price range.

public double? PriceAmountFrom { get; set; }

Property Value

double?

Remarks

E.g. 99.95

PriceAmountTo

Gets or sets the price amount to for filtering the search results by price range.

public double? PriceAmountTo { get; set; }

Property Value

double?

Remarks

E.g. 1150.25

ProductId

Gets or sets the product ID for filtering the search results by product ID.

public string ProductId { get; set; }

Property Value

string

Remarks

E.g. 'PROD1'

ProductName

Gets or sets the product name for filtering the search results by product name.

public string ProductName { get; set; }

Property Value

string

Remarks

E.g. 'my product'

ProductNumber

Gets or sets the product number for filtering the search results by product number.

public string ProductNumber { get; set; }

Property Value

string

Remarks

E.g. 'SKU123'

RecurringOrderId

Gets or sets the recurring order ID for filtering the search results by recurring order.

public int RecurringOrderId { get; set; }

Property Value

int

Remarks

E.g. 123'

RestrictedShopIds

Gets or sets the restricted shop IDs for filtering the search results by restricted shops. ShopIDs that will be left out of the search.

public IEnumerable<string> RestrictedShopIds { get; set; }

Property Value

IEnumerable<string>

Remarks

See ShopIds for the opposite.

SearchCustomerFields

Gets or sets the search customer fields for filtering the search results by customer fields.

public string SearchCustomerFields { get; set; }

Property Value

string

SearchInCustomOrderFields

Gets or sets a value indicating whether to search in custom order fields.

public bool SearchInCustomOrderFields { get; set; }

Property Value

bool

SearchOrderId

Gets or sets the search order ID for filtering the search results by order ID.

public string SearchOrderId { get; set; }

Property Value

string

SecondaryIds

Gets or sets the secondary user IDs for filtering the search results by secondary IDs - if orders are placed on behalf of another user, this field will contain the actual userid

public IEnumerable<string> SecondaryIds { get; set; }

Property Value

IEnumerable<string>

SelectedShopId

Gets or sets the selected shop ID for filtering the search results by shop.

public string SelectedShopId { get; set; }

Property Value

string

Remarks

E.g. 'SHOP1'. Similar to ShopIds but faster if searching just one shop at a time

ShippingIds

Gets or sets the shipping IDs for filtering the search results by shipping ID.

public IEnumerable<string> ShippingIds { get; set; }

Property Value

IEnumerable<string>

Remarks

E.g. 'SHIP1'

ShopIds

Gets or sets the shop IDs for filtering the search results by shop.

public IEnumerable<string> ShopIds { get; set; }

Property Value

IEnumerable<string>

Remarks

E.g. 'SHOP1'

ShowNotExported

Gets or sets a value indicating whether to show not exported records in the search results.

public bool ShowNotExported { get; set; }

Property Value

bool

ShowUntransferred

Gets or sets a value indicating whether to show not transferred records in the search results.

public bool ShowUntransferred { get; set; }

Property Value

bool

TextSearch

Gets or sets the text search query for searching the search results.

public string TextSearch { get; set; }

Property Value

string

Remarks

E.g. 'Scott'

ToCompletedDate

Gets or sets the to completed date for filtering the search results by completed date range.

public DateTime? ToCompletedDate { get; set; }

Property Value

DateTime?

Remarks

E.g. '2024-03-31'

ToDate

Gets or sets the to date for filtering the search results by date range.

public DateTime? ToDate { get; set; }

Property Value

DateTime?

Remarks

E.g. '2024-03-31'