Source: https://restauranttechnologynetwork.com/technical-documents

IngredientSummary

Properties

Name Description Type Required Generic Enum Ignore
@type string false ${prop.ignore}
iD Assigned Type: ms-0100:GUID string false ${prop.ignore}
NutritionResource URL to master nutrition guide for specific information about a menu item. string false ${prop.ignore}
BaselineNutrition array false BaselineNutrition --- ${prop.ignore}
DietaryRestrictions Assigned Type: ms-0100:DietaryRestrictions DietaryRestrictions false ${prop.ignore}
RegulatoryRequirementsDescription Provides regulatory notification requirements (e.g. Sodium warning, calorie warning). string false ${prop.ignore}
Availability Assigned Type: ms-0100:Availability Availability false ${prop.ignore}
ChannelAvailability Specifies the channels for which this menu item is available. If there are no channels specified at the menu item level, then the channels specified at the menu will apply. string false ${prop.ignore}
LocationAvailability A location or arbitrary set of locations where the menu item may be available. This is a location in the restaurants direct control, i.e. restaurant x at this address, NOT a third party service. string false ${prop.ignore}
Destination array false string ${prop.ignore}
Description A textual description of the menu item. string false ${prop.ignore}
Preparation Describes how the menu item is prepared. string false ${prop.ignore}
MasterDescription The main description for the menu item. string false ${prop.ignore}
Channel Assigned Type: ms-0100:Channel Channel false ${prop.ignore}
PackingList array false PackingList --- ${prop.ignore}
OrderingNotes Textual information regarding any specific ordering information for this menu item. string false ${prop.ignore}
Ingredient array false IngredientID --- ${prop.ignore}
ServingSize Assigned Type: ms-0100:ServingSize ServingSize false ${prop.ignore}
Promotion Assigned Type: ms-0100:Promotion Promotion false ${prop.ignore}
MediaCategory array false MediaCategory --- ${prop.ignore}
Source Where the item came from. string false ${prop.ignore}
Pricing array false Pricing --- ${prop.ignore}
SKU Assigned Type: ms-0100:SKU SKU false ${prop.ignore}
Default array false Default --- ${prop.ignore}
Modifier Assigned Type: ms-0100:Modifier ModifierID false ${prop.ignore}
modifierEligibleInd When true, this menu item may be modified. boolean false ${prop.ignore}
ExtensionPoint ExtensionPoint false ${prop.ignore}
{
  "@type" : "string",
  "id" : "string",
  "nutritionResource" : "string",
  "baselineNutrition" : [ {
    "@type" : "string",
    "count" : "integer",
    "nutritionInformationType" : { },
    "unitOfMeasure" : { },
    "extensionPoint" : { }
  } ],
  "dietaryRestrictions" : {
    "@type" : "string",
    "allergenDetails" : [ { } ],
    "lifestyleChoicesEnum" : [ { } ],
    "extensionPoint" : { }
  },
  "regulatoryRequirementsDescription" : "string",
  "availability" : {
    "@type" : "string",
    "extensionPoint" : { }
  },
  "channelAvailability" : "string",
  "locationAvailability" : "string",
  "destination" : [ "string" ],
  "description" : "string",
  "preparation" : "string",
  "masterDescription" : "string",
  "channel" : {
    "@type" : "string",
    "channelName" : "string",
    "menuItemDescription" : "string",
    "extensionPoint" : { }
  },
  "packingList" : [ {
    "@type" : "string",
    "itemName" : "string",
    "quantity" : "integer",
    "extensionPoint" : { }
  } ],
  "orderingNotes" : "string",
  "ingredient" : [ {
    "@type" : "string",
    "id" : "string"
  } ],
  "servingSize" : {
    "@type" : "string",
    "count" : "integer",
    "unitOfMeasureEnum" : { },
    "preparedUnitOfMeasure" : "string",
    "description" : "string",
    "extensionPoint" : { }
  },
  "promotion" : {
    "@type" : "string",
    "promotionCode" : "string",
    "description" : "string",
    "extensionPoint" : { }
  },
  "mediaCategory" : [ {
    "@type" : "string",
    "name" : "string",
    "media" : { },
    "extensionPoint" : { }
  } ],
  "source" : "string",
  "pricing" : [ {
    "@type" : "string",
    "currency" : { },
    "surcharge" : [ { } ],
    "tax" : [ { } ],
    "itemPrice" : "number",
    "context" : [ "string" ],
    "discount" : [ { } ],
    "taxExemptInd" : "boolean",
    "extensionPoint" : { }
  } ],
  "sku" : {
    "productName" : "string",
    "productCode" : "string"
  },
  "default_" : [ {
    "@type" : "string",
    "quantity" : "integer",
    "quantityUnits" : "string",
    "preparation" : "string",
    "preparationQuantity" : "integer",
    "preparationUnits" : "string",
    "defaultNotes" : "string",
    "extensionPoint" : { }
  } ],
  "modifier" : {
    "@type" : "string",
    "id" : "string"
  },
  "modifierEligibleInd" : "boolean",
  "extensionPoint" : { }
}