Upsert Discounts
post
/config/sim/v2/sales/upsertDiscounts
Updates only the provided fields if the Discount identified by hierUnitId, objectNum, and effGrpObjNum exists; otherwise, adds a new Discount.
Request
Supported Media Types
- multipart/form-data
- application/json
Header Parameters
-
Simphony-AuditTrailRef: string
Detail that identifies, who made the change.
Discount upsert request body. When updating an existing Discount, omitted fields retain their current values. When adding a new Discount, name is required.
Root Schema : schema
Type:
objectModel for the Discount upsert request.
Show Source
-
activationType:
integer
Minimum Value:
0Maximum Value:2Type of Discount; 0 - Manual (manually entered and applied); 1 - Automatic (automatically applied and the operator cannot enter it); 2 - Coupon (automatically applied and the operator must enter it).Example:1 -
autoRule:
object autoRule
Configuration that determines how Simphony calculates an automatic Discount. Omitted fields in this object retain their current values during an update.
-
condimentDiscountability:
integer
Determines how condiment menu items are discounted; 0 - Use Menu Item Class option; 1 - Parent items only; 2 - Condiment items only; 3 - Parent and highlighted condiment items; 4 - Parent and all condiment items; 5 - Single condiment.Example:
1 -
consumerDisplayname:
object consumerDisplayname
A group of string objects representing the consumer-facing name of the Discount in configured languages.
-
dataExtensions:
array dataExtensions
Data extensions for the Discount.
-
dscItmzr:
string
Minimum Length:
0Maximum Length:15A string of up to 15 binary characters representing the Discount Itemizers on which the Discount is computable.Example:000000000000000 -
effectivity:
object effectivity
Effective dates and times for the Discount.
-
effGrpObjNum:
integer
Object number of the Effectivity Group. This is part of the key used to identify the Discount. If omitted or set to 0, the upsert targets a Discount without an Effectivity Group.Example:
1 -
enabled:
boolean
Indicates whether the Discount is enabled.Example:
true -
exclusivity:
object exclusivity
Controls how this Discount interacts with other Discounts on a check.
-
externalReference1:
string
Maximum Length:
32Alphanumeric reference to an external system. Maximum length is 32 characters.Example:ExternalReference1 -
externalReference2:
string
Maximum Length:
32Alphanumeric reference to an external system. Maximum length is 32 characters.Example:ExternalReference2 -
hierUnitId(required):
integer(int64)
Unique reference of the hierarchy unit of the property.Example:
1 -
mainLevelPopup:
integer
Minimum Value:
0Maximum Value:8Main level that becomes active after applying the Discount.Example:1 -
maxAmount:
number(double)
Maximum amount allowed for an open-priced or amount Discount.Example:
25.5 - menuLevels: object menuLevels
-
minAmount:
number(double)
Minimum menu item subtotal amount.Example:
1.25 -
name:
object name
A group of string objects representing the name of the Discount in configured languages. Required when the upsert adds a new Discount.
-
nlu:
integer(int64)
Minimum Value:
0Maximum Value:9999999999Unique Number Lookup for the Discount. Valid range is 0 to 9,999,999,999.Example:1 -
objectNum(required):
integer
Object number of the Discount. Together with hierUnitId and effGrpObjNum, identifies the Discount to update.Example:
1 -
options:
string
Minimum Length:
56Maximum Length:56A 56-character string of 0s and 1s representing the options associated with the Discount.Example:00000000000000000000000000000000000000000000000000000000 -
orderChannelRestrictions:
array orderChannelRestrictions
Order Channels considered for the Discount. Omitting this field during an update retains the current restrictions; supplying an empty array clears them.
-
orderTypeRestrictions:
string
Minimum Length:
32Maximum Length:32A 32-character string of 0s and 1s representing Order Types 1 through 32, where 1 includes the corresponding Order Type and 0 excludes it.Example:11100000000000000000000000000000 -
percent:
number(double)
Minimum Value:
0Maximum Value:1Percentage for the manual discount. Valid range is 0 to 1.Example:0.15 -
printClassObjNum:
integer
Object number of the Print Class for the Discount.Example:
1 -
privilegeGroup:
integer
Minimum Value:
0Maximum Value:3Privilege Group number that restricts use of the Discount.Example:1 -
reportGroupObjNum:
integer
Object number of the Report Group associated with the Discount.Example:
1 -
rvcType:
string
Minimum Length:
32Maximum Length:32A 32-character string of 0s and 1s representing the revenue center types in which the Discount is available.Example:10000000000000000000000000000000 -
sluObjNum:
integer
Minimum Value:
1Object number of the Screen Lookup used for the Discount.Example:1 -
subLevelPopup:
integer
Minimum Value:
0Maximum Value:8Sub level that becomes active after applying the Discount.Example:1 -
taxClassObjNum:
integer
Object number of the Tax Class to be discounted.Example:
1 -
transDefaultMainLevel:
boolean
Indicates whether to return the transaction to the default main level after applying the Discount.Example:
false -
transDefaultSubLevel:
boolean
Indicates whether to return the transaction to the default sub level after applying the Discount.Example:
false -
triggerCondimentGrpObjNum:
integer
Object number of the Condiment Menu Item Group used as the trigger for the Discount.Example:
1 -
triggerMIGrpObjNum:
integer
Object number of the Menu Item Group that triggers the Discount.Example:
1
Nested Schema : autoRule
Type:
objectConfiguration that determines how Simphony calculates an automatic Discount. Omitted fields in this object retain their current values during an update.
Show Source
-
allowAwardOfHigherPricedTriggerItem:
boolean
Indicates whether an award can be a higher-priced trigger item when the trigger item is also an award item. Applicable only when autoRuleType is 2 or 3.Example:
false -
autoRuleType:
integer
Minimum Value:
0Maximum Value:5Type of automatic Discount rule; 0 - Not active; 1 - Item price substitution; 2 - Quantity threshold; 3 - Total price threshold; 4 - Combination pricing; 5 - Sales price.Example:1 -
awardAlgorithm:
integer
Award algorithm; 1 - Best deal for the customer; 2 - Best deal for the merchant.Example:
1 -
awardGroups:
array awardGroups
Award groups for the Discount.
-
constraintType:
integer
Minimum Value:
1Maximum Value:4Type of Discount constraint; 1 - No constraint; 2 - Menu Item; 3 - Major Group; 4 - Family Group. Values 2 through 4 apply only when autoRuleType is 2 or 3.Example:1 -
maxCountPerCheck:
integer
Maximum number of times the coupon Discount can be entered on a check. Use 0 for unlimited entries.Example:
1 -
priority:
integer
Order in which the POS client calculates Discounts. Applicable only when autoRuleType is 1 through 4.Example:
1 -
triggerGroups:
array triggerGroups
Menu Item Groups that trigger the Discount award.
-
usePriceInMIGroupDetail:
boolean
Indicates whether to use the Menu Item Group promotion price for the discounted menu item. Does not apply to Combination Pricing Discounts. Applicable only when autoRuleType is 1, 2, 3, or 5.Example:
false
Nested Schema : consumerDisplayname
Type:
objectA group of string objects representing the consumer-facing name of the Discount in configured languages.
Example:
{
"1":"Enterprise Discount",
"2":"Unternehmensrabatt",
"3":"Descuento empresarial"
}Nested Schema : effectivity
Type:
objectEffective dates and times for the Discount.
Show Source
-
activeEndTime:
string
Effective end time for the Discount.Example:
22:30 -
activeStartTime:
string
Effective start time for the Discount.Example:
08:15 -
endDateTime:
string
Effective end date and time for the Discount.Example:
2026-12-31T22:30:00 -
recurrenceDayOfWeek:
string
Minimum Length:
7Maximum Length:7A 7-character string of 0s and 1s representing the recurring effective days from Monday through Sunday.Example:1111111 -
startDateTime:
string
Effective start date and time for the Discount.Example:
2026-09-07T08:15:00
Nested Schema : exclusivity
Type:
objectControls how this Discount interacts with other Discounts on a check.
Show Source
-
item:
string
Minimum Length:
32Maximum Length:32A 32-character string of 0s and 1s representing item exclusivity.Example:00000000000000000000000000000000 -
transaction:
string
Minimum Length:
32Maximum Length:32A 32-character string of 0s and 1s representing transaction exclusivity.Example:00000000000000000000000000000000
Nested Schema : name
Type:
objectA group of string objects representing the name of the Discount in configured languages. Required when the upsert adds a new Discount.
Example:
{
"1":"Enterprise Discount",
"2":"Unternehmensrabatt",
"3":"Descuento empresarial"
}Nested Schema : orderChannelRestrictions
Type:
arrayOrder Channels considered for the Discount. Omitting this field during an update retains the current restrictions; supplying an empty array clears them.
Show Source
Nested Schema : triggerGroups
Type:
arrayMenu Item Groups that trigger the Discount award.
Show Source
Nested Schema : items
Type:
Show Source
object-
amountOff:
number(double)
Discount amount for a flat amount-based award. Applicable only when awardType is 2.Example:
1 -
amountSubstitution:
number(double)
Price charged for each item in the trigger Menu Item Group. Applicable only when awardType is 3.Example:
1 -
awardCount:
integer
Maximum number of items discounted after reaching the trigger Menu Item Group minimum quantity.Example:
1 -
awardMIGroupObjNum:
integer
Object number of the Menu Item Group to discount. Applicable only when autoRuleType is 2 or 3.Example:
1 -
awardType:
integer
Minimum Value:
0Maximum Value:3Type of award; 0 - None; 1 - Percent off; 2 - Amount off; 3 - Amount substitution.Example:1 -
maxCount:
integer
Maximum number of Discounts that can be applied to one check when Simple Transaction Exclusivity is enabled.Example:
1 -
percentOff:
number(double)
Minimum Value:
0Maximum Value:1Percentage of a percent-based award. Applicable only when awardType is 1. Valid range is 0 to 1.Example:0.15 -
sequenceNum:
integer
Sequence number of the award group.Example:
1
Nested Schema : items
Type:
Show Source
object-
minimumQuantity:
integer
Number of items that must be ordered from the trigger Menu Item Group before applying the Discount award.Example:
1 -
sequenceNum:
integer
Sequence number of the trigger group.Example:
1 -
total:
number(double)
Total amount of items that must be ordered from the trigger Menu Item Group before applying the Discount.Example:
1 -
triggerCondimentGroupObjNum:
integer
Object number of the Condiment Menu Item Group used as the trigger.Example:
1 -
triggerMIGroupObjNum:
integer
Object number of the Menu Item Group that triggers the Discount award.Example:
1
Nested Schema : items
Type:
Show Source
object-
columnName:
string
Name of the extension field.Example:
Discount -
value:
string
Value of the extension field.Example:
123
Nested Schema : items
Type:
Show Source
object-
objectNum(required):
integer
Minimum Value:
1Object number of an Order Channel.Example:1
Response
Supported Media Types
- application/json
200 Response
Discount entity Updated.
Root Schema : schema
Type:
Show Source
object-
effGrpObjNum:
integer
Object Number of the Effectivity Group.Example:
1 -
hierUnitId:
integer
Unique Hierarchy Unit Value.Example:
1 -
objectNum:
integer
Object Number of the Discount.Example:
1
201 Response
Discount entity Added.
Root Schema : schema
Type:
Show Source
object-
effGrpObjNum:
integer
Object Number of the Effectivity Group.Example:
1 -
hierUnitId:
integer
Unique Hierarchy Unit Value.Example:
1 -
objectNum:
integer
Object Number of the Discount.Example:
1