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 : DiscountTriggerGrpsGetRequestBodyv2
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
Objects included in the response.Example:
hierUnitId -
includeAll:
string
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 -
langIds:
string
If specified, limits the translated strings returned.Example:
1,2,3 -
limit:
integer
If using paging, number of results returned in this page.
-
objectNum(required):
integer
Object number of the DiscountExample:
1 -
offset:
integer
Starting resource record index. Not required if paging parameters are not supported.
-
orderBy:
string
Sorts the response by the specified field name and sort order.Example:
objectNum:asc -
searchCriteria:
string
Search criteria to filter results based on field value.Example:
where equals(objectNum,1)
Response
Supported Media Types
- application/json
200 Response
A collection of DiscountTriggerGrps entities in an organization.
Root Schema : DiscountTriggerGrpsGetResponsev2
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 DiscountTriggerGrpsResponsev2
Model for Discount Trigger Groups Object
Nested Schema : DiscountTriggerGrpsResponsev2
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
400 Response
400 Bad Request
Root Schema : ErrorDetails
Type:
objectResponse body when the request returns an error.
Show Source
-
detail(required):
string
A short, human-readable summary of the problem.Example:
Specified Data is invalid -
errorDetails(required):
string
A human-readable explanation specific to this occurrence of the problem.Example:
Entity Does Not Exist -
o:errorCode(required):
integer
Error code of the problemExample:
55223 -
status(required):
integer
HTTP status code.Example:
400 -
title(required):
string
A short, human-readable summary of the problem type.Example:
VALIDATION ERROR -
type(required):
string
A URI reference that identifies the problem type. When this member is not present, its value is assumed to be "about:blank".Example:
http://www.abc.org/xyz.html
404 Response
404 Requested resource not found