Interface IWarehouseInventoryService

Accessors for inventory data overall and by catalog entry or warehouse

Namespace: Mediachase.Commerce.Inventory

Assembly: Mediachase.Commerce.dll

Version: 12.17.2

Syntax

[Obsolete("Use Mediachase.Commerce.InventoryService.IInventoryService instead. Will remain until at least October 2017.")]
public interface IWarehouseInventoryService

Methods

Delete(CatalogKey)

Deletes all inventory records for a specific catalog entry.

Declaration

void Delete(CatalogKey catalogKey)

Parameters

Type	Name	Description
CatalogKey	catalogKey	The catalog entry to delete inventory for.

Delete(CatalogKey, IWarehouse)

Deletes the single inventory record for a specific catalog entry and warehouse combination.

Declaration

void Delete(CatalogKey catalogKey, IWarehouse warehouse)

Parameters

Type	Name	Description
CatalogKey	catalogKey	The catalog entry to delete inventory for.
IWarehouse	warehouse	The warehouse to delete inventory for.

Delete(CatalogKey, IEnumerable<IWarehouse>)

Deletes all inventory records for a specific catalog entry as one or more warehouses.

Declaration

void Delete(CatalogKey catalogKey, IEnumerable<IWarehouse> warehouses)

Parameters

Type	Name	Description
CatalogKey	catalogKey	The catalog entry to delete inventory for.
System.Collections.Generic.IEnumerable<IWarehouse>	warehouses	The warehouses to delete inventory for.

Delete(IWarehouse)

Deletes all inventory records for a specific warehouse.

Declaration

void Delete(IWarehouse warehouse)

Parameters

Type	Name	Description
IWarehouse	warehouse	The warehouse to delete inventory for.

Delete(IEnumerable<CatalogKey>)

Deletes all inventory records for one or more catalog entries.

Declaration

void Delete(IEnumerable<CatalogKey> catalogKeys)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<CatalogKey>	catalogKeys	The catalog entries to delete inventory for.

Delete(IEnumerable<CatalogKey>, IWarehouse)

Deletes all inventory records for one or more catalog entries at a specific warehouse.

Declaration

void Delete(IEnumerable<CatalogKey> catalogKeys, IWarehouse warehouse)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<CatalogKey>	catalogKeys	The catalog entries to delete inventory for.
IWarehouse	warehouse	The warehouse to delete inventory for.

Delete(IEnumerable<CatalogKey>, IEnumerable<IWarehouse>)

Deletes all inventory records for one or more catalog entries at one or more warehouses.

Declaration

void Delete(IEnumerable<CatalogKey> catalogKeys, IEnumerable<IWarehouse> warehouses)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<CatalogKey>	catalogKeys	The catalog entries to delete inventory for.
System.Collections.Generic.IEnumerable<IWarehouse>	warehouses	The warehouses to delete inventory for.

Delete(IEnumerable<IWarehouse>)

Deletes all inventory records for one or more warehouses.

Declaration

void Delete(IEnumerable<IWarehouse> warehouses)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<IWarehouse>	warehouses	The warehouses to delete inventory for.

Get(CatalogKey, IWarehouse)

Gets a single inventory record for a specific catalog entry at a specific warehouse.

Declaration

IWarehouseInventory Get(CatalogKey catalogKey, IWarehouse warehouse)

Parameters

Type	Name	Description
CatalogKey	catalogKey	The catalog entry to get inventory for.
IWarehouse	warehouse	The warehouse to get inventory for.

Returns

Type	Description
IWarehouseInventory	All warehouse inventory records for the combination of catalog entry and warehouse.

GetTotal(CatalogKey)

Gets a single inventory record for a specific catalog entry that rolls up all relevant warehouse records.

Declaration

IWarehouseInventory GetTotal(CatalogKey catalogKey)

Parameters

Type	Name	Description
CatalogKey	catalogKey	The catalog entry to get inventory totals for.

Returns

Type	Description
IWarehouseInventory	A single inventory record that contains the overall inventory for the catalog entry.

GetTotal(CatalogKey, IEnumerable<IWarehouse>)

Gets a single inventory record for a catalog entry that rolls up its inventories across all of the specified warehouse records.

Declaration

IWarehouseInventory GetTotal(CatalogKey catalogKey, IEnumerable<IWarehouse> warehouses)

Parameters

Type	Name	Description
CatalogKey	catalogKey	The catalog entry to get inventory totals for.
System.Collections.Generic.IEnumerable<IWarehouse>	warehouses	The warehouses to get inventory for.

Returns

Type	Description
IWarehouseInventory	A single inventory record that contains the overall inventory for the catalog entry at one or more warehouses.

List()

Gets all inventories belong to current eCF application.

Declaration

IEnumerable<IWarehouseInventory> List()

Returns

Type	Description
System.Collections.Generic.IEnumerable<IWarehouseInventory>	All inventory records belong to current eCF application.

List(CatalogKey)

Gets all inventories for a specific catalog entry, separated by warehouse.

Declaration

IEnumerable<IWarehouseInventory> List(CatalogKey catalogKey)

Parameters

Type	Name	Description
CatalogKey	catalogKey	The catalog entry to get inventory for.

Returns

Type	Description
System.Collections.Generic.IEnumerable<IWarehouseInventory>	All warehouse inventory records for the catalog entry.

List(CatalogKey, IEnumerable<IWarehouse>)

Gets the inventory records for a specific catalog entries at one or more warehouses.

Declaration

IEnumerable<IWarehouseInventory> List(CatalogKey catalogKey, IEnumerable<IWarehouse> warehouses)

Parameters

Type	Name	Description
CatalogKey	catalogKey	The catalog entry to get inventory for.
System.Collections.Generic.IEnumerable<IWarehouse>	warehouses	The warehouses to get inventory for.

Returns

Type	Description
System.Collections.Generic.IEnumerable<IWarehouseInventory>	All inventory records for the provided catalog entry at any of the provided warehouses.

List(IWarehouse)

Gets all inventories for a specific warehouse, separated by catalog entry.

Declaration

IEnumerable<IWarehouseInventory> List(IWarehouse warehouse)

Parameters

Type	Name	Description
IWarehouse	warehouse	The warehouse to get inventory for.

Returns

Type	Description
System.Collections.Generic.IEnumerable<IWarehouseInventory>	All inventory records for the warehouse.

List(IEnumerable<CatalogKey>)

Gets all inventories for one or more catalog entries, separated by warehouse.

Declaration

IEnumerable<IWarehouseInventory> List(IEnumerable<CatalogKey> catalogKeys)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<CatalogKey>	catalogKeys	The catalog entries to get inventory for.

Returns

Type	Description
System.Collections.Generic.IEnumerable<IWarehouseInventory>	All warehouse inventory records for the provided catalog entries.

List(IEnumerable<CatalogKey>, IWarehouse)

Gets the inventory records for one or more catalog entries at a specific warehouse.

Declaration

IEnumerable<IWarehouseInventory> List(IEnumerable<CatalogKey> catalogKey, IWarehouse warehouse)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<CatalogKey>	catalogKey	The catalog entries to get inventory for.
IWarehouse	warehouse	The warehouse to get inventory for.

Returns

Type	Description
System.Collections.Generic.IEnumerable<IWarehouseInventory>	All inventory records for the provided catalog entries at the provided warehouse.

List(IEnumerable<CatalogKey>, IEnumerable<IWarehouse>)

Gets the inventory records for one or more catalog entries at one or more warehouses.

Declaration

IEnumerable<IWarehouseInventory> List(IEnumerable<CatalogKey> catalogKey, IEnumerable<IWarehouse> warehouses)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<CatalogKey>	catalogKey	The catalog entries to get inventory for.
System.Collections.Generic.IEnumerable<IWarehouse>	warehouses	The warehouses to get inventory for.

Returns

Type	Description
System.Collections.Generic.IEnumerable<IWarehouseInventory>	All inventory records for one of the provided catalog entries at any of the provided warehouses.

List(IEnumerable<IWarehouse>)

Gets all inventories for one or more warehouses, separated by catalog entry.

Declaration

IEnumerable<IWarehouseInventory> List(IEnumerable<IWarehouse> warehouses)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<IWarehouse>	warehouses	The warehouses to get inventory for.

Returns

Type	Description
System.Collections.Generic.IEnumerable<IWarehouseInventory>	All catalog entry inventory records for the provided warehouses.

ListAll()

Gets all inventories, separated by catalog entry and warehouse.

Declaration

IEnumerable<IWarehouseInventory> ListAll()

Returns

Type	Description
System.Collections.Generic.IEnumerable<IWarehouseInventory>	All inventory records.

Remarks

This is intended to be used for internal infrastructure, and should not be used in custom code

ListTotals(IEnumerable<CatalogKey>)

Gets a single inventory record for each provided catalog entry that rolls up all relevant warehouse records for that catalog entry.

Declaration

IEnumerable<IWarehouseInventory> ListTotals(IEnumerable<CatalogKey> catalogKeys)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<CatalogKey>	catalogKeys	The catalog entries to get inventory totals for.

Returns

Type	Description
System.Collections.Generic.IEnumerable<IWarehouseInventory>	An enumeration of a single inventory record for each provided catalog entry that contains the overall inventory for the catalog entry.

ListTotals(IEnumerable<CatalogKey>, IEnumerable<IWarehouse>)

Gets a single inventory record for each provided catalog entry that rolls up its inventories across all of the specified warehouse records.

Declaration

IEnumerable<IWarehouseInventory> ListTotals(IEnumerable<CatalogKey> catalogKeys, IEnumerable<IWarehouse> warehouses)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<CatalogKey>	catalogKeys	The catalog entries to get inventory totals for.
System.Collections.Generic.IEnumerable<IWarehouse>	warehouses	The warehouses to get inventory for.

Returns

Type	Description
System.Collections.Generic.IEnumerable<IWarehouseInventory>	An enumeration of a single inventory record for each provided catalog entry that contains the overall inventory for the catalog entry.

Save(IWarehouseInventory)

Sets the inventory for a single CatalogEntry at a specific warehouse.

Declaration

void Save(IWarehouseInventory inventory)

Parameters

Type	Name	Description
IWarehouseInventory	inventory	The inventory to be set.

Save(IEnumerable<IWarehouseInventory>)

Sets the inventories for all passed rows.

Declaration

void Save(IEnumerable<IWarehouseInventory> inventories)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<IWarehouseInventory>	inventories	The inventories to be set.

Remarks

It is expected that inventory records that do not match the key combination (i.e. CatalogEntry and warehouse) of any provided record are not changed by this method.

Inventory for a CatalogEntry or a warehouse can be set by passing all relevant inventories for that CatalogEntry or warehouse. Separate methods are not provided for those cases.