Add Discounts
post
/config/sim/v2/sales/discounts
Add the Discount object to a specified hierarchy unit .
Request
Supported Media Types
- application/json
- multipart/form-data
Header Parameters
-
Simphony-AuditTrailRef: string
Detail that identifies, who made the change.
Discount object of the organization
Root Schema : DiscountCURequestBodyv2
Type:
objectModel for Discount Object
Show Source
-
activationType:
integer
Type of Discount ; 0 ??? Manual (Manually Entered and applied);1 ??? Automatic (Automatically applied and operator cannot enter);2 ??? Coupon (Automatically applied, operator must enter)Example:
1 -
autoRule:
object autoRule
Determine how Simphony calculates a discount
-
condimentDiscountability:
integer
Determine how condiment menu items are discounted;0 ??? Use Menu Item ClassOption;1 ??? Parent Items only;2 ??? Condiment Items only;3 ??? Parent and Highlighted Condiment Items;4 ??? Parent and all Condiment Items;5 ??? Single CondimentExample:
1 -
consumerDisplayname:
object consumerDisplayname
A group of string objects representing the name of the Discounts in configured languages
-
dataExtensions:
array dataExtensions
An array of data extensions
-
dscItmzr:
string
A string value of 0s & 1s of length 15 representing the enablement or disablement of the discount itemizers on which the discount is computableExample:
000000000000000 -
effectivity:
object effectivity
An object representing the effective dates for the record
-
effGrpObjNum:
integer
Object number of the Effectivity Group for the current recordExample:
1 -
enabled:
boolean
A Boolean flag indicating to enabling the DiscountExample:
false -
exclusivity:
object exclusivity
Exclusivity stops all discounts from applying to a check at once. Discount exclusivity controls how multiple discounts interact with each other.
-
externalReference1:
string
An alpha-numeric string containing a reference to an external system value. Maximum length of the string can be 32Example:
ExternalReference1 -
externalReference2:
string
An alpha-numeric string containing a reference to an external system value. Maximum length of the string can be 32Example:
ExternalReference2 -
hierUnitId(required):
integer
Unique reference of the hierarchy unit of the propertyExample:
1 -
mainLevelPopup:
integer
The Main Level that activates after pressing the discountExample:
1 -
maxAmount:
integer
Maximum amount allowed for an open-priced or amount discountExample:
1 - menuLevels: object menuLevels
-
minAmount:
integer
Minimum menu item subtotal amountExample:
1 -
name(required):
object name
A group of string objects representing the name of the Discounts in configured languages
-
nlu:
integer
A unique Number Lookup (0-9,999,999,999) for the discountExample:
1 -
objectNum(required):
integer
Object number of the DiscountExample:
1 -
options(required):
string
A String of Values of 0s and 1s of length 56 representing the enablement or disablement of the options associated with DiscountsExample:
00000000000000000000000000000000000000000000000000000000 -
orderChannelRestrictions:
array orderChannelRestrictions
The order channels that are considered for the discount. Each objectNum belongs to a particular order channel.
-
orderTypeRestrictions:
string
A string of values of 0s and 1s of length 32 representing ordertypes from 1 to 32, with a value of 1 indicating respected order type is included and 0 indicating exclusion.Example:
11100000000000000000000000000000 -
percent:
integer
Percentage for the manual discount. Value must lie between 0 and 1.Example:
1 -
printClassObjNum:
integer
Print Class for the DiscountExample:
1 -
privilegeGroup:
integer
Privilege Group number to restrict the use of the discountExample:
1 -
reportGroupObjnum:
integer
Report Group to associate with the discount.Example:
1 -
rvcType:
string
A string value of 0s & 1s of length 32 to configure the availability of the Discount in an RVCExample:
00000000000000000000000000000000 -
sluObjNum:
integer
Object number of the Screen Lookup key for the discount.Example:
1 -
subLevelPopup:
integer
The Main Level that activates after pressing the discountExample:
1 -
taxClassObjNum:
integer
Tax Class to be DiscountedExample:
1 -
transDefaultMainLevel:
boolean
A Boolean flag indicating to return the transaction to the default Main Level after pressing the discountExample:
false -
transDefaultSubLevel:
boolean
A Boolean flag indicating to return the transaction to the default Sub Level after pressing the discount.Example:
false -
triggerCondimentGrpObjNum:
integer
Condiment Menu Item Group to use as the trigger for the discount.Example:
1 -
triggerMIGrpObjNum:
integer
Menu Item Group that triggers the discount.Example:
1
Nested Schema : autoRule
Type:
objectDetermine how Simphony calculates a discount
Show Source
-
allowAwardOfHigherPricedTriggerItem:
boolean
A Boolean flag indicating to allow award of a higher priced trigger item if the trigger item is also an award item. Applicable only for autoRuleType ??? 2 and 3Example:
false -
autoRuleType:
integer
The types of Automatic Discounts rule;0 ??? Not Active;1 - Item Price Substitution;2 - Quantity Threshold;3 - Total Price Threshold;4 - Combination Pricing;5 - Sales PriceExample:
1 -
awardAlgorithm:
integer
The award algorithm to be used in the discount.;1- Best Deal for Customer to apply the highest discount amount to the check;2 - Best Deal for Merchant to apply the lowest discount amount to the checkExample:
1 -
awardGroups:
array awardGroups
An array of award groups for the discount
-
constraintType:
integer
The types of Discounts Constraints;1-No Constraint, 2-Menu Item,3-Major Group,4-Family Group, Applicable only for autoRuleType 2 and 3.Example:
1 -
maxCountPerCheck:
integer
The maximum number of times the coupon discount can be entered on a check. Enter 0 for unlimited entriesExample:
1 -
priority:
integer
The order in which the POS client calculates discounts. Applicable only for autoRuleType 1-4Example:
1 -
triggerGroups:
array triggerGroups
Menu Item Group to trigger the discount award.
-
usePriceInMIGroupDetail:
boolean
A Boolean flag indicating to use the Menu Item Groups promotion price for the discounted menu item. Does not function with Combination Pricing Discounts. Applicable only for autoRuleType ??? 1,2,3 and 5Example:
false
Nested Schema : consumerDisplayname
Type:
objectA group of string objects representing the name of the Discounts in configured languages
Example:
{
"1":"Enterprise",
"2":"Unternehmen",
"3":"Empresa"
}Nested Schema : effectivity
Type:
objectAn object representing the effective dates for the record
Show Source
-
activeEndTime:
string
Enter the effective end time for the recordExample:
22:00 -
activeStartTime:
string
Enter the effective start time for the recordExample:
09:00 -
endDateTime:
string
Enter the effective end date for the recordExample:
2022-09-21T23:59:59 -
recurrenceDayOfWeek:
string
Select the recurrence effective day of the week(Monday ??? Sunday) for the recordExample:
1111111 -
startDateTime:
string
The effective start date for the record.Example:
2021-09-22T00:00:00
Nested Schema : exclusivity
Type:
objectExclusivity stops all discounts from applying to a check at once. Discount exclusivity controls how multiple discounts interact with each other.
Show Source
-
item:
string
A string value of 0s & 1s of length 32 representing the enablement or disablement of the discount on specific menu itemsExample:
00000000000000000000000000000000 -
transaction:
string
A string value of 0s & 1s of length 32 representing the enablement or disablement of the discount on transactionsExample:
00000000000000000000000000000000
Nested Schema : name
Type:
objectA group of string objects representing the name of the Discounts in configured languages
Example:
{
"1":"Enterprise",
"2":"Unternehmen",
"3":"Empresa"
}Nested Schema : orderChannelRestrictions
Type:
arrayThe order channels that are considered for the discount. Each objectNum belongs to a particular order channel.
Show Source
Nested Schema : triggerGroups
Type:
arrayMenu Item Group to trigger the discount award.
Show Source
Nested Schema : items
Type:
Show Source
object-
amountOff:
number
The discount amount for flat amount-based discount. Applicable only for awardType ??? 2Example:
1 -
amountSubstitution:
number
The price to charge for each item in the Trigger Menu Item Group. Applicable only for awardType ??? 3Example:
1 -
awardCount:
number
The maximum number of items discounted after reaching the Trigger MI Group's Minimum QuantityExample:
1 -
awardMIGroupObjNum:
integer
Object number of the menu item group that is to be discounted. Applicable only for autoRuleType ??? 2 and 3Example:
1 -
awardType:
integer
Type of the award;0 ??? None;1 ??? Percent Off;2 ??? Amount Off;3 ??? Amount SubstitutionExample:
1 -
maxCount:
number
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 -
percentOff:
integer
The percentage of the percent-based discount. Applicable only for awardType 1. Value must lie between 0 and 1. For Example 15% will be 0.15 in the 200 response body.Example:
1 -
sequenceNum:
integer
The sequence number of the award groupExample:
1
Nested Schema : items
Type:
Show Source
object-
minimumQuantity:
integer
Object number of the DiscountExample:
1 -
sequenceNum:
integer
Sequence Number of the Menu Item GroupExample:
1 -
total:
number
Object number of the DiscountExample:
1 -
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
Nested Schema : items
Type:
Show Source
object-
columnName:
string
Name of the extension fieldExample:
extension column 1 -
value:
string
Value of the extension fieldExample:
Value1
Nested Schema : items
Type:
Show Source
object-
objectNum(required):
integer
object number of a particular order channelExample:
1
Response
Supported Media Types
- application/json
200 Response
Discount object of the organization
Root Schema : DiscountResponse
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 Discount.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