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
Header Parameters
Body ()
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: object
Model for the Discount upsert request.
Show Source
  • Minimum Value: 0
    Maximum Value: 2
    Type 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
    Configuration that determines how Simphony calculates an automatic Discount. Omitted fields in this object retain their current values during an update.
  • 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
    A group of string objects representing the consumer-facing name of the Discount in configured languages.
  • dataExtensions
    Data extensions for the Discount.
  • Minimum Length: 0
    Maximum Length: 15
    A string of up to 15 binary characters representing the Discount Itemizers on which the Discount is computable.
    Example: 000000000000000
  • effectivity
    Effective dates and times for the Discount.
  • 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
  • Indicates whether the Discount is enabled.
    Example: true
  • exclusivity
    Controls how this Discount interacts with other Discounts on a check.
  • Maximum Length: 32
    Alphanumeric reference to an external system. Maximum length is 32 characters.
    Example: ExternalReference1
  • Maximum Length: 32
    Alphanumeric reference to an external system. Maximum length is 32 characters.
    Example: ExternalReference2
  • Unique reference of the hierarchy unit of the property.
    Example: 1
  • Minimum Value: 0
    Maximum Value: 8
    Main level that becomes active after applying the Discount.
    Example: 1
  • Maximum amount allowed for an open-priced or amount Discount.
    Example: 25.5
  • menuLevels
    Menu levels on which the Discount is active.
  • Minimum menu item subtotal amount.
    Example: 1.25
  • name
    A group of string objects representing the name of the Discount in configured languages. Required when the upsert adds a new Discount.
  • Minimum Value: 0
    Maximum Value: 9999999999
    Unique Number Lookup for the Discount. Valid range is 0 to 9,999,999,999.
    Example: 1
  • Object number of the Discount. Together with hierUnitId and effGrpObjNum, identifies the Discount to update.
    Example: 1
  • Minimum Length: 56
    Maximum Length: 56
    A 56-character string of 0s and 1s representing the options associated with the Discount.
    Example: 00000000000000000000000000000000000000000000000000000000
  • orderChannelRestrictions
    Order Channels considered for the Discount. Omitting this field during an update retains the current restrictions; supplying an empty array clears them.
  • Minimum Length: 32
    Maximum Length: 32
    A 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
  • Minimum Value: 0
    Maximum Value: 1
    Percentage for the manual discount. Valid range is 0 to 1.
    Example: 0.15
  • Object number of the Print Class for the Discount.
    Example: 1
  • Minimum Value: 0
    Maximum Value: 3
    Privilege Group number that restricts use of the Discount.
    Example: 1
  • Object number of the Report Group associated with the Discount.
    Example: 1
  • Minimum Length: 32
    Maximum Length: 32
    A 32-character string of 0s and 1s representing the revenue center types in which the Discount is available.
    Example: 10000000000000000000000000000000
  • Minimum Value: 1
    Object number of the Screen Lookup used for the Discount.
    Example: 1
  • Minimum Value: 0
    Maximum Value: 8
    Sub level that becomes active after applying the Discount.
    Example: 1
  • Object number of the Tax Class to be discounted.
    Example: 1
  • Indicates whether to return the transaction to the default main level after applying the Discount.
    Example: false
  • Indicates whether to return the transaction to the default sub level after applying the Discount.
    Example: false
  • Object number of the Condiment Menu Item Group used as the trigger for the Discount.
    Example: 1
  • Object number of the Menu Item Group that triggers the Discount.
    Example: 1
Nested Schema : autoRule
Type: object
Configuration that determines how Simphony calculates an automatic Discount. Omitted fields in this object retain their current values during an update.
Show Source
  • 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
  • Minimum Value: 0
    Maximum Value: 5
    Type 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
  • Award algorithm; 1 - Best deal for the customer; 2 - Best deal for the merchant.
    Example: 1
  • awardGroups
    Award groups for the Discount.
  • Minimum Value: 1
    Maximum Value: 4
    Type 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
  • Maximum number of times the coupon Discount can be entered on a check. Use 0 for unlimited entries.
    Example: 1
  • Order in which the POS client calculates Discounts. Applicable only when autoRuleType is 1 through 4.
    Example: 1
  • triggerGroups
    Menu Item Groups that trigger the Discount award.
  • 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: object
A 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 : dataExtensions
Type: array
Data extensions for the Discount.
Show Source
Nested Schema : effectivity
Type: object
Effective dates and times for the Discount.
Show Source
Nested Schema : exclusivity
Type: object
Controls how this Discount interacts with other Discounts on a check.
Show Source
  • Minimum Length: 32
    Maximum Length: 32
    A 32-character string of 0s and 1s representing item exclusivity.
    Example: 00000000000000000000000000000000
  • Minimum Length: 32
    Maximum Length: 32
    A 32-character string of 0s and 1s representing transaction exclusivity.
    Example: 00000000000000000000000000000000
Nested Schema : menuLevels
Type: object
Menu levels on which the Discount is active.
Show Source
  • Minimum Length: 8
    Maximum Length: 8
    An 8-character string of 0s and 1s representing the enabled main menu levels.
    Example: 11111111
  • Minimum Length: 8
    Maximum Length: 8
    An 8-character string of 0s and 1s representing the enabled sub menu levels.
    Example: 11111111
Nested Schema : name
Type: object
A 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: array
Order 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 : awardGroups
Type: array
Award groups for the Discount.
Show Source
Nested Schema : triggerGroups
Type: array
Menu Item Groups that trigger the Discount award.
Show Source
Nested Schema : items
Type: object
Show Source
  • Discount amount for a flat amount-based award. Applicable only when awardType is 2.
    Example: 1
  • Price charged for each item in the trigger Menu Item Group. Applicable only when awardType is 3.
    Example: 1
  • Maximum number of items discounted after reaching the trigger Menu Item Group minimum quantity.
    Example: 1
  • Object number of the Menu Item Group to discount. Applicable only when autoRuleType is 2 or 3.
    Example: 1
  • Minimum Value: 0
    Maximum Value: 3
    Type of award; 0 - None; 1 - Percent off; 2 - Amount off; 3 - Amount substitution.
    Example: 1
  • Maximum number of Discounts that can be applied to one check when Simple Transaction Exclusivity is enabled.
    Example: 1
  • Minimum Value: 0
    Maximum Value: 1
    Percentage of a percent-based award. Applicable only when awardType is 1. Valid range is 0 to 1.
    Example: 0.15
  • Sequence number of the award group.
    Example: 1
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Nested Schema : items
Type: object
Show Source
Back to Top

Response

Supported Media Types

200 Response

Discount entity Updated.
Body ()
Root Schema : schema
Type: object
Show Source

201 Response

Discount entity Added.
Body ()
Root Schema : schema
Type: object
Show Source
Back to Top