Add Menu Item Group Details
post
/config/sim/v1/menuItems/menuItemGroups/details
Request
Supported Media Types
- application/json
- multipart/form-data
Header Parameters
-
Simphony-AuditTrailRef: string
Detail that identifies, who made the change.
A Request body for Menu Item Group
Root Schema : schema
Type:
Show Source
object
-
endObjNum:
integer
Ending object number for the selected typeExample:
100
-
exclude(required):
boolean
Identifies which menu items to exclude for Group Type of 1-Discount. For Group Type 2-Tax Override, this parameter is not activeExample:
false
-
hierUnitId(required):
integer
Unique hierarchy unit referenceExample:
2
- menuItemGroupObjNum(required): integer
-
overridePricePercent:
number
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
-
seq(required):
integer
Sequence number of the Menu Item Group Detail entry. Value must lie between 1 and 32767.Example:
1
-
startObjNum:
integer
Starting object number for the selected typeExample:
1
-
type:
integer
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
Response
Supported Media Types
- application/json
200 Response
Menu Item Group Details Added.
Root Schema : MenuItemGroupDetailResponsev1
Type:
Show Source
object
-
endObjNum:
integer
Ending object number for the selected typeExample:
100
-
exclude:
boolean
Identifies which menu items to exclude for Group Type of 1-Discount. For Group Type 2-Tax Override, this parameter is not activeExample:
false
-
hierUnitId:
integer
Unique hierarchy unit referenceExample:
2
-
hierUnitName:
object hierUnitName
A group of string objects representing the name of the hierarchy unit configured languages
-
hierUnitObjNum:
integer
Object number of the hierarchy unitExample:
1
- menuItemGroupObjNum: integer
-
overridePricePercent:
number
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
-
seq:
integer
Sequence number of the Menu Item Group Detail entry. Value must lie between 1 and 32767.Example:
1
-
startObjNum:
integer
Starting object number for the selected typeExample:
1
-
type:
integer
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"
}