Show Source

• count: integer
  Current response record count.

  Example: 9
• hasMore: boolean
  Flag indicating if there are more objects to fetch.

  Example: true
• items: array items
  Array of Menu Item Groups
• limit: integer
  Server page size

  Example: 10
• offset: integer
  Starting resource record index

  Example: 0
• totalResults: integer
  Total number of rows (excluding the paging parameters)

  Example: 100

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "example":100,
            "description":"Total number of rows (excluding the paging parameters)"
        },
        "hasMore":{
            "type":"boolean",
            "example":true,
            "description":"Flag indicating if there are more objects to fetch."
        },
        "count":{
            "type":"integer",
            "example":9,
            "description":"Current response record count."
        },
        "items":{
            "type":"array",
            "description":"Array of Menu Item Groups",
            "items":{
                "type":"object",
                "properties":{
                    "objectNum":{
                        "type":"integer",
                        "example":1,
                        "description":"Menu item group object number"
                    },
                    "hierUnitId":{
                        "type":"integer",
                        "example":2,
                        "description":"Unique hierarchy unit reference"
                    },
                    "name":{
                        "type":"object",
                        "description":"A string that contains translations into multiple languages",
                        "example":{
                            "1":"Coffee",
                            "2":"Kaffee",
                            "3":"Cafe"
                        }
                    },
                    "groupType":{
                        "type":"integer",
                        "example":1,
                        "description":"Group Type Values <table border=\"1\"> <thead> <tr> <th>Description</th> <th>Value</th> </tr> </thead> <tbody> <tr> <td>Discount</td> <td>1 (Default Value)</td> </tr> <tr> <td>Tax Class</td> <td>2</td> </tr> </tbody> </table>"
                    },
                    "thresholdQty":{
                        "type":"integer",
                        "example":2,
                        "description":"Specifies the threshold quantity for applying overriden tax class <ul> <li>For group type 1, the Threshold Quantity must be either NULL or 0.</li> <li>For group type 2, the Threshold Quantity will use a default value of 1.</li> </ul>"
                    },
                    "taxClassObjNum":{
                        "type":"integer",
                        "example":2,
                        "description":"Specifies the tax class override. <ul> <li>For group type 1, the tax class override must be either NULL or 0.</li> <li>For group type 2, the tax class override is required and cannot be NULL or 0.</li> </ul>"
                    }
                }
            }
        },
        "offset":{
            "type":"integer",
            "example":0,
            "description":"Starting resource record index"
        },
        "limit":{
            "type":"integer",
            "example":10,
            "description":"Server page size"
        }
    }
}

Show Source

• Array of: object items

{
    "type":"array",
    "description":"Array of Menu Item Groups",
    "items":{
        "type":"object",
        "properties":{
            "objectNum":{
                "type":"integer",
                "example":1,
                "description":"Menu item group object number"
            },
            "hierUnitId":{
                "type":"integer",
                "example":2,
                "description":"Unique hierarchy unit reference"
            },
            "name":{
                "type":"object",
                "description":"A string that contains translations into multiple languages",
                "example":{
                    "1":"Coffee",
                    "2":"Kaffee",
                    "3":"Cafe"
                }
            },
            "groupType":{
                "type":"integer",
                "example":1,
                "description":"Group Type Values <table border=\"1\"> <thead> <tr> <th>Description</th> <th>Value</th> </tr> </thead> <tbody> <tr> <td>Discount</td> <td>1 (Default Value)</td> </tr> <tr> <td>Tax Class</td> <td>2</td> </tr> </tbody> </table>"
            },
            "thresholdQty":{
                "type":"integer",
                "example":2,
                "description":"Specifies the threshold quantity for applying overriden tax class <ul> <li>For group type 1, the Threshold Quantity must be either NULL or 0.</li> <li>For group type 2, the Threshold Quantity will use a default value of 1.</li> </ul>"
            },
            "taxClassObjNum":{
                "type":"integer",
                "example":2,
                "description":"Specifies the tax class override. <ul> <li>For group type 1, the tax class override must be either NULL or 0.</li> <li>For group type 2, the tax class override is required and cannot be NULL or 0.</li> </ul>"
            }
        }
    }
}

Show Source

• groupType: integer
  Group Type Values

  Description	Value
  Discount	1 (Default Value)
  Tax Class	2

  Example: 1
• hierUnitId: integer
  Unique hierarchy unit reference

  Example: 2
• name: object name
  A string that contains translations into multiple languages
• objectNum: integer
  Menu item group object number

  Example: 1
• taxClassObjNum: integer
  Specifies the tax class override.

  • For group type 1, the tax class override must be either NULL or 0.
  • For group type 2, the tax class override is required and cannot be NULL or 0.

  Example: 2
• thresholdQty: integer
  Specifies the threshold quantity for applying overriden tax class

  • For group type 1, the Threshold Quantity must be either NULL or 0.
  • For group type 2, the Threshold Quantity will use a default value of 1.

  Example: 2

{
    "type":"object",
    "properties":{
        "objectNum":{
            "type":"integer",
            "example":1,
            "description":"Menu item group object number"
        },
        "hierUnitId":{
            "type":"integer",
            "example":2,
            "description":"Unique hierarchy unit reference"
        },
        "name":{
            "type":"object",
            "description":"A string that contains translations into multiple languages",
            "example":{
                "1":"Coffee",
                "2":"Kaffee",
                "3":"Cafe"
            }
        },
        "groupType":{
            "type":"integer",
            "example":1,
            "description":"Group Type Values <table border=\"1\"> <thead> <tr> <th>Description</th> <th>Value</th> </tr> </thead> <tbody> <tr> <td>Discount</td> <td>1 (Default Value)</td> </tr> <tr> <td>Tax Class</td> <td>2</td> </tr> </tbody> </table>"
        },
        "thresholdQty":{
            "type":"integer",
            "example":2,
            "description":"Specifies the threshold quantity for applying overriden tax class <ul> <li>For group type 1, the Threshold Quantity must be either NULL or 0.</li> <li>For group type 2, the Threshold Quantity will use a default value of 1.</li> </ul>"
        },
        "taxClassObjNum":{
            "type":"integer",
            "example":2,
            "description":"Specifies the tax class override. <ul> <li>For group type 1, the tax class override must be either NULL or 0.</li> <li>For group type 2, the tax class override is required and cannot be NULL or 0.</li> </ul>"
        }
    }
}