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.

IStoreService

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

IStoreService

Define the Vendr Store service

public interface IStoreService : ICachedEntityService<StoreReadOnly>, IService

Inheritance

Namespace

Methods

DeleteStore (1 of 2)

Deletes an Store

public void DeleteStore(Guid id)

Parameters

Parameter Description
id
The ID of the Store to delete

DeleteStore (2 of 2)

Deletes an Store

public void DeleteStore(Store entity)

Parameters

Parameter Description
entity
The Store to delete

GetStore (1 of 2)

Get an StoreReadOnly entity by ID

public StoreReadOnly GetStore(Guid id)

Parameters

Parameter Description
id
The ID of the StoreReadOnly entity to fetch

Returns

An StoreReadOnly entity


GetStore (2 of 2)

Get an StoreReadOnly entity by Alias

public StoreReadOnly GetStore(string alias)

Parameters

Parameter Description
alias
The Alias of the StoreReadOnly entity to fetch

Returns

An StoreReadOnly entity


GetStores

Get a list of all StoreReadOnly entities

public IEnumerable<StoreReadOnly> GetStores()

Returns

A list of StoreReadOnly entities


SaveStore

Saves an Store

public void SaveStore(Store entity)

Parameters

Parameter Description
entity
The Store to save

SortStores

Sorts a list of Store entities by ID according to the order of those IDs

public void SortStores(Guid[] sortedIds)

Parameters

Parameter Description
sortedIds
The IDs of the Store entities to sort, in the order by which to sort them

StoreExists

Check to see if a StoreReadOnly exists with the given Alias

public bool StoreExists(string alias)

Parameters

Parameter Description
alias
The Alias of the StoreReadOnly entity to check

Returns

Returns true if the StoreReadOnly exists, otherwise returns false.

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.