Jump to

• Request
• Response

Update Menu Item Definitions

post

/config/sim/v1/menuItems/updateMenuItemDefinitions

Updates Menu Item Definition

Request

Supported Media Types

• application/json
• multipart/form-data

Header Parameters

• Simphony-AuditTrailRef: string
  Detail that identifies, who made the change.

Body ()

Request body

Root Schema : MenuItemDefinitionUpdateRequestBody

Type: object

Show Source

• components: array components
  An array of components associated with the menu item
• consumerAdvisoryDesc: string
  The consumer advisory description of the menu item

  Example: Menu Item 1
• consumerItemDescription: object TranslatedString
  Additional Properties Allowed: additionalProperties

  A string that contains translations into multiple languages
• consumerItemName: object TranslatedString
  Additional Properties Allowed: additionalProperties

  A string that contains translations into multiple languages
• customMenuLevels: array customMenuLevels
  An array of custom menu levels associated with the menu item. It contains as many child attributes depending upon the custom levels configured
• dataExtensions: array dataExtensions
  An array of data extensions for the menu item
• defaultCondiments: array defaultCondiments
  An array of Default Condiment of a Menu Item
• firstName: object TranslatedString
  Additional Properties Allowed: additionalProperties

  A string that contains translations into multiple languages
• guestCount: integer
  Guest count for the menu item to increment the check guest count when added.

  Example: 1
• hierUnitId(required): integer
  Hierarchy unit unique reference

  Example: 1012
• images: array images
  An array of images associated with the menu item
• kdsPrepTime: integer
  The number of minutes necessary to prepare this item

  Example: 10.3
• longDescriptor: object TranslatedString
  Additional Properties Allowed: additionalProperties

  A string that contains translations into multiple languages
• mainLevel: string
  A string value of 0s & 1s of length 8 representing main levels on which the definition is active.

  Example: 11001111
• menuItemClassObjNum: integer
  Object number of the menu item Class

  Example: 1
• menuItemDefinitionId(required): integer
  The unique reference for the Menu Item Definition

  Example: 1
• nluGroupObjNum: integer
  Object number of the NLU Group associated with this menu item

  Example: 1
• nluNum:
  Unique NLU number for this menu item (up to 12 digits).

  Example: 1
• nutrients: array nutrients
  An array of nutrients of the menu item
• overrideAllergenClassObjNum: integer
  Object number of the Allergen Class for the menu item definition to override its menu item class setting

  Example: 1
• overridePrintClassObjNum: integer
  Object number of the Print Class

  Example: 1
• prefixLevelOverride: integer
  Select to allow the condiment prefix to override the price level of the item it modifies.

  Example: 1
• productionItems: array productionItems
  An array of production items associated with the menu item
• quantity: integer
  Quantity of a Menu Item

  Example: 1
• secondName: object TranslatedString
  Additional Properties Allowed: additionalProperties

  A string that contains translations into multiple languages
• slu1ObjNum: integer
  Object number of SLU 1 to which the Menu Item Definition belongs

  Example: 200
• slu2ObjNum: integer
  Object number of SLU 2 to which the Menu Item Definition belongs

  Example: 201
• slu3ObjNum: integer
  Object number of SLU 3 to which the Menu Item Definition belongs

  Example: 202
• slu4ObjNum: integer
  Object number of SLU 4 to which the Menu Item Definition belongs

  Example: 203
• slu5ObjNum: integer
  Object number of SLU 5 to which the Menu Item Definition belongs

  Example: 204
• slu6ObjNum: integer
  Object number of SLU 6 to which the Menu Item Definition belongs

  Example: 205
• slu7ObjNum: integer
  Object number of SLU 7 to which the Menu Item Definition belongs

  Example: 206
• slu8ObjNum: integer
  Object number of SLU 8 to which the Menu Item Definition belongs

  Example: 207
• sluSortPriority: integer
  Use this field when Page Design Layout option

  Example: 0
• subLevel: string
  A string value of 0s & 1s of length 8 representing Sub Levels on which the definition is active

  Example: 11001111
• surcharge: integer
  Surcharge for the menu item

  Example: 1
• tags: array tags
  An array of tags associated with the menu item
• tareWeight: integer
  Weight of the empty package for an item sold by weight

  Example: 1.23
• thirdName: object TranslatedString
  Additional Properties Allowed: additionalProperties

  A string that contains translations into multiple languages

{
    "type":"object",
    "required":[
        "hierUnitId",
        "menuItemDefinitionId"
    ],
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":1012,
            "description":"Hierarchy unit unique reference"
        },
        "menuItemDefinitionId":{
            "type":"integer",
            "example":1,
            "description":"The unique reference for the Menu Item Definition"
        },
        "firstName":{
            "description":"A group of string objects representing the name of the Menu Item in configured languages",
            "$ref":"#/definitions/TranslatedString"
        },
        "secondName":{
            "description":"A group of string objects representing the alternate name (Name 2) of the Menu Item in configured languages",
            "$ref":"#/definitions/TranslatedString"
        },
        "thirdName":{
            "description":"A group of string objects representing the alternate name (Name 3) of the Menu Item in configured languages",
            "$ref":"#/definitions/TranslatedString"
        },
        "longDescriptor":{
            "description":"A group of string objects representing the long descriptor of the Menu Item in configured languages",
            "$ref":"#/definitions/TranslatedString"
        },
        "menuItemClassObjNum":{
            "type":"integer",
            "example":1,
            "description":"Object number of the menu item Class"
        },
        "overridePrintClassObjNum":{
            "type":"integer",
            "example":1,
            "description":"Object number of the Print Class"
        },
        "mainLevel":{
            "type":"string",
            "example":"11001111",
            "description":"A string value of 0s & 1s of length 8 representing main levels on which the definition is active."
        },
        "subLevel":{
            "type":"string",
            "example":"11001111",
            "description":"A string value of 0s & 1s of length 8 representing Sub Levels on which the definition is active"
        },
        "slu1ObjNum":{
            "type":"integer",
            "example":200,
            "description":"Object number of SLU 1 to which the Menu Item Definition belongs"
        },
        "slu2ObjNum":{
            "type":"integer",
            "example":201,
            "description":"Object number of SLU 2 to which the Menu Item Definition belongs"
        },
        "slu3ObjNum":{
            "type":"integer",
            "example":202,
            "description":"Object number of SLU 3 to which the Menu Item Definition belongs"
        },
        "slu4ObjNum":{
            "type":"integer",
            "example":203,
            "description":"Object number of SLU 4 to which the Menu Item Definition belongs"
        },
        "slu5ObjNum":{
            "type":"integer",
            "example":204,
            "description":"Object number of SLU 5 to which the Menu Item Definition belongs"
        },
        "slu6ObjNum":{
            "type":"integer",
            "example":205,
            "description":"Object number of SLU 6 to which the Menu Item Definition belongs"
        },
        "slu7ObjNum":{
            "type":"integer",
            "example":206,
            "description":"Object number of SLU 7 to which the Menu Item Definition belongs"
        },
        "slu8ObjNum":{
            "type":"integer",
            "example":207,
            "description":"Object number of SLU 8 to which the Menu Item Definition belongs"
        },
        "sluSortPriority":{
            "type":"integer",
            "example":0,
            "description":"Use this field when Page Design Layout option"
        },
        "nluGroupObjNum":{
            "type":"integer",
            "example":1,
            "description":"Object number of the NLU Group associated with this menu item"
        },
        "nluNum":{
            "example":"1",
            "description":"Unique NLU number for this menu item (up to 12 digits)."
        },
        "tareWeight":{
            "type":"integer",
            "example":"1.23",
            "description":"Weight of the empty package for an item sold by weight"
        },
        "surcharge":{
            "type":"integer",
            "example":1,
            "description":"Surcharge for the menu item"
        },
        "quantity":{
            "type":"integer",
            "example":1,
            "description":"Quantity of a Menu Item"
        },
        "overrideAllergenClassObjNum":{
            "type":"integer",
            "example":1,
            "description":"Object number of the Allergen Class for the menu item definition to override its menu item class setting"
        },
        "kdsPrepTime":{
            "type":"integer",
            "example":"10.3",
            "description":"The number of minutes necessary to prepare this item"
        },
        "prefixLevelOverride":{
            "type":"integer",
            "example":1,
            "description":"Select to allow the condiment prefix to override the price level of the item it modifies."
        },
        "guestCount":{
            "type":"integer",
            "example":1,
            "description":"Guest count for the menu item to increment the check guest count when added."
        },
        "consumerAdvisoryDesc":{
            "type":"string",
            "example":"Menu Item 1",
            "description":"The consumer advisory description of the menu item"
        },
        "consumerItemName":{
            "description":"A group of string objects representing the consumer description in configured languages",
            "$ref":"#/definitions/TranslatedString"
        },
        "consumerItemDescription":{
            "description":"A group of string objects representing the consumer description in configured languages",
            "$ref":"#/definitions/TranslatedString"
        },
        "images":{
            "type":"array",
            "description":"An array of images associated with the menu item",
            "items":{
                "$ref":"#/definitions/MenuItem_image"
            }
        },
        "customMenuLevels":{
            "type":"array",
            "description":"An array of custom menu levels associated with the menu item. It contains as many child attributes depending upon the custom levels configured",
            "items":{
                "$ref":"#/definitions/MenuItem_customMenuLevel"
            }
        },
        "defaultCondiments":{
            "type":"array",
            "description":"An array of Default Condiment of a Menu Item",
            "items":{
                "$ref":"#/definitions/MenuItem_defaultCondiment"
            }
        },
        "productionItems":{
            "type":"array",
            "description":"An array of production items associated with the menu item",
            "items":{
                "$ref":"#/definitions/MenuItem_productionItem"
            }
        },
        "components":{
            "type":"array",
            "description":"An array of components associated with the menu item",
            "items":{
                "$ref":"#/definitions/MenuItem_component"
            }
        },
        "tags":{
            "type":"array",
            "description":"An array of tags associated with the menu item",
            "items":{
                "$ref":"#/definitions/MenuItem_tag"
            }
        },
        "nutrients":{
            "type":"array",
            "description":"An array of nutrients of the menu item",
            "items":{
                "$ref":"#/definitions/MenuItem_nutrient"
            }
        },
        "dataExtensions":{
            "type":"array",
            "description":"An array of data extensions for the menu item",
            "items":{
                "$ref":"#/definitions/MenuItem_dataExtensions"
            }
        }
    }
}

Nested Schema : components

Type: array

An array of components associated with the menu item

Show Source

• Array of: object MenuItem_component

{
    "type":"array",
    "description":"An array of components associated with the menu item",
    "items":{
        "$ref":"#/definitions/MenuItem_component"
    }
}

Nested Schema : TranslatedString

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "description":"A string that contains translations into multiple languages",
    "example":{
        "en-US":"Coffee",
        "de-DE":"Kaffee",
        "es-MX":"Cafe"
    },
    "additionalProperties":{
        "type":"string"
    }
}

A string that contains translations into multiple languages

Example:

{
    "en-US":"Coffee",
    "de-DE":"Kaffee",
    "es-MX":"Cafe"
}

Nested Schema : customMenuLevels

Type: array

An array of custom menu levels associated with the menu item. It contains as many child attributes depending upon the custom levels configured

Show Source

• Array of: object MenuItem_customMenuLevel

{
    "type":"array",
    "description":"An array of custom menu levels associated with the menu item. It contains as many child attributes depending upon the custom levels configured",
    "items":{
        "$ref":"#/definitions/MenuItem_customMenuLevel"
    }
}

Nested Schema : dataExtensions

Type: array

An array of data extensions for the menu item

Show Source

• Array of: object MenuItem_dataExtensions

{
    "type":"array",
    "description":"An array of data extensions for the menu item",
    "items":{
        "$ref":"#/definitions/MenuItem_dataExtensions"
    }
}

Nested Schema : defaultCondiments

Type: array

An array of Default Condiment of a Menu Item

Show Source

• Array of: object MenuItem_defaultCondiment

{
    "type":"array",
    "description":"An array of Default Condiment of a Menu Item",
    "items":{
        "$ref":"#/definitions/MenuItem_defaultCondiment"
    }
}

Nested Schema : images

Type: array

An array of images associated with the menu item

Show Source

• Array of: object MenuItem_image

{
    "type":"array",
    "description":"An array of images associated with the menu item",
    "items":{
        "$ref":"#/definitions/MenuItem_image"
    }
}

Nested Schema : nutrients

Type: array

An array of nutrients of the menu item

Show Source

• Array of: object MenuItem_nutrient

{
    "type":"array",
    "description":"An array of nutrients of the menu item",
    "items":{
        "$ref":"#/definitions/MenuItem_nutrient"
    }
}

Nested Schema : productionItems

Type: array

An array of production items associated with the menu item

Show Source

• Array of: object MenuItem_productionItem

{
    "type":"array",
    "description":"An array of production items associated with the menu item",
    "items":{
        "$ref":"#/definitions/MenuItem_productionItem"
    }
}

Nested Schema : tags

Type: array

An array of tags associated with the menu item

Show Source

• Array of: object MenuItem_tag

{
    "type":"array",
    "description":"An array of tags associated with the menu item",
    "items":{
        "$ref":"#/definitions/MenuItem_tag"
    }
}

Nested Schema : MenuItem_component

Type: object

Show Source

• componentObjNum: integer
  Object number of the component

  Example: 1

{
    "type":"object",
    "properties":{
        "componentObjNum":{
            "type":"integer",
            "example":1,
            "description":"Object number of the component"
        }
    }
}

Nested Schema : MenuItem_customMenuLevel

Type: object

Show Source

• customLevel: string
  Flag indicating if the menu item is active on Custom Level

  Example: 11001111
• menuLevelObjNum: integer
  Object number of the menu level

  Example: 3

{
    "type":"object",
    "properties":{
        "menuLevelObjNum":{
            "type":"integer",
            "example":3,
            "description":"Object number of the menu level"
        },
        "customLevel":{
            "type":"string",
            "example":"11001111",
            "description":"Flag indicating if the menu item is active on Custom Level"
        }
    }
}

Nested Schema : MenuItem_dataExtensions

Type: object

Show Source

• columnName: string
  Name of the extention field

  Example: extension column 1
• value: string
  Value of the extention field

  Example: value 1

{
    "type":"object",
    "properties":{
        "columnName":{
            "type":"string",
            "example":"extension column 1",
            "description":"Name of the extention field"
        },
        "value":{
            "type":"string",
            "example":"value 1",
            "description":"Value of the extention field"
        }
    }
}

Nested Schema : MenuItem_defaultCondiment

Type: object

Show Source

• condimentSetObjNum: integer
  Object number of the condiment set

  Example: 1
• menuItemDefaultCondimentId: integer
  Unique reference of the Menu Item Default Condiment

  Example: 1000
• options: string
  A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated with the default condiments of the menu item. This value is excluded by default in GET response.

  Example: 1000000
• sortGroup: integer
  Sort group of the condiment set

  Example: 1

{
    "type":"object",
    "properties":{
        "menuItemDefaultCondimentId":{
            "type":"integer",
            "example":1000,
            "description":"Unique reference of the Menu Item Default Condiment"
        },
        "condimentSetObjNum":{
            "type":"integer",
            "example":1,
            "description":"Object number of the condiment set"
        },
        "sortGroup":{
            "type":"integer",
            "example":1,
            "description":"Sort group of the condiment set"
        },
        "options":{
            "type":"string",
            "example":"1000000",
            "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated with the default condiments of the menu item. This value is excluded by default in GET response."
        }
    }
}

Nested Schema : MenuItem_image

Type: object

Show Source

• altText: string
  The image alternative text of the menu item

  Example: pizza
• description: string
  The description text of the menu item

  Example: pizza description
• imageIndex: integer
  Image Number for reference

  Example: 1
• isCloudImage: boolean
  Flag indicating if the image is stored on the Cloud

  Example: true
• size: string
  The size of the image

  Example: 1
• url: string
  The URL of the image of the menu item

  Example: https://oracleObjectStore.com/images/coffee822815.jpg

{
    "type":"object",
    "properties":{
        "imageIndex":{
            "type":"integer",
            "example":1,
            "description":"Image Number for reference"
        },
        "url":{
            "type":"string",
            "example":"https://oracleObjectStore.com/images/coffee822815.jpg",
            "description":"The URL of the image of the menu item"
        },
        "altText":{
            "type":"string",
            "example":"pizza",
            "description":"The image alternative text of the menu item"
        },
        "description":{
            "type":"string",
            "example":"pizza description",
            "description":"The description text of the menu item"
        },
        "isCloudImage":{
            "type":"boolean",
            "example":true,
            "description":"Flag indicating if the image is stored on the Cloud"
        },
        "size":{
            "type":"string",
            "example":"1",
            "description":"The size of the image"
        }
    }
}

Nested Schema : MenuItem_nutrient

Type: object

Show Source

• menuItemNutrientSetId: integer
  Unique reference of the menu item nutrient

  Example: 1
• nutrientSetObjNum: integer
  Object number of the nutrient set

  Example: 1

{
    "type":"object",
    "properties":{
        "nutrientSetObjNum":{
            "type":"integer",
            "example":1,
            "description":"Object number of the nutrient set"
        },
        "menuItemNutrientSetId":{
            "type":"integer",
            "example":1,
            "description":"Unique reference of the menu item nutrient"
        }
    }
}

Nested Schema : MenuItem_productionItem

Type: object

Show Source

• productionItemCount: integer
  The number of portions required to complete the menu item.

  Example: 1.4
• productionItemObjNum: integer
  Object number of the production item

  Example: false

{
    "type":"object",
    "properties":{
        "productionItemObjNum":{
            "type":"integer",
            "example":"false",
            "description":"Object number of the production item"
        },
        "productionItemCount":{
            "type":"integer",
            "example":"1.4",
            "description":"The number of portions required to complete the menu item."
        }
    }
}

Nested Schema : MenuItem_tag

Type: object

Show Source

• tagName: string
  The name of Tag associated with the menu item

  Example: Tag

{
    "type":"object",
    "properties":{
        "tagName":{
            "type":"string",
            "example":"Tag",
            "description":"The name of Tag associated with the menu item"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

A response body for the updated Menu Item Definition

Body ()

Root Schema : MenuItemDefintionUpdateResponse

Type: object

Show Source

• defSequenceNum(required): integer
  Indicates the definition sequence number, which is the number of the definition in the revenue center for this master record.Sequence Number should be with 1-64

  Example: 1
• menuItemDefinitionId(required): integer
  The unique reference for the Menu Item Definition

  Example: 1
• menuItemDefitinitionHierUnitId(required): integer
  Hierarchy unit unique reference where definition was created.

  Example: 1
• menuItemMasterHierUnitId(required): integer
  Hierarchy location of the master the definition was added to.

  Example: 1
• menuItemMasterId(required): integer
  The unique reference for the Menu Item Master

  Example: 1
• menuItemMasterObjNum(required): integer
  Menu item master object number.

  Example: 1

{
    "type":"object",
    "required":[
        "menuItemMasterId",
        "menuItemDefinitionId",
        "defSequenceNum",
        "menuItemMasterObjNum",
        "menuItemMasterHierUnitId",
        "menuItemDefitinitionHierUnitId"
    ],
    "properties":{
        "menuItemMasterId":{
            "type":"integer",
            "example":1,
            "description":"The unique reference for the Menu Item Master"
        },
        "menuItemDefinitionId":{
            "type":"integer",
            "example":1,
            "description":"The unique reference for the Menu Item Definition"
        },
        "defSequenceNum":{
            "type":"integer",
            "example":1,
            "description":"Indicates the definition sequence number, which is the number of the definition in the revenue center for this master record.Sequence Number should be with 1-64"
        },
        "menuItemMasterObjNum":{
            "type":"integer",
            "example":1,
            "description":"Menu item master object number."
        },
        "menuItemMasterHierUnitId":{
            "type":"integer",
            "example":1,
            "description":"Hierarchy location of the master the definition was added to."
        },
        "menuItemDefitinitionHierUnitId":{
            "type":"integer",
            "example":1,
            "description":"Hierarchy unit unique reference where definition was created."
        }
    }
}

400 Response

400 Bad Request

Body ()

Root Schema : ErrorDetails

Type: object

Response body when the request returns an error.

Show Source

• detail(required): string
  A short, human-readable summary of the problem.

  Example: Specified Data is invalid
• errorDetails(required): string
  A human-readable explanation specific to this occurrence of the problem.

  Example: Entity Does Not Exist
• o:errorCode(required): integer
  Error code of the problem

  Example: 55223
• status(required): integer
  HTTP status code.

  Example: 400
• title(required): string
  A short, human-readable summary of the problem type.

  Example: VALIDATION ERROR
• type(required): string
  A URI reference that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".

  Example: http://www.abc.org/xyz.html

{
    "description":"Response body when the request returns an error.\n",
    "type":"object",
    "required":[
        "o:errorCode",
        "detail",
        "status",
        "type",
        "title",
        "errorDetails"
    ],
    "properties":{
        "o:errorCode":{
            "description":"Error code of the problem",
            "type":"integer",
            "example":55223
        },
        "detail":{
            "description":"A short, human-readable summary of the problem.",
            "type":"string",
            "example":"Specified Data is invalid"
        },
        "status":{
            "description":"HTTP status code.",
            "type":"integer",
            "example":400
        },
        "type":{
            "description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\".",
            "type":"string",
            "example":"http://www.abc.org/xyz.html"
        },
        "title":{
            "description":"A short, human-readable summary of the problem type.",
            "type":"string",
            "example":"VALIDATION ERROR"
        },
        "errorDetails":{
            "description":"A human-readable explanation specific to this occurrence of the problem.",
            "type":"string",
            "example":"Entity Does Not Exist"
        }
    }
}

Back to Top