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 CatalogueItemDto

Name	Type	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:

System.Xml.XmlDocument