Get Discount Award Groups
post
/config/sim/v1/sales/discounts/getawardgroups
Gets all the award groups for the specified Discount configured for the specified
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 : DiscountAwardGrpsBody
Type:
objectThe input Body model that needs to be given.
Show Source
-
effGrpObjNum:
integer
Object Number of the effectivity group
-
hierUnitId(required):
integer
Unique reference of the hierarchy.
-
include:
string
Objects included in response
-
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 -
languages:
string
If specified, limits translated strings returned
-
limit:
integer
If using paging, number of results returned in this page.
-
objectNum(required):
integer
Object Number of the discount
-
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.
-
searchCriteria:
string
Search criteria to filter results based on field value
Response
Supported Media Types
- application/json
200 Response
A collection of DiscountAwardGrps entities in an organization.
Root Schema : DiscountAwardGrpsGetResponse
Type:
objectModel for Discount Award Groups Object
Show Source
-
amountOff(required):
number
The discount amount for flat amount-based discount. Applicable only for awardType ??? 2Example:
2.55 -
amountSubstitution(required):
number
The price to charge for each item in the Trigger Menu Item Group. Applicable only for awardType ??? 3Example:
1.22 -
awardMIGroupName(required):
object awardMIGroupName
Additional Properties Allowed: additionalPropertiesA group of string objects representing the name of the trigger condiment menu item group in configured languages
-
awardMIGroupObjNum(required):
integer
Object number of the Menu Item Group to trigger the discount award.Example:
1 -
awardType(required):
integer
Type of the award; 0 ??? None, 1 ??? Percent Off, 2 ??? Amount Off, 3 ??? Amount SubstitutionExample:
1 -
effGrpObjNum(required):
integer
Object Number of the effectivity groupExample:
1 -
hierUnitId(required):
integer
Unique reference of the hierarchy unit of the propertyExample:
1 -
hierUnitName(required):
object hierUnitName
Additional Properties Allowed: additionalPropertiesA group of string objects representing the name of the hierarchy unit configured languages
-
hierUnitObjNum(required):
integer
Object number of the hierarchy unitExample:
1 -
maxCount(required):
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 -
name(required):
object name
Additional Properties Allowed: additionalPropertiesA group of string objects representing the name of the Discounts in configured languages
-
objectNum(required):
integer
Object number of the DiscountExample:
1 -
percentOff(required):
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
Nested Schema : awardMIGroupName
Type:
objectAdditional Properties Allowed
Show Source
A group of string objects representing the name of the trigger condiment menu item group in configured languages
Example:
{
"en-US":"Enterprise",
"de-DE":"Unternehmen",
"es-MX":"Empresa"
}Nested Schema : hierUnitName
Type:
objectAdditional Properties Allowed
Show Source
A group of string objects representing the name of the hierarchy unit configured languages
Example:
{
"en-US":"Enterprise",
"de-DE":"Unternehmen",
"es-MX":"Empresa"
}Nested Schema : name
Type:
objectAdditional Properties Allowed
Show Source
A group of string objects representing the name of the Discounts in configured languages
Example:
{
"en-US":"Enterprise",
"de-DE":"Unternehmen",
"es-MX":"Empresa"
}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