Get Menu Item Group Details

post

/config/sim/v1/menuItems/MenuItemGroups/getDetails

Request

Supported Media Types
Body ()
The input Body model that needs to be given.
Root Schema : schema
Type: object
Show Source
  • Objects included in the response.
    Example: hierUnitId
  • This can take 2 values: basic or detailed. If 'basic' is specified, The response contains all the properties of the object except Ext values. If 'detailed' is specified, The response contains all the properties of the object.
    Example: detailed
  • If specified, limits the translated strings returned.
    Example: en-US, es-ES, es-MX
  • If using paging, number of results returned in this page.
    Example: 0
  • Starting resource record index. Not required if paging parameters are not supported.
    Example: 0
  • Sorts the response by the specified field name and sort order.
    Example: objectNum:asc
  • Search criteria to filter results based on field value.
    Example: where equals(objectNum,1)
Back to Top

Response

Supported Media Types

200 Response

A Collection of Menu Item Group Details.
Body ()
Root Schema : MenuItemGroupDetailGetResponsev1
Type: object
Show Source
Nested Schema : items
Type: array
Array of Menu Item Group Detail objects of the organization.
Show Source
Nested Schema : MenuItemGroupDetailResponsev1
Type: object
Show Source
  • Ending object number for the selected type
    Example: 100
  • Identifies which menu items to exclude for Group Type of 1-Discount. For Group Type 2-Tax Override, this parameter is not active
    Example: false
  • Unique hierarchy unit reference
    Example: 2
  • hierUnitName
    A group of string objects representing the name of the hierarchy unit configured languages
  • Object number of the hierarchy unit
    Example: 1
  • Menu item group object number
    Example: 1
  • Indicates the amount off, percent off, or amount substitution based on the discount configuration. This is only active for Group Type 1- Discount when exclude is set to false.
    Example: 10.5
  • Sequence number of the Menu Item Group Detail entry. Value must lie between 1 and 32767.
    Example: 1
  • Starting object number for the selected type
    Example: 1
  • Group type to include or exclude for the Menu Item Group Detail entry **Below is a list of accetable values for this field** | # | Type Description| |---------------|-----------------| | 0 | None | | 1 | All | | 2 | By Major Group | | 3 | By Family Group | | 4 | By Menu Item |
    Example: 1
Nested Schema : hierUnitName
Type: object
A group of string objects representing the name of the hierarchy unit configured languages
Example:
{
    "en-US":"Enterprise",
    "de-DE":"Unternehmen",
    "es-MX":"Empresa"
}
Back to Top