Class Basket

Namespace

Rescope.Commerce.Core.Entities

Assembly

Rescope.Commerce.Core.dll

Contains information about a basket before it is converted into an Order.

[JsonObject(NamingStrategyType = typeof(CamelCaseNamingStrategy))]
public class Basket : IEntity, IRescopeEntity, IBasketOrSubscription

Inheritance

object

Basket

Implements

IEntity

IRescopeEntity

IBasketOrSubscription

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Baskets are created by the @"Rescope.Commerce.Core.Services.BasketService?displayProperty=name" when a user is browsing your store. Baskets hold information such as shipping/billing address, selected country/currency and the selected shipping method. Once these values are populated, a basket can be converted into an Order using @"Rescope.Commerce.Core.Services.BasketService.InitiatePayment*?displayProperty=nameWithType".

Properties

AdditionalData

public Dictionary<string, string> AdditionalData { get; set; }

Property Value

Dictionary<string, string>

BasketLineItems

[NotMapped]
public IEnumerable<BasketLineItem> BasketLineItems { get; }

Property Value

IEnumerable<BasketLineItem>

BasketSecret

[MaxLength(64)]
[JsonIgnore]
[JsonIgnore]
public string? BasketSecret { get; set; }

Property Value

string

BillingAddress

public PostalAddress? BillingAddress { get; set; }

Property Value

PostalAddress

CancelUrl

public string? CancelUrl { get; set; }

Property Value

string

ConfirmUrl

public string? ConfirmUrl { get; set; }

Property Value

string

CreatedAt

public DateTime CreatedAt { get; set; }

Property Value

DateTime

Currency

public Currency Currency { get; }

Property Value

Currency

CurrencyId

public Guid CurrencyId { get; }

Property Value

Guid

CustomData

public string? CustomData { get; set; }

Property Value

string

DeliveryAddress

public PostalAddress? DeliveryAddress { get; set; }

Property Value

PostalAddress

Email

public string? Email { get; set; }

Property Value

string

Errors

[NotMapped]
public IEnumerable<BasketError> Errors { get; }

Property Value

IEnumerable<BasketError>

Id

public Guid Id { get; }

Property Value

Guid

OrderNumber

public string? OrderNumber { get; }

Property Value

string

PaymentMethod

public PaymentMethod? PaymentMethod { get; set; }

Property Value

PaymentMethod

PaymentMethodId

public Guid? PaymentMethodId { get; set; }

Property Value

Guid?

PaymentStatus

public PaymentStatus PaymentStatus { get; set; }

Property Value

PaymentStatus

Phone

public string? Phone { get; set; }

Property Value

string

ShippingMethod

public ShippingMethod? ShippingMethod { get; set; }

Property Value

ShippingMethod

ShippingMethodId

public Guid? ShippingMethodId { get; set; }

Property Value

Guid?

ShippingPrice

[Column(TypeName = "DECIMAL(19, 4)")]
public decimal ShippingPrice { get; }

Property Value

decimal

ShippingPriceFormatted

public string ShippingPriceFormatted { get; }

Property Value

string

ShippingTax

[Column(TypeName = "DECIMAL(19, 4)")]
public decimal ShippingTax { get; }

Property Value

decimal

ShippingTaxFormatted

public string ShippingTaxFormatted { get; }

Property Value

string

Store

public Store Store { get; }

Property Value

Store

StoreId

public Guid StoreId { get; }

Property Value

Guid

TotalLineItemsTax

[Column(TypeName = "DECIMAL(19, 4)")]
public decimal TotalLineItemsTax { get; }

Property Value

decimal

TotalLineItemsTaxFormatted

public string TotalLineItemsTaxFormatted { get; }

Property Value

string

TotalPrice

[Column(TypeName = "DECIMAL(19, 4)")]
public decimal TotalPrice { get; }

Property Value

decimal

TotalPriceFormatted

public string TotalPriceFormatted { get; }

Property Value

string

TotalShippingPrice

[Column(TypeName = "DECIMAL(19, 4)")]
public decimal TotalShippingPrice { get; }

Property Value

decimal

TotalShippingPriceFormatted

public string TotalShippingPriceFormatted { get; }

Property Value

string

TotalTax

[Column(TypeName = "DECIMAL(19, 4)")]
public decimal TotalTax { get; }

Property Value

decimal

TotalTaxFormatted

public string TotalTaxFormatted { get; }

Property Value

string

UmbracoMemberKey

public Guid? UmbracoMemberKey { get; set; }

Property Value

Guid?

UpdatedAt

public DateTime? UpdatedAt { get; set; }

Property Value

DateTime?

Methods

AddProduct(IProductOrVariant, IStockService?, int, IDictionary<Guid, string>?)

public Task AddProduct(IProductOrVariant product, IStockService? stockService, int quantity = 1, IDictionary<Guid, string>? customisationFields = null)

Parameters

product IProductOrVariant

stockService IStockService

quantity int

customisationFields IDictionary<Guid, string>

Returns

Task

FormatNumber(decimal)

Format a decimal using this baskets's selected currency

public string FormatNumber(decimal number)

Parameters

number decimal

Returns

string

GetProductLineItem(string?)

public BasketLineItem? GetProductLineItem(string? sku)

Parameters

sku string

Returns

BasketLineItem

GetProductQuantity(string?)

public int GetProductQuantity(string? sku)

Parameters

sku string

Returns

int

RemoveProduct(IProductOrVariant)

public Task RemoveProduct(IProductOrVariant product)

Parameters

product IProductOrVariant

Returns

Task

RemoveProduct(string)

public Task RemoveProduct(string productSku)

Parameters

productSku string

Returns

Task

SetProductQuantity(IProductOrVariant, IStockService?, int, IDictionary<Guid, string>?)

public Task SetProductQuantity(IProductOrVariant product, IStockService? stockService, int quantity, IDictionary<Guid, string>? customisationFields = null)

Parameters

product IProductOrVariant

stockService IStockService

quantity int

customisationFields IDictionary<Guid, string>

Returns

Task