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.

IOrderStatusService

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

IOrderStatusService

Defines the Vendr Order Status service

public interface IOrderStatusService : ICachedEntityService<OrderStatusReadOnly>, IService

Inheritance

Namespace

Methods

DeleteOrderStatus (1 of 2)

Deletes a OrderStatus

public void DeleteOrderStatus(Guid id)

Parameters

Parameter Description
id
The ID of the OrderStatus to delete

DeleteOrderStatus (2 of 2)

Deletes a OrderStatus

public void DeleteOrderStatus(OrderStatus entity)

Parameters

Parameter Description
entity
The OrderStatus to delete

GetOrderStatus (1 of 2)

Get a OrderStatusReadOnly entity by ID

public OrderStatusReadOnly GetOrderStatus(Guid id)

Parameters

Parameter Description
id
The ID of the OrderStatusReadOnly entity to fetch

Returns

A OrderStatusReadOnly entity


GetOrderStatus (2 of 2)

Get a OrderStatusReadOnly entity by Store and Alias

public OrderStatusReadOnly GetOrderStatus(Guid storeId, string alias)

Parameters

Parameter Description
storeId
The ID of the Store the OrderStatusReadOnly entity belongs to
alias
The Alias of the OrderStatusReadOnly entity to fetch

Returns

A OrderStatusReadOnly entity


GetOrderStatuses

Get a list of all OrderStatusReadOnly entities from the given Store

public IEnumerable<OrderStatusReadOnly> GetOrderStatuses(Guid storeId)

Parameters

Parameter Description
storeId
The ID of the Store the OrderStatusReadOnly entities belong to

Returns

A list of OrderStatusReadOnly entities


OrderStatusExists

Check to see if a OrderStatusReadOnly exists in the given Store with the given Alias

public bool OrderStatusExists(Guid storeId, string alias)

Parameters

Parameter Description
storeId
The ID of the Store the OrderStatusReadOnly entity belongs to
alias
The Alias of the OrderStatusReadOnly entity to check

Returns

Returns true if the OrderStatusReadOnly exists, otherwise returns false.


SaveOrderStatus

Saves a OrderStatus

public void SaveOrderStatus(OrderStatus entity)

Parameters

Parameter Description
entity
The OrderStatus to save

SortOrderStatuses

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

public void SortOrderStatuses(Guid[] sortedIds)

Parameters

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

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.