Class PurchasedProductsFilter

Namespace

Dynamicweb.Ecommerce.Orders

Assembly

Dynamicweb.Ecommerce.dll

Filter options for GetPurchasedProducts(PurchasedProductsFilter).

public sealed class PurchasedProductsFilter

Inheritance

object

PurchasedProductsFilter

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

CurrentPage

Gets or sets the one-based page number. Defaults to 1.

public int CurrentPage { get; init; }

Property Value

int

CustomerNumber

Gets or sets the customer number. When provided, aggregates orders for all accounts sharing this customer number instead of filtering by UserId.

public string? CustomerNumber { get; init; }

Property Value

string

FromDate

Gets or sets an optional lower bound on the order completed date.

public DateTime? FromDate { get; init; }

Property Value

DateTime?

GroupId

Gets or sets an optional group ID to restrict results to products belonging to that group.

public string? GroupId { get; init; }

Property Value

string

OrderBy

Gets or sets the field to sort by. Defaults to CompletedDate.

public PurchasedProductsOrderBy OrderBy { get; init; }

Property Value

PurchasedProductsOrderBy

OrderByDirection

Gets or sets the sort direction. Defaults to Descending.

public PurchasedProductsOrderByDirection OrderByDirection { get; init; }

Property Value

PurchasedProductsOrderByDirection

PageSize

Gets or sets the number of items per page. Defaults to 10.

public int PageSize { get; init; }

Property Value

int

ProductIds

Gets or sets an optional set of product IDs to restrict the results to.

public IReadOnlyList<string>? ProductIds { get; init; }

Property Value

IReadOnlyList<string>

ToDate

Gets or sets an optional upper bound on the order completed date.

public DateTime? ToDate { get; init; }

Property Value

DateTime?

UserId

Gets or sets the ID of the user whose purchase history to query.

public int UserId { get; init; }

Property Value

int