POST api/Products

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Quantity	integer	None.
ProductHash	string	None.
ProductRelationHash	string	None.
ProductVariantHash	string	None.
RelationId	integer	None.
VariantId	integer	None.
ProductGuid	string	None.
LunchcartItemHash	string	None.
CommonProductId	string	None.
ParentProductId	string	None.
ProductTypeId	integer	None.
ProductSubType	string	None.
ProductSizeDescription	string	None.
MenuGroupId	integer	None.
MenuGroupName	string	None.
MenuGroupPosition	integer	None.
FavoriteProductHash	string	None.
Name	string	None.
MenuDisplayName	string	None.
OrderSummaryName	string	None.
Price	decimal number	None.
BasePrice	decimal number	None.
Description	string	None.
ImageId	integer	None.
ImageUrl	string	None.
ImageUrl2	string	None.
LgImageUrl	string	None.
MegaImageUrl	string	None.
CalloutImageUrl	string	None.
CalloutImagePosition	DtoProduct+ImagePosition	None.
IsFavorite	boolean	None.
IsEdited	boolean	None.
IsReadOnly	boolean	None.
IsEditorEnabled	boolean	None.
IsInlineEditorEnabled	boolean	None.
EditDescription	string	None.
RecipeDescription	string	None.
Nutrition	DtoNutrition	None.
StaticNutrition	boolean	None.
ShowNutrition	boolean	None.
PagerNameRequired	boolean	None.
PagerRequired	boolean	None.
HotFlag	boolean	None.
NoMeatFlag	boolean	None.
VeganFlag	boolean	None.
VegeFlag	boolean	None.
IsValid	boolean	None.
ProductAttributeTypes	Collection of DtoProductAttributeType	None.
IngredientList	Collection of DtoIngredient	None.
InternalUse	boolean	None.
ShareURL	string	None.
AppliedCombinedFilters	Collection of DtoCombinedMenuFilter	None.
ProductTypeSingularName	string	None.
PopularityRank	integer	None.
ErrorMessage	string	None.
DynamicImageUrl	string	None.
FoodFightPlace	integer	None.
FoodFightVotes	integer	None.
DisplayForTime	boolean	None.
HasEditOption	boolean	None.
FriendlyNameWithSizeDescription	string	None.
ChildProductList	Collection of DtoChildProduct	None.
ExtraProductImages	Collection of string	None.
MealGroupId	integer	None.
MealGroupName	string	None.
PackageEditOption	boolean	None.
VariantSelectorText	string	None.
ProductGroupId	integer	None.
IsDuoItem	boolean	None.
SpecialInstructions	string	None.

Request Formats

application/json

Sample:

Sample not available.

text/json

Sample:

Sample not available.

text/html

Sample:

Sample not available.

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.

Response Information

Resource Description

Product

Name	Type	Additional information
MenuDisplayName	string	None.
ProductHashKey	string	None.
ProductHash	string	None.
IsScheduled	boolean	None.
IsNutritionActive	boolean	None.
ProductId	integer	None.
MenuGroupId	integer	None.
MenuGroupName	string	None.
MenuGroupPosition	integer	None.
ProductCustomerId	integer	None.
ProductCustomerHash	string	None.
DawnSuggestsFlag	boolean	None.
IsEdited	boolean	None.
ShouldShowCalories	boolean	None.
IsDuoItem	boolean	None.
IsEditableProductType	boolean	None.
BasePrice	decimal number	None.
IngredientList	Collection of Object	None.
DisplayDietaryIcons	boolean	None.
FriendlyIngredientDescriptionHtmlForNutrition	string	None.
FriendlyIngredientDescriptionHtml	string	None.
FriendlyIngredientDescriptionWithoutRemoveHtml	string	None.
FriendlyIngredientDescription	string	None.
FriendlyIngredientEditsHtml	string	None.
GiftcardRecipientName	string	None.
GiftcardRecipientMessage	string	None.
OrderCount	integer	None.
OriginalName	string	None.
AppliedCombinedFilters	Collection of Object	None.
DisplayForTime	boolean	None.
HasEditOption	boolean	None.
ProductTemplateId	integer	None.
CellId	string	None.
Store	Store	None.
Changed	boolean	None.
TemplateActive	boolean	None.
LoadAvailInstances	Collection of Object	None.
ProductVariantHashKey	string	None.
ProductVariantHash	string	None.
Promo	boolean	None.
StaticNutrition	boolean	None.
ShowInProductPull	boolean	None.
ProductPullSortOrder	integer	None.
ProductPullNameOverride	string	None.
PosId	integer	None.
ComboFlag	boolean	None.
RangeFlag	boolean	None.
ComboPrice	decimal number	None.
FriendlyComboPrice	string	None.
FriendlyCalories	string	None.
FriendlyFatCalories	string	None.
FriendlyFatGrams	string	None.
FriendlySaturatedFatGrams	string	None.
FriendlyTransFatGrams	string	None.
FriendlyCholesterol	string	None.
FriendlySodium	string	None.
FriendlyCarbohydrates	string	None.
FriendlyFiberGrams	string	None.
FriendlySugarGrams	string	None.
FriendlyProteinGrams	string	None.
FriendlyIron	string	None.
FriendlyCalcium	string	None.
FriendlyVitaminA	string	None.
FriendlyVitaminC	string	None.
LegislatedRoundedCalories	string	None.
LegislatedRoundedFatCalories	string	None.
LegislatedRoundedFatGrams	string	None.
LegislatedRoundedSaturatedFatGrams	string	None.
LegislatedRoundedTransFatGrams	string	None.
LegislatedRoundedCholesterol	string	None.
LegislatedRoundedSodiumGrams	string	None.
LegislatedRoundedCarbohydrateGrams	string	None.
LegislatedRoundedFiberGrams	string	None.
LegislatedRoundedSugarGrams	string	None.
LegislatedRoundedProteinGrams	string	None.
LegislatedRoundedIron	string	None.
LegislatedRoundedCalcium	string	None.
LegislatedRoundedVitaminA	string	None.
LegislatedRoundedVitaminC	string	None.
NutritionMessage	string	None.
SubServingType	string	None.
FriendlyServingType	string	None.
NameWithCategoryPath	string	None.
NameWithCategoryPathHtml	string	None.
ProductLabelName	string	None.
LabelName	string	None.
VariantName	string	None.
VariantOrRelationName	string	None.
VariantDescription	string	None.
VariantActive	boolean	None.
VariantReadonly	boolean	None.
VariantSubName	string	None.
ProductTemplates	Collection of Object	None.
ProductTemplatesForProductCountOnly	Collection of Object	None.
ProductVariantId	integer	None.
SubType	string	None.
IngredientRelations	Collection of Object	None.
FriendlySubTypeForSoupsExclusive	string	None.
FriendlySubTypeForSoups	string	None.
OrderSummaryName	string	None.
FriendlyNameWithSizeDescription	string	None.
SizeDescription	string	None.
FriendlyPrice	string	None.
Price	decimal number	None.
PriceRegionId	integer	None.
PriceRegionName	string	None.
AveragePriceOnTemplate	decimal number	None.
AverageLivePrice	decimal number	None.
ChildProducts	Collection of Object	None.
Calcium	decimal number	None.
Calories	decimal number	None.
Carbohydrates	decimal number	None.
Cholesterol	decimal number	None.
FatGrams	decimal number	None.
FiberGrams	decimal number	None.
Iron	decimal number	None.
ProteinGrams	decimal number	None.
SaturatedFatGrams	decimal number	None.
Sodium	decimal number	None.
SugarGrams	decimal number	None.
TransFatGrams	decimal number	None.
VitaminA	decimal number	None.
VitaminC	decimal number	None.
CalciumMax	decimal number	None.
CaloriesMax	decimal number	None.
CarbohydratesMax	decimal number	None.
CholesterolMax	decimal number	None.
FatGramsMax	decimal number	None.
FiberGramsMax	decimal number	None.
IronMax	decimal number	None.
ProteinGramsMax	decimal number	None.
SaturatedFatGramsMax	decimal number	None.
SodiumMax	decimal number	None.
SugarGramsMax	decimal number	None.
TransFatGramsMax	decimal number	None.
VitaminAMax	decimal number	None.
VitaminCMax	decimal number	None.
ProductRelationHashKey	string	None.
ProductRelationHash	string	None.
Attributes	Collection of Object	None.
LinkedRelations	Collection of Object	None.
CanToss	boolean	None.
TossSaladIngredientRelation	IngredientRelation	None.
TossSaladIngredientRelationId	integer	None.
TossSaladIngredientRelationHash	string	None.
IsAvailableNow	boolean	None.
IsAvailableForDate	boolean	None.
IsAvailableForAllFutureDates	boolean	None.
DateAvailability	date	None.
DateAvailabilityEnd	date	None.
FriendlyLabelType	string	None.
EditorMode	EditorModeEnum	None.
ServingType	string	None.
OptionalExtras	Collection of Object	None.
InternalUse	boolean	None.
NoExportFlag	boolean	None.
NonRevenueFlag	boolean	None.
Active	boolean	None.
ShowNutrition	boolean	None.
PagerNameRequired	boolean	None.
PickupFlag	boolean	None.
DeliveryFlag	boolean	None.
DeliveryFee	DeliveryFeeEnum	None.
PagerRequired	boolean	None.
ProductType	ProductType	None.
ProductRelationId	integer	None.
ProductImage	ProductImage	None.
CalloutImageName	string	None.
CalloutImagePosition	ImagePosition	None.
VariantSelectorText	string	None.
IsReadOnly	boolean	None.
IsInlineEditorEnabled	boolean	None.
IsEditorEnabled	boolean	None.
IsPlatterEditorEnabled	boolean	None.
PlatterTypeId	integer	None.
InterstateFlag	boolean	None.
SingleQuantity	boolean	None.
LabelType	string	None.
Name	string	None.
SubName	string	None.
Description	string	None.
DescriptionLength	integer	None.
Archived	boolean	None.
MenuFilterExclude	boolean	None.
HotFlag	boolean	None.
AllFlags	string	None.
VegeFlagClass	string	None.
VeganFlagClass	string	None.
HotFlagClass	string	None.
MenuFilterExcludeClass	string	None.
VegeFlag	boolean	None.
VeganFlag	boolean	None.
NoMeatFlag	boolean	None.
NoWheatFlag	boolean	None.
FriendlyVegeFlagDescription	string	None.
GiftFlag	boolean	None.
Priority	integer	None.
Tag	string	None.
ActiveOnline	boolean	None.
ActiveKiosk	boolean	None.
ActiveProductVariants	Collection of Object	None.
ProductVariants	Collection of Object	None.
TestUsersOnly	boolean	None.
PopularityRank	integer	None.
MenuboardGroupingTier1	string	None.
MenuboardGroupingTier2	string	None.
MenuboardGroupingTier3	string	None.
MenuboardDescription	string	None.
MenuboardPosition	integer	None.
ActiveOnMenuboard	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "_productId": 0,
  "_productCustomerId": null,
  "_basePrice": 0.0,
  "_onTheSideOption": false,
  "_giftcardRecipientName": null,
  "_giftcardRecipientMessage": null,
  "_orderCount": null,
  "_menuGroupId": 3,
  "_menuGroupPosition": 0,
  "_menuGroupName": null,
  "_originalName": null,
  "_isScheduled": true,
  "_menuDisplayName": "sample string 1",
  "_appliedCombinedFilters": null,
  "_dawnSuggestsFlag": true,
  "_displayForTime": true,
  "_OriginalNutrition": {
    "_Calories": 0.0,
    "_FatGrams": 0.0,
    "_FiberGrams": 0.0,
    "_SaturatedFatGrams": 0.0,
    "_TransFatGrams": 0.0,
    "_Cholesterol": 0.0,
    "_Sodium": 0.0,
    "_Carbohydrates": 0.0,
    "_SugarGrams": 0.0,
    "_ProteinGrams": 0.0,
    "_VitaminA": 0.0,
    "_VitaminC": 0.0,
    "_Calcium": 0.0,
    "_Iron": 0.0,
    "_LegislatedFatCaloriesString": null,
    "_LegislatedCaloriesString": null,
    "_LegislatedFatGramsString": null,
    "_LegislatedFiberGramsString": null,
    "_LegislatedSaturatedFatGramsString": null,
    "_LegislatedTransFatGramsString": null,
    "_LegislatedCholesterolString": null,
    "_LegislatedSodiumString": null,
    "_LegislatedCarbohydratesString": null,
    "_LegislatedSugarGramsString": null,
    "_LegislatedProteinGramsString": null,
    "_LegislatedVitaminAString": null,
    "_LegislatedVitaminCString": null,
    "_LegislatedCalciumString": null,
    "_LegislatedIronString": null
  },
  "_edtiOption": true,
  "_productTemplateId": 0,
  "_cellId": null,
  "_ingredients": null,
  "_store": null,
  "_changed": false,
  "_templateActive": false,
  "_productVariantId": 0,
  "_variantName": null,
  "_variantSubName": null,
  "_variantDescription": null,
  "_variantActive": false,
  "_variantReadonly": null,
  "_subType": null,
  "_labelName": null,
  "_productLabelName": null,
  "_price": 0.0,
  "_comboFlag": false,
  "_comboPrice": null,
  "_ingredientRelations": null,
  "_productTemplates": null,
  "_productTemplatesForProductCountOnly": null,
  "_availInstances": null,
  "_posId": null,
  "_nutritionMessage": null,
  "_subServingType": null,
  "_childProducts": null,
  "_staticNutrition": false,
  "_showInProductPull": false,
  "_productPullSortOrder": null,
  "_productPullNameOverride": null,
  "_calcium": 0.0,
  "_calories": 0.0,
  "_carbohydrates": 0.0,
  "_cholesterol": 0.0,
  "_fatGrams": 0.0,
  "_fiberGrams": 0.0,
  "_iron": 0.0,
  "_proteinGrams": 0.0,
  "_saturatedFatGrams": 0.0,
  "_sodium": 0.0,
  "_sugarGrams": 0.0,
  "_transFatGrams": 0.0,
  "_vitaminA": 0.0,
  "_vitaminC": 0.0,
  "_promo": false,
  "_rangeFlag": false,
  "_calciumMax": 0.0,
  "_caloriesMax": 0.0,
  "_carbohydratesMax": 0.0,
  "_cholesterolMax": 0.0,
  "_fatGramsMax": 0.0,
  "_fiberGramsMax": 0.0,
  "_ironMax": 0.0,
  "_proteinGramsMax": 0.0,
  "_saturatedFatGramsMax": 0.0,
  "_sodiumMax": 0.0,
  "_sugarGramsMax": 0.0,
  "_transFatGramsMax": 0.0,
  "_vitaminAMax": 0.0,
  "_vitaminCMax": 0.0,
  "_priceRegionId": null,
  "_priceRegionName": null,
  "_avgPriceOnTemplate": null,
  "_avgLivePrice": null,
  "_productImage": {
    "_urlTemplate": "~/Images/ProdImg/{0}_{1}_b.jpg",
    "_imageId": null,
    "_productTypeId": 0,
    "_productSubType": null,
    "_url": null,
    "_name": null,
    "_archived": false,
    "_imageFileName": null
  },
  "_productRelationId": 0,
  "_productType": {
    "_menuId": 0,
    "_productTypeId": 0,
    "_productSubType": null,
    "_name": null,
    "_friendlyName": null,
    "_showIngredientStack": false,
    "_showNutrition": false,
    "_shortName": null,
    "_sizeName": null,
    "_priority": 0,
    "_active": false,
    "_edited": false,
    "_comboFlag": false,
    "_calendarEnabled": false,
    "_originalProductTypeId": null,
    "_dynamicNutrition": false,
    "_readonly": false,
    "_editorType": 1,
    "_noLineFlag": false,
    "_productRelations": null,
    "_productTypeLinks": null
  },
  "_name": null,
  "_subName": null,
  "_shortName": null,
  "_description": null,
  "_detailedDescription": null,
  "_isReadOnly": false,
  "_smallImg": null,
  "_labelType": null,
  "_interstateFlag": false,
  "_archived": false,
  "_dateCreate": "0001-01-01T00:00:00",
  "_priority": 0,
  "_showNutrition": false,
  "_menuFilterExclude": false,
  "_giftFlag": false,
  "_pagerNameRequired": false,
  "_pagerRequired": true,
  "_activeOnline": false,
  "_activeKiosk": false,
  "_active": false,
  "_productVariants": null,
  "_optionalExtras": null,
  "_internalUse": false,
  "_noExportFlag": false,
  "_nonRevenueFlag": false,
  "_dateAvailability": null,
  "_dateAvailabilityEnd": null,
  "_dateVisibility": null,
  "_dateVisibilityEnd": null,
  "_pickupFlag": false,
  "_deliveryFlag": false,
  "_singleQuantity": false,
  "_deliveryFee": 0,
  "_tag": null,
  "_editorMode": 0,
  "_platterTypeId": null,
  "_servingType": null,
  "_attributes": null,
  "_linkedRelations": null,
  "_testUsersOnly": false,
  "_popularityRank": 0,
  "_calloutImageName": null,
  "_calloutPostition": 0,
  "_variantSelectorText": null,
  "_menuboardGroupingTier1": null,
  "_menuboardGroupingTier2": null,
  "_menuboardGroupingTier3": null,
  "_menuboardDescription": null,
  "_menuboardPosition": 0,
  "_activeOnMenuboard": false
}

text/html

Sample:

{"_productId":0,"_productCustomerId":null,"_basePrice":0.0,"_onTheSideOption":false,"_giftcardRecipientName":null,"_giftcardRecipientMessage":null,"_orderCount":null,"_menuGroupId":3,"_menuGroupPosition":0,"_menuGroupName":null,"_originalName":null,"_isScheduled":true,"_menuDisplayName":"sample string 1","_appliedCombinedFilters":null,"_dawnSuggestsFlag":true,"_displayForTime":true,"_OriginalNutrition":{"_Calories":0.0,"_FatGrams":0.0,"_FiberGrams":0.0,"_SaturatedFatGrams":0.0,"_TransFatGrams":0.0,"_Cholesterol":0.0,"_Sodium":0.0,"_Carbohydrates":0.0,"_SugarGrams":0.0,"_ProteinGrams":0.0,"_VitaminA":0.0,"_VitaminC":0.0,"_Calcium":0.0,"_Iron":0.0,"_LegislatedFatCaloriesString":null,"_LegislatedCaloriesString":null,"_LegislatedFatGramsString":null,"_LegislatedFiberGramsString":null,"_LegislatedSaturatedFatGramsString":null,"_LegislatedTransFatGramsString":null,"_LegislatedCholesterolString":null,"_LegislatedSodiumString":null,"_LegislatedCarbohydratesString":null,"_LegislatedSugarGramsString":null,"_LegislatedProteinGramsString":null,"_LegislatedVitaminAString":null,"_LegislatedVitaminCString":null,"_LegislatedCalciumString":null,"_LegislatedIronString":null},"_edtiOption":true,"_productTemplateId":0,"_cellId":null,"_ingredients":null,"_store":null,"_changed":false,"_templateActive":false,"_productVariantId":0,"_variantName":null,"_variantSubName":null,"_variantDescription":null,"_variantActive":false,"_variantReadonly":null,"_subType":null,"_labelName":null,"_productLabelName":null,"_price":0.0,"_comboFlag":false,"_comboPrice":null,"_ingredientRelations":null,"_productTemplates":null,"_productTemplatesForProductCountOnly":null,"_availInstances":null,"_posId":null,"_nutritionMessage":null,"_subServingType":null,"_childProducts":null,"_staticNutrition":false,"_showInProductPull":false,"_productPullSortOrder":null,"_productPullNameOverride":null,"_calcium":0.0,"_calories":0.0,"_carbohydrates":0.0,"_cholesterol":0.0,"_fatGrams":0.0,"_fiberGrams":0.0,"_iron":0.0,"_proteinGrams":0.0,"_saturatedFatGrams":0.0,"_sodium":0.0,"_sugarGrams":0.0,"_transFatGrams":0.0,"_vitaminA":0.0,"_vitaminC":0.0,"_promo":false,"_rangeFlag":false,"_calciumMax":0.0,"_caloriesMax":0.0,"_carbohydratesMax":0.0,"_cholesterolMax":0.0,"_fatGramsMax":0.0,"_fiberGramsMax":0.0,"_ironMax":0.0,"_proteinGramsMax":0.0,"_saturatedFatGramsMax":0.0,"_sodiumMax":0.0,"_sugarGramsMax":0.0,"_transFatGramsMax":0.0,"_vitaminAMax":0.0,"_vitaminCMax":0.0,"_priceRegionId":null,"_priceRegionName":null,"_avgPriceOnTemplate":null,"_avgLivePrice":null,"_productImage":{"_urlTemplate":"~/Images/ProdImg/{0}_{1}_b.jpg","_imageId":null,"_productTypeId":0,"_productSubType":null,"_url":null,"_name":null,"_archived":false,"_imageFileName":null},"_productRelationId":0,"_productType":{"_menuId":0,"_productTypeId":0,"_productSubType":null,"_name":null,"_friendlyName":null,"_showIngredientStack":false,"_showNutrition":false,"_shortName":null,"_sizeName":null,"_priority":0,"_active":false,"_edited":false,"_comboFlag":false,"_calendarEnabled":false,"_originalProductTypeId":null,"_dynamicNutrition":false,"_readonly":false,"_editorType":1,"_noLineFlag":false,"_productRelations":null,"_productTypeLinks":null},"_name":null,"_subName":null,"_shortName":null,"_description":null,"_detailedDescription":null,"_isReadOnly":false,"_smallImg":null,"_labelType":null,"_interstateFlag":false,"_archived":false,"_dateCreate":"0001-01-01T00:00:00","_priority":0,"_showNutrition":false,"_menuFilterExclude":false,"_giftFlag":false,"_pagerNameRequired":false,"_pagerRequired":true,"_activeOnline":false,"_activeKiosk":false,"_active":false,"_productVariants":null,"_optionalExtras":null,"_internalUse":false,"_noExportFlag":false,"_nonRevenueFlag":false,"_dateAvailability":null,"_dateAvailabilityEnd":null,"_dateVisibility":null,"_dateVisibilityEnd":null,"_pickupFlag":false,"_deliveryFlag":false,"_singleQuantity":false,"_deliveryFee":0,"_tag":null,"_editorMode":0,"_platterTypeId":null,"_servingType":null,"_attributes":null,"_linkedRelations":null,"_testUsersOnly":false,"_popularityRank":0,"_calloutImageName":null,"_calloutPostition":0,"_variantSelectorText":null,"_menuboardGroupingTier1":null,"_menuboardGroupingTier2":null,"_menuboardGroupingTier3":null,"_menuboardDescription":null,"_menuboardPosition":0,"_activeOnMenuboard":false}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.