GET Stock/GetInventoryCatalogue/{SiteID}
Returns all products for a site including nutritional information and allergen information
Request Information
URI Parameters
Name | Type | Description | Additional information |
---|---|---|---|
SiteID | integer |
Body Parameters
None.
Response Information
Resource Description
Collection of CatalogueItemDtoName | Type | Description | Additional information |
---|---|---|---|
SiteID | integer |
None. |
|
ProductID | integer |
None. |
|
MeasureID | integer |
None. |
|
ProductGroupID | integer |
None. |
|
Item | string |
None. |
|
Measure | string |
None. |
|
ProductType | string |
None. |
|
ProductGroup | string |
None. |
|
StocktakeCategory | string |
None. |
|
BaseUnit | string |
None. |
|
StocktakeUnit | string |
None. |
|
StocktakeUnitQty | decimal number |
None. |
|
InventoryItemType | string |
None. |
|
Barcode | string |
None. |
|
Stocktakable | boolean |
None. |
|
StockOnly | boolean |
None. |
|
Active | boolean |
None. |
|
NetUnitCost | decimal number |
None. |
|
GrossUnitCost | decimal number |
None. |
|
BaseUnitNetCost | decimal number |
None. |
|
BaseUnitGrossCost | decimal number |
None. |
|
QuickBooksSalesAccountCode | string |
None. |
|
PreparationMethod | string |
None. |
|
MinutesOfPreparation | decimal number |
None. |
|
MinutesOfCooking | decimal number |
None. |
|
Equipment | string |
None. |
|
HealthAndSafety | string |
None. |
|
DaysOfShelfLife | decimal number |
None. |
|
Allergens | AllergenProfile |
None. |
|
Nutrition | NutritionFacts |
None. |
|
Ingredients | Collection of CatalogueIngredientModel |
None. |
|
Advisories | Collection of string |
None. |
|
ExcludedStockLocations | Collection of integer |
None. |
|
PurchaseUnits | Collection of CataloguePurchaseUnitDto |
None. |
Response Formats
application/json, text/json
Sample:
[ { "SiteID": 1, "ProductID": 2, "MeasureID": 1, "ProductGroupID": 3, "Item": "sample string 4", "Measure": "sample string 5", "ProductType": "sample string 6", "ProductGroup": "sample string 7", "StocktakeCategory": "sample string 8", "BaseUnit": "sample string 9", "StocktakeUnit": "sample string 10", "StocktakeUnitQty": 11.0, "InventoryItemType": "sample string 12", "Barcode": "sample string 13", "Stocktakable": true, "StockOnly": true, "Active": true, "NetUnitCost": 17.0, "GrossUnitCost": 18.0, "BaseUnitNetCost": 19.0, "BaseUnitGrossCost": 20.0, "QuickBooksSalesAccountCode": "sample string 21", "PreparationMethod": "sample string 22", "MinutesOfPreparation": 23.0, "MinutesOfCooking": 24.0, "Equipment": "sample string 25", "HealthAndSafety": "sample string 26", "DaysOfShelfLife": 27.0, "Allergens": { "ContainsCelery": true, "ContainsGluten": true, "ContainsCrustaceans": true, "ContainsEgg": true, "ContainsFish": true, "ContainsLupin": true, "ContainsMilk": true, "ContainsMolluscs": true, "ContainsMustard": true, "ContainsNuts": true, "ContainsPeanuts": true, "ContainsSesame": true, "ContainsSoya": true, "ContainsSulphurDioxide": true }, "Nutrition": { "ServingUnit": "sample string 1", "ServingQty": 2.0, "CaloriesKCal": 1.0, "TotalFat": 1.0, "SaturatedFat": 1.0, "PolyunsaturatedFat": 1.0, "MonounsaturatedFat": 1.0, "TransFat": 1.0, "Cholesterol": 1.0, "Salt": 1.0, "Potassium": 1.0, "TotalCarbohydrate": 1.0, "DietaryFibre": 1.0, "Sugars": 1.0, "Protein": 1.0, "Halal": true, "Kosher": true, "Vegetarian": true, "Vegan": true, "GlutenFree": true, "Spicy": true }, "Ingredients": [ { "RecipeItemID": 1, "ProductID": 2, "MeasureID": 3, "SubRecipeID": 1, "Name": "sample string 4", "ProductType": "sample string 5", "ProductGroup": "sample string 6", "Measure": "sample string 7", "BaseUnit": "sample string 8", "BaseUnitAmountUsed": 9.0, "BaseYield": 10.0, "OverrideYield": 1.0 }, { "RecipeItemID": 1, "ProductID": 2, "MeasureID": 3, "SubRecipeID": 1, "Name": "sample string 4", "ProductType": "sample string 5", "ProductGroup": "sample string 6", "Measure": "sample string 7", "BaseUnit": "sample string 8", "BaseUnitAmountUsed": 9.0, "BaseYield": 10.0, "OverrideYield": 1.0 } ], "Advisories": [ "sample string 1", "sample string 2" ], "ExcludedStockLocations": [ 1, 2 ], "PurchaseUnits": [ { "PurchaseUnitID": 1, "SiteID": 2, "ProductID": 3, "SupplierID": 4, "Supplier": "sample string 5", "Unit": "sample string 6", "UnitQty": 7.0, "UnitNetCostPrice": 8.0, "StocktakeUnitQtyPurchased": 9.0, "ProductCode": "sample string 10", "Barcode": "sample string 11", "PurchaseUnitUniqueID": 12 }, { "PurchaseUnitID": 1, "SiteID": 2, "ProductID": 3, "SupplierID": 4, "Supplier": "sample string 5", "Unit": "sample string 6", "UnitQty": 7.0, "UnitNetCostPrice": 8.0, "StocktakeUnitQtyPurchased": 9.0, "ProductCode": "sample string 10", "Barcode": "sample string 11", "PurchaseUnitUniqueID": 12 } ] }, { "SiteID": 1, "ProductID": 2, "MeasureID": 1, "ProductGroupID": 3, "Item": "sample string 4", "Measure": "sample string 5", "ProductType": "sample string 6", "ProductGroup": "sample string 7", "StocktakeCategory": "sample string 8", "BaseUnit": "sample string 9", "StocktakeUnit": "sample string 10", "StocktakeUnitQty": 11.0, "InventoryItemType": "sample string 12", "Barcode": "sample string 13", "Stocktakable": true, "StockOnly": true, "Active": true, "NetUnitCost": 17.0, "GrossUnitCost": 18.0, "BaseUnitNetCost": 19.0, "BaseUnitGrossCost": 20.0, "QuickBooksSalesAccountCode": "sample string 21", "PreparationMethod": "sample string 22", "MinutesOfPreparation": 23.0, "MinutesOfCooking": 24.0, "Equipment": "sample string 25", "HealthAndSafety": "sample string 26", "DaysOfShelfLife": 27.0, "Allergens": { "ContainsCelery": true, "ContainsGluten": true, "ContainsCrustaceans": true, "ContainsEgg": true, "ContainsFish": true, "ContainsLupin": true, "ContainsMilk": true, "ContainsMolluscs": true, "ContainsMustard": true, "ContainsNuts": true, "ContainsPeanuts": true, "ContainsSesame": true, "ContainsSoya": true, "ContainsSulphurDioxide": true }, "Nutrition": { "ServingUnit": "sample string 1", "ServingQty": 2.0, "CaloriesKCal": 1.0, "TotalFat": 1.0, "SaturatedFat": 1.0, "PolyunsaturatedFat": 1.0, "MonounsaturatedFat": 1.0, "TransFat": 1.0, "Cholesterol": 1.0, "Salt": 1.0, "Potassium": 1.0, "TotalCarbohydrate": 1.0, "DietaryFibre": 1.0, "Sugars": 1.0, "Protein": 1.0, "Halal": true, "Kosher": true, "Vegetarian": true, "Vegan": true, "GlutenFree": true, "Spicy": true }, "Ingredients": [ { "RecipeItemID": 1, "ProductID": 2, "MeasureID": 3, "SubRecipeID": 1, "Name": "sample string 4", "ProductType": "sample string 5", "ProductGroup": "sample string 6", "Measure": "sample string 7", "BaseUnit": "sample string 8", "BaseUnitAmountUsed": 9.0, "BaseYield": 10.0, "OverrideYield": 1.0 }, { "RecipeItemID": 1, "ProductID": 2, "MeasureID": 3, "SubRecipeID": 1, "Name": "sample string 4", "ProductType": "sample string 5", "ProductGroup": "sample string 6", "Measure": "sample string 7", "BaseUnit": "sample string 8", "BaseUnitAmountUsed": 9.0, "BaseYield": 10.0, "OverrideYield": 1.0 } ], "Advisories": [ "sample string 1", "sample string 2" ], "ExcludedStockLocations": [ 1, 2 ], "PurchaseUnits": [ { "PurchaseUnitID": 1, "SiteID": 2, "ProductID": 3, "SupplierID": 4, "Supplier": "sample string 5", "Unit": "sample string 6", "UnitQty": 7.0, "UnitNetCostPrice": 8.0, "StocktakeUnitQtyPurchased": 9.0, "ProductCode": "sample string 10", "Barcode": "sample string 11", "PurchaseUnitUniqueID": 12 }, { "PurchaseUnitID": 1, "SiteID": 2, "ProductID": 3, "SupplierID": 4, "Supplier": "sample string 5", "Unit": "sample string 6", "UnitQty": 7.0, "UnitNetCostPrice": 8.0, "StocktakeUnitQtyPurchased": 9.0, "ProductCode": "sample string 10", "Barcode": "sample string 11", "PurchaseUnitUniqueID": 12 } ] } ]
application/xml, text/xml
Sample:
<ArrayOfCatalogueItemDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Tevalis.StockMid.Core.Models.Inventory.Dto"> <CatalogueItemDto> <Active>true</Active> <Advisories xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </Advisories> <Allergens xmlns:d3p1="http://schemas.datacontract.org/2004/07/Tevalis.StockMid.Core.Models.Nutrition"> <d3p1:ContainsCelery>true</d3p1:ContainsCelery> <d3p1:ContainsCrustaceans>true</d3p1:ContainsCrustaceans> <d3p1:ContainsEgg>true</d3p1:ContainsEgg> <d3p1:ContainsFish>true</d3p1:ContainsFish> <d3p1:ContainsGluten>true</d3p1:ContainsGluten> <d3p1:ContainsLupin>true</d3p1:ContainsLupin> <d3p1:ContainsMilk>true</d3p1:ContainsMilk> <d3p1:ContainsMolluscs>true</d3p1:ContainsMolluscs> <d3p1:ContainsMustard>true</d3p1:ContainsMustard> <d3p1:ContainsNuts>true</d3p1:ContainsNuts> <d3p1:ContainsPeanuts>true</d3p1:ContainsPeanuts> <d3p1:ContainsSesame>true</d3p1:ContainsSesame> <d3p1:ContainsSoya>true</d3p1:ContainsSoya> <d3p1:ContainsSulphurDioxide>true</d3p1:ContainsSulphurDioxide> </Allergens> <Barcode>sample string 13</Barcode> <BaseUnit>sample string 9</BaseUnit> <BaseUnitGrossCost>20</BaseUnitGrossCost> <BaseUnitNetCost>19</BaseUnitNetCost> <DaysOfShelfLife>27</DaysOfShelfLife> <Equipment>sample string 25</Equipment> <ExcludedStockLocations xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:int>1</d3p1:int> <d3p1:int>2</d3p1:int> </ExcludedStockLocations> <GrossUnitCost>18</GrossUnitCost> <HealthAndSafety>sample string 26</HealthAndSafety> <Ingredients> <CatalogueIngredientModel> <BaseUnit>sample string 8</BaseUnit> <BaseUnitAmountUsed>9</BaseUnitAmountUsed> <BaseYield>10</BaseYield> <Measure>sample string 7</Measure> <MeasureID>3</MeasureID> <Name>sample string 4</Name> <OverrideYield>1</OverrideYield> <ProductGroup>sample string 6</ProductGroup> <ProductID>2</ProductID> <ProductType>sample string 5</ProductType> <RecipeItemID>1</RecipeItemID> <SubRecipeID>1</SubRecipeID> </CatalogueIngredientModel> <CatalogueIngredientModel> <BaseUnit>sample string 8</BaseUnit> <BaseUnitAmountUsed>9</BaseUnitAmountUsed> <BaseYield>10</BaseYield> <Measure>sample string 7</Measure> <MeasureID>3</MeasureID> <Name>sample string 4</Name> <OverrideYield>1</OverrideYield> <ProductGroup>sample string 6</ProductGroup> <ProductID>2</ProductID> <ProductType>sample string 5</ProductType> <RecipeItemID>1</RecipeItemID> <SubRecipeID>1</SubRecipeID> </CatalogueIngredientModel> </Ingredients> <InventoryItemType>sample string 12</InventoryItemType> <Item>sample string 4</Item> <Measure>sample string 5</Measure> <MeasureID>1</MeasureID> <MinutesOfCooking>24</MinutesOfCooking> <MinutesOfPreparation>23</MinutesOfPreparation> <NetUnitCost>17</NetUnitCost> <Nutrition xmlns:d3p1="http://schemas.datacontract.org/2004/07/Tevalis.StockMid.Core.Models.Nutrition"> <d3p1:CaloriesKCal>1</d3p1:CaloriesKCal> <d3p1:Cholesterol>1</d3p1:Cholesterol> <d3p1:DietaryFibre>1</d3p1:DietaryFibre> <d3p1:GlutenFree>true</d3p1:GlutenFree> <d3p1:Halal>true</d3p1:Halal> <d3p1:Kosher>true</d3p1:Kosher> <d3p1:MonounsaturatedFat>1</d3p1:MonounsaturatedFat> <d3p1:PolyunsaturatedFat>1</d3p1:PolyunsaturatedFat> <d3p1:Potassium>1</d3p1:Potassium> <d3p1:Protein>1</d3p1:Protein> <d3p1:Salt>1</d3p1:Salt> <d3p1:SaturatedFat>1</d3p1:SaturatedFat> <d3p1:ServingQty>2</d3p1:ServingQty> <d3p1:ServingUnit>sample string 1</d3p1:ServingUnit> <d3p1:Spicy>true</d3p1:Spicy> <d3p1:Sugars>1</d3p1:Sugars> <d3p1:TotalCarbohydrate>1</d3p1:TotalCarbohydrate> <d3p1:TotalFat>1</d3p1:TotalFat> <d3p1:TransFat>1</d3p1:TransFat> <d3p1:Vegan>true</d3p1:Vegan> <d3p1:Vegetarian>true</d3p1:Vegetarian> </Nutrition> <PreparationMethod>sample string 22</PreparationMethod> <ProductGroup>sample string 7</ProductGroup> <ProductGroupID>3</ProductGroupID> <ProductID>2</ProductID> <ProductType>sample string 6</ProductType> <PurchaseUnits> <CataloguePurchaseUnitDto> <Barcode>sample string 11</Barcode> <ProductCode>sample string 10</ProductCode> <ProductID>3</ProductID> <PurchaseUnitID>1</PurchaseUnitID> <PurchaseUnitUniqueID>12</PurchaseUnitUniqueID> <SiteID>2</SiteID> <StocktakeUnitQtyPurchased>9</StocktakeUnitQtyPurchased> <Supplier>sample string 5</Supplier> <SupplierID>4</SupplierID> <Unit>sample string 6</Unit> <UnitNetCostPrice>8</UnitNetCostPrice> <UnitQty>7</UnitQty> </CataloguePurchaseUnitDto> <CataloguePurchaseUnitDto> <Barcode>sample string 11</Barcode> <ProductCode>sample string 10</ProductCode> <ProductID>3</ProductID> <PurchaseUnitID>1</PurchaseUnitID> <PurchaseUnitUniqueID>12</PurchaseUnitUniqueID> <SiteID>2</SiteID> <StocktakeUnitQtyPurchased>9</StocktakeUnitQtyPurchased> <Supplier>sample string 5</Supplier> <SupplierID>4</SupplierID> <Unit>sample string 6</Unit> <UnitNetCostPrice>8</UnitNetCostPrice> <UnitQty>7</UnitQty> </CataloguePurchaseUnitDto> </PurchaseUnits> <QuickBooksSalesAccountCode>sample string 21</QuickBooksSalesAccountCode> <SiteID>1</SiteID> <StockOnly>true</StockOnly> <Stocktakable>true</Stocktakable> <StocktakeCategory>sample string 8</StocktakeCategory> <StocktakeUnit>sample string 10</StocktakeUnit> <StocktakeUnitQty>11</StocktakeUnitQty> </CatalogueItemDto> <CatalogueItemDto> <Active>true</Active> <Advisories xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:string>sample string 1</d3p1:string> <d3p1:string>sample string 2</d3p1:string> </Advisories> <Allergens xmlns:d3p1="http://schemas.datacontract.org/2004/07/Tevalis.StockMid.Core.Models.Nutrition"> <d3p1:ContainsCelery>true</d3p1:ContainsCelery> <d3p1:ContainsCrustaceans>true</d3p1:ContainsCrustaceans> <d3p1:ContainsEgg>true</d3p1:ContainsEgg> <d3p1:ContainsFish>true</d3p1:ContainsFish> <d3p1:ContainsGluten>true</d3p1:ContainsGluten> <d3p1:ContainsLupin>true</d3p1:ContainsLupin> <d3p1:ContainsMilk>true</d3p1:ContainsMilk> <d3p1:ContainsMolluscs>true</d3p1:ContainsMolluscs> <d3p1:ContainsMustard>true</d3p1:ContainsMustard> <d3p1:ContainsNuts>true</d3p1:ContainsNuts> <d3p1:ContainsPeanuts>true</d3p1:ContainsPeanuts> <d3p1:ContainsSesame>true</d3p1:ContainsSesame> <d3p1:ContainsSoya>true</d3p1:ContainsSoya> <d3p1:ContainsSulphurDioxide>true</d3p1:ContainsSulphurDioxide> </Allergens> <Barcode>sample string 13</Barcode> <BaseUnit>sample string 9</BaseUnit> <BaseUnitGrossCost>20</BaseUnitGrossCost> <BaseUnitNetCost>19</BaseUnitNetCost> <DaysOfShelfLife>27</DaysOfShelfLife> <Equipment>sample string 25</Equipment> <ExcludedStockLocations xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d3p1:int>1</d3p1:int> <d3p1:int>2</d3p1:int> </ExcludedStockLocations> <GrossUnitCost>18</GrossUnitCost> <HealthAndSafety>sample string 26</HealthAndSafety> <Ingredients> <CatalogueIngredientModel> <BaseUnit>sample string 8</BaseUnit> <BaseUnitAmountUsed>9</BaseUnitAmountUsed> <BaseYield>10</BaseYield> <Measure>sample string 7</Measure> <MeasureID>3</MeasureID> <Name>sample string 4</Name> <OverrideYield>1</OverrideYield> <ProductGroup>sample string 6</ProductGroup> <ProductID>2</ProductID> <ProductType>sample string 5</ProductType> <RecipeItemID>1</RecipeItemID> <SubRecipeID>1</SubRecipeID> </CatalogueIngredientModel> <CatalogueIngredientModel> <BaseUnit>sample string 8</BaseUnit> <BaseUnitAmountUsed>9</BaseUnitAmountUsed> <BaseYield>10</BaseYield> <Measure>sample string 7</Measure> <MeasureID>3</MeasureID> <Name>sample string 4</Name> <OverrideYield>1</OverrideYield> <ProductGroup>sample string 6</ProductGroup> <ProductID>2</ProductID> <ProductType>sample string 5</ProductType> <RecipeItemID>1</RecipeItemID> <SubRecipeID>1</SubRecipeID> </CatalogueIngredientModel> </Ingredients> <InventoryItemType>sample string 12</InventoryItemType> <Item>sample string 4</Item> <Measure>sample string 5</Measure> <MeasureID>1</MeasureID> <MinutesOfCooking>24</MinutesOfCooking> <MinutesOfPreparation>23</MinutesOfPreparation> <NetUnitCost>17</NetUnitCost> <Nutrition xmlns:d3p1="http://schemas.datacontract.org/2004/07/Tevalis.StockMid.Core.Models.Nutrition"> <d3p1:CaloriesKCal>1</d3p1:CaloriesKCal> <d3p1:Cholesterol>1</d3p1:Cholesterol> <d3p1:DietaryFibre>1</d3p1:DietaryFibre> <d3p1:GlutenFree>true</d3p1:GlutenFree> <d3p1:Halal>true</d3p1:Halal> <d3p1:Kosher>true</d3p1:Kosher> <d3p1:MonounsaturatedFat>1</d3p1:MonounsaturatedFat> <d3p1:PolyunsaturatedFat>1</d3p1:PolyunsaturatedFat> <d3p1:Potassium>1</d3p1:Potassium> <d3p1:Protein>1</d3p1:Protein> <d3p1:Salt>1</d3p1:Salt> <d3p1:SaturatedFat>1</d3p1:SaturatedFat> <d3p1:ServingQty>2</d3p1:ServingQty> <d3p1:ServingUnit>sample string 1</d3p1:ServingUnit> <d3p1:Spicy>true</d3p1:Spicy> <d3p1:Sugars>1</d3p1:Sugars> <d3p1:TotalCarbohydrate>1</d3p1:TotalCarbohydrate> <d3p1:TotalFat>1</d3p1:TotalFat> <d3p1:TransFat>1</d3p1:TransFat> <d3p1:Vegan>true</d3p1:Vegan> <d3p1:Vegetarian>true</d3p1:Vegetarian> </Nutrition> <PreparationMethod>sample string 22</PreparationMethod> <ProductGroup>sample string 7</ProductGroup> <ProductGroupID>3</ProductGroupID> <ProductID>2</ProductID> <ProductType>sample string 6</ProductType> <PurchaseUnits> <CataloguePurchaseUnitDto> <Barcode>sample string 11</Barcode> <ProductCode>sample string 10</ProductCode> <ProductID>3</ProductID> <PurchaseUnitID>1</PurchaseUnitID> <PurchaseUnitUniqueID>12</PurchaseUnitUniqueID> <SiteID>2</SiteID> <StocktakeUnitQtyPurchased>9</StocktakeUnitQtyPurchased> <Supplier>sample string 5</Supplier> <SupplierID>4</SupplierID> <Unit>sample string 6</Unit> <UnitNetCostPrice>8</UnitNetCostPrice> <UnitQty>7</UnitQty> </CataloguePurchaseUnitDto> <CataloguePurchaseUnitDto> <Barcode>sample string 11</Barcode> <ProductCode>sample string 10</ProductCode> <ProductID>3</ProductID> <PurchaseUnitID>1</PurchaseUnitID> <PurchaseUnitUniqueID>12</PurchaseUnitUniqueID> <SiteID>2</SiteID> <StocktakeUnitQtyPurchased>9</StocktakeUnitQtyPurchased> <Supplier>sample string 5</Supplier> <SupplierID>4</SupplierID> <Unit>sample string 6</Unit> <UnitNetCostPrice>8</UnitNetCostPrice> <UnitQty>7</UnitQty> </CataloguePurchaseUnitDto> </PurchaseUnits> <QuickBooksSalesAccountCode>sample string 21</QuickBooksSalesAccountCode> <SiteID>1</SiteID> <StockOnly>true</StockOnly> <Stocktakable>true</Stocktakable> <StocktakeCategory>sample string 8</StocktakeCategory> <StocktakeUnit>sample string 10</StocktakeUnit> <StocktakeUnitQty>11</StocktakeUnitQty> </CatalogueItemDto> </ArrayOfCatalogueItemDto>