Update Discount Award Groups
post
/config/sim/v2/sales/discounts/updateAwardGroups
Updates the Discount Award Group. If Discount Award Group is not found, it creates a new Discount Award Group
Request
Supported Media Types
- application/json
- multipart/form-data
Header Parameters
-
Simphony-AuditTrailRef: string
Detail that identifies, who made the change.
DiscountAwardGrps object of the organization
Root Schema : DiscountAwardGrpsCURequestBody
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 -
awardMIGroupObjNum(required):
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(required):
integer
Unique reference of the hierarchy unit of the propertyExample:
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(required):
integer
Object number of the DiscountExample:
1 -
percentOff:
number
The percentage of the percent-based discount. Applicable only for awardType ??? 1Example:
1.55 -
sequenceNum(required):
integer
Sequence Number of the Menu Item GroupExample:
1
Response
Supported Media Types
- application/json
200 Response
DiscountAwardGrps object of the organization
Root Schema : DiscountAwardGrpsResponse
Type:
Show Source
object-
effGrpObjNum(required):
integer
ObjectNumber of Effectivity GroupExample:
1 -
hierUnitId(required):
integer
Unique Hierarchy Unit ValueExample:
1 -
objectNum(required):
integer
Object Number of the revenue center.Example:
1 -
sequenceNum(required):
integer
Sequence Number of the discount award groupExample:
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