Show Source

• condimentItems: array condimentItems
  An array of menu items that are part of the condiment set
• hierUnitId(required): integer
  Unique reference of the hierarchy unit

  Example: 2
• name(required): object name
  name
• objectNum(required): integer
  Object Number of the condiment set

  Example: 1

{
    "type":"object",
    "required":[
        "hierUnitId",
        "objectNum",
        "name"
    ],
    "properties":{
        "hierUnitId":{
            "type":"integer",
            "example":2,
            "description":"Unique reference of the hierarchy unit"
        },
        "objectNum":{
            "type":"integer",
            "example":1,
            "description":"Object Number of the condiment set"
        },
        "name":{
            "type":"object",
            "description":"name",
            "example":{
                "en-US":"Coffee",
                "de-DE":"Kaffee",
                "es-MX":"Cafe"
            }
        },
        "condimentItems":{
            "type":"array",
            "description":"An array of menu items that are part of the condiment set",
            "items":{
                "$ref":"#/definitions/CondimentSet_condimentItemsCUD"
            }
        }
    },
    "description":"CUD Request Body for Condiment Set Object"
}

Show Source

• Array of: object CondimentSet_condimentItemsCUD

{
    "type":"array",
    "description":"An array of menu items that are part of the condiment set",
    "items":{
        "$ref":"#/definitions/CondimentSet_condimentItemsCUD"
    }
}

Show Source

• condimentItemNum: integer
  Sequence number of the condiment item

  Example: 1
• defaultCount: integer
  The number of each condiment that comes with the set. Value must lie between 0 and 99999999.

  Example: 1
• miDefSequence: integer
  The Menu Item definition sequence number of each record. This coincides with the Menu Item Definition that appears in the POS client when the condiment is triggered.

  Example: 0
• miMstrObjNum: integer
  Object number of the menu item master assigned to the condiment item

  Example: 1
• options: string
  A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated with the condiment item

  Example: 00000000
• sortOrder: integer
  The order in which the condiments are displayed on checks, receipts, SLUs, and KDS displays. Value must lie between 0 and 32767.

  Example: 1

{
    "type":"object",
    "properties":{
        "condimentItemNum":{
            "type":"integer",
            "example":1,
            "description":"Sequence number of the condiment item"
        },
        "miMstrObjNum":{
            "type":"integer",
            "example":1,
            "description":"Object number of the menu item master assigned to the condiment item"
        },
        "defaultCount":{
            "type":"integer",
            "example":1,
            "description":"The number of each condiment that comes with the set. Value must lie between 0 and 99999999."
        },
        "sortOrder":{
            "type":"integer",
            "example":1,
            "description":"The order in which the condiments are displayed on checks, receipts, SLUs, and KDS displays. Value must lie between 0 and 32767."
        },
        "options":{
            "type":"string",
            "example":"00000000",
            "description":"A string value of 0s & 1s of length 8 representing the enablement or disablement of the options associated with the condiment item"
        },
        "miDefSequence":{
            "type":"integer",
            "example":0,
            "description":"The Menu Item definition sequence number of each record. This coincides with the Menu Item Definition that appears in the POS client when the condiment is triggered."
        }
    }
}