Previous Docs Version

The documentation you are viewing is for a previous version of the Vendr product. Click here to jump to the current stable version.

IProductPriceFreezerService

API reference for IProductPriceFreezerService in Vendr, the eCommerce solution for Umbraco v8+

IProductPriceFreezerService

Defines the Vendr Product Price Freezer service

public interface IProductPriceFreezerService

Namespace

Methods

FreezeProductPrice

Freezes a products price

public void FreezeProductPrice(Guid storeId, Guid orderId, string productReference, 
    ProductPrice price)

Parameters

Parameter Description
storeId
The ID of the Store the price is associated with
orderId
The ID of the Order the price is associated with
productReference
The unique reference of the Product the price is associated with
price
The ProductPrice to freeze

GetOrCreateFrozenProductPrice

Get or creates a frozen price for a given product

public ProductPrice GetOrCreateFrozenProductPrice(Guid storeId, Guid orderId, 
    string productReference, Guid currencyId)

Parameters

Parameter Description
storeId
The ID of the Store the price is associated with
orderId
The ID of the Order the price is associated with
productReference
The unique reference of the Product the price is associated with
currencyId
The ID of the Currency of the price

Returns

A frozen ProductPrice


GetProductPrice (1 of 2)

Get the price of a product, either frozen if one exists, otherwise direct from the product source

public ProductPrice GetProductPrice(Guid storeId, Guid orderId, string productReference, 
    Guid currencyId)

Parameters

Parameter Description
storeId
The ID of the Store the price is associated with
orderId
The ID of the Order the price is associated with
productReference
The unique reference of the Product the price is associated with
currencyId
The ID of the Currency of the price to freeze

Returns

A ProductPrice


GetProductPrice (2 of 2)

Get the price of a product, either frozen if one exists, otherwise direct from the product source

public ProductPrice GetProductPrice(Guid storeId, Guid orderId, string productReference, 
    Guid currencyId, out bool isFrozen)

Parameters

Parameter Description
storeId
The ID of the Store the price is associated with
orderId
The ID of the Order the price is associated with
productReference
The unique reference of the Product the price is associated with
currencyId
The ID of the Currency of the price to freeze
isFrozen
Boolean indicating if the price returned is a frozen price or not

Returns

A ProductPrice


HasFrozenProductPrice

Checks to see if there is a frozen product price for the given reference

public bool HasFrozenProductPrice(Guid storeId, Guid orderId, string productReference, 
    Guid currencyId)

Parameters

Parameter Description
storeId
The ID of the Store the price is associated with
orderId
The ID of the Order the price is associated with
productReference
The unique reference of the Product the price is associated with
currencyId
The ID of the Currency of the price to freeze

Returns

True if a frozen price exists, otherwise false


ThawFrozenProductPrice

Thaws a frozen price for a given product

public void ThawFrozenProductPrice(Guid storeId, Guid orderId, string productReference, 
    Guid currencyId)

Parameters

Parameter Description
storeId
The ID of the Store the price is associated with
orderId
The ID of the Order the price is associated with
productReference
The unique reference of the Product the price is associated with
currencyId
The ID of the Currency of the price

Edit this page on GitHub

Site + logo design © 2024 Outfield Digital Ltd. Content contributions licensed under MIT.
Vendr® is a Registered Trademark of Outfield Digital Ltd.