Get Discount Trigger Groups
post
/config/sim/v2/sales/discounts/getTriggerGroups
Gets all the trigger groups for the specified Discount configured for the specified
Request
Supported Media Types
- application/json
- multipart/form-data
A request body
Root Schema : schema
Type:
objectThe input Body model that needs to be given.
Show Source
-
effGrpObjNum:
integer
ObjectNumber of Effectivity GroupExample:
1 -
hierUnitId(required):
integer
Unique reference of the hierarchy unit of the propertyExample:
1 -
include:
string
If specified, limits the data returned to these fields.Example:
hierUnitId, objectNum, name -
includeAll:
string
If this value is specified, the include parameter is ignored.
Value Description basic Forces the response to include all fields except option string details detailed Forces the response to include all fields including option string details Example:detailed -
langIds:
string
If specified, limits translated strings returnedExample:
1,2,3 -
limit:
integer
If using paging, number of results returned in this page.Example:
100 -
objectNum(required):
integer
Object number of the DiscountExample:
1 -
offset:
integer
Starting resource record index. Not required if paging parameters are not supportedExample:
0 -
orderBy:
string
Sorts the response by the specified field name and sort order.Example:
hierUnitId:asc -
searchCriteria:
string
If specified, returns records that match the criteria.Example:
where equals(hierUnitId, 7)
Response
Supported Media Types
- application/json
200 Response
A collection of Discount Trigger Groups.
Root Schema : schema
Type:
Show Source
object-
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 Discount Trigger Group objects of the organization.
-
limit:
integer
Server page sizeExample:
10 -
offset:
integer
Starting resource record indexExample:
0 -
totalResults:
integer
Total number of rows (excluding the paging parameters)Example:
100
Nested Schema : items
Type:
arrayArray of Discount Trigger Group objects of the organization.
Show Source
-
Array of:
object DiscountTriggerGroupv2
Model for Discount Trigger Groups Object
Nested Schema : DiscountTriggerGroupv2
Type:
objectModel for Discount Trigger Groups Object
Show Source
-
effGrpObjNum:
integer
ObjectNumber of Effectivity GroupExample:
1 -
hierUnitId:
integer
Unique reference of the hierarchy unit of the propertyExample:
1 -
hierUnitObjNum:
integer
Object number of the hierarchy unitExample:
1 -
minimumQuantity:
integer
The minimum number of items that must be ordered from the Trigger Menu Item Group before the discount is applied to the check. Applicable only for autoRuleType 1 and 2Example:
1 -
objectNum:
integer
Object number of the DiscountExample:
1 -
sequenceNum:
integer
Sequence Number of the Menu Item GroupExample:
1 -
total:
number
The total amount of Trigger Menu Item Group Items that must ordered to activate the Award Menu Item Group. Applicable only for autoRuleType 3Example:
1.23 -
triggerCondimentGroupObjNum:
integer
Object number of the Condiment Menu Item Group to use as the trigger for the discountExample:
1 -
triggerMIGroupObjNum:
integer
Object number of the Menu Item Group to trigger the discount award.Example:
1