Get Discount Award Groups
post
/config/sim/v2/sales/discounts/getAwardGroups
Gets all the Discount Award Groups
Request
Supported Media Types
- application/json
- multipart/form-data
Header Parameters
-
Simphony-AuditTrailRef: string
Detail that identifies, who made the change.
Discount Award Groups Get Object
Root Schema : schema
Type:
objectThe input Body model that needs to be given.
Show Source
-
effGrpObjNum:
integer
Object Number of the effectivity groupExample:
1 -
hierUnitId(required):
integer
Unique reference of the hierarchy.Example:
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 Award 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 Award 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 Award Group objects of the organization.
Show Source
-
Array of:
object DiscountAwardGrpsResponsev2
Model for Discount Award Groups Object
Nested Schema : DiscountAwardGrpsResponsev2
Type:
objectModel for Discount Award Groups Object
Show Source
-
amountOff:
number
The discount amount for flat amount-based discount. Applicable only for awardType - 2Example:
2.55 -
amountSubstitution:
number
The price to charge for each item in the Trigger Menu Item Group. Applicable only for awardType - 3Example:
1.22 -
awardCount:
integer
The number of award items that are allowed once the Trigger MI Group's Minimum quantity is reached.Example:
1 -
awardMIGroupObjNum:
integer
Object number of the Menu Item Group to trigger the discount award.Example:
1 -
awardType:
integer
Type of the award; 0 - None, 1 - Percent Off, 2 - Amount Off, 3 - Amount SubstitutionExample:
1 -
effGrpObjNum:
integer
Object Number of the effectivity groupExample:
1 -
hierUnitId:
integer
Unique reference of the hierarchy unit of the propertyExample:
1 -
hierUnitObjNum:
integer
Object number of the hierarchy unitExample:
1 -
maxCount:
integer
When Simple Transaction Exclusivity is set for this discount, enter the maximum number of discounts that can be applied to one check. Applicable only for autoRuleType - 1-4Example:
1 -
objectNum:
integer
Object number of the DiscountExample:
1 -
percentOff:
number
The percentage of the percent-based discount. Applicable only for awardType - 1Example:
1.55 -
sequenceNum:
integer
Sequence Number of the Discount Award GroupExample:
1