Modifier
Properties
Name |
Description |
Type |
Required |
Generic |
Enum |
Ignore |
@type |
|
string |
|
|
|
|
iD |
Assigned Type: ms-0100:GUID |
string |
|
|
|
|
action |
Specifies if the modifer is being added or removed. |
string |
|
|
|
|
NutritionResource |
URL to master nutrition guide for specific information about a menu item. |
string |
|
|
|
|
BaselineNutrition |
|
array |
|
BaselineNutrition |
--- |
|
DietaryRestrictions |
Assigned Type: ms-0100:DietaryRestrictions |
DietaryRestrictions |
|
|
|
|
RegulatoryRequirementsDescription |
Provides regulatory notification requirements (e.g. Sodium warning, calorie warning). |
string |
|
|
|
|
Availability |
Assigned Type: ms-0100:Availability |
Availability |
|
|
|
|
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 |
|
|
|
|
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 |
|
|
|
|
Destination |
|
array |
|
string |
|
|
Description |
A textual description of the menu item. |
string |
|
|
|
|
Preparation |
Describes how the menu item is prepared. |
string |
|
|
|
|
MasterDescription |
The main description for the menu item. |
string |
|
|
|
|
Channel |
Assigned Type: ms-0100:Channel |
Channel |
|
|
|
|
PackingList |
|
array |
|
PackingList |
--- |
|
OrderingNotes |
Textual information regarding any specific ordering information for this menu item. |
string |
|
|
|
|
Ingredient |
|
array |
|
IngredientID |
--- |
|
ServingSize |
Assigned Type: ms-0100:ServingSize |
ServingSize |
|
|
|
|
Promotion |
Assigned Type: ms-0100:Promotion |
Promotion |
|
|
|
|
MediaCategory |
|
array |
|
MediaCategory |
--- |
|
Source |
Where the item came from. |
string |
|
|
|
|
SKU |
Assigned Type: ms-0100:SKU |
SKU |
|
|
|
|
Modifier |
Assigned Type: ms-0100:Modifier |
ModifierID |
|
|
|
|
Default |
|
array |
|
Default |
--- |
|
Pricing |
|
array |
|
Pricing |
--- |
|
modifierEligibleInd |
When true, this menu item may be modified. |
boolean |
|
|
|
|
ExtensionPoint |
|
ExtensionPoint |
|
|
|
|
{
"@type" : "string",
"id" : "string",
"action" : "string",
"nutritionResource" : "string",
"baselineNutrition" : [ {
"@type" : "string",
"count" : "integer",
"nutritionInformationType" : { },
"unitOfMeasure" : { },
"extensionPointSummary" : { }
} ],
"dietaryRestrictions" : {
"@type" : "string",
"allergenDetails" : [ { } ],
"lifestyleChoicesEnum" : [ { } ],
"extensionPoint" : { }
},
"regulatoryRequirementsDescription" : "string",
"availability" : {
"@type" : "string",
"extensionPointShared" : { }
},
"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",
"sku" : {
"productName" : "string",
"productCode" : "string"
},
"modifier" : {
"@type" : "string",
"id" : "string"
},
"default_" : [ {
"@type" : "string",
"quantity" : "integer",
"quantityUnits" : "string",
"preparation" : "string",
"preparationQuantity" : "integer",
"preparationUnits" : "string",
"defaultNotes" : "string",
"extensionPoint" : { }
} ],
"pricing" : [ {
"@type" : "string",
"currency" : { },
"surcharge" : [ { } ],
"tax" : [ { } ],
"itemPrice" : "number",
"context" : [ "string" ],
"discount" : [ { } ],
"taxExemptInd" : "boolean",
"extensionPoint" : { }
} ],
"modifierEligibleInd" : "boolean",
"extensionPoint" : { }
}