Show Source

• amountOff: number
  The discount amount for flat amount-based discount. Applicable only for awardType - 2

  Example: 2.55
• amountSubstitution: number
  The price to charge for each item in the Trigger Menu Item Group. Applicable only for awardType - 3

  Example: 1.22
• awardCount: integer
  The number of award items that are allowed once the Trigger MI Group's Minimum quantity is reached.

  Example: 1
• 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 Substitution

  Example: 1
• effGrpObjNum: integer
  Object Number of the effectivity group

  Example: 1
• hierUnitId(required): integer
  Unique reference of the hierarchy unit of the property

  Example: 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-4

  Example: 1
• objectNum(required): integer
  Object number of the Discount

  Example: 1
• percentOff: number
  The percentage of the percent-based discount. Applicable only for awardType - 1

  Example: 1.55
• sequenceNum(required): integer
  Sequence Number of the Discount Award Group

  Example: 1

{
    "description":"Model for Discount Award Groups Object",
    "type":"object",
    "required":[
        "hierUnitId",
        "objectNum",
        "sequenceNum",
        "awardMIGroupObjNum"
    ],
    "properties":{
        "hierUnitId":{
            "description":"Unique reference of the hierarchy unit of the property",
            "type":"integer",
            "example":1
        },
        "objectNum":{
            "description":"Object number of the Discount",
            "type":"integer",
            "example":1
        },
        "effGrpObjNum":{
            "description":"Object Number of the effectivity group",
            "type":"integer",
            "example":1
        },
        "sequenceNum":{
            "description":"Sequence Number of the Discount Award Group",
            "type":"integer",
            "example":1
        },
        "awardMIGroupObjNum":{
            "description":"Object number of the Menu Item Group to trigger the discount award.",
            "type":"integer",
            "example":1
        },
        "awardType":{
            "description":"Type of the award; 0 - None, 1 - Percent Off, 2 - Amount Off, 3 - Amount Substitution",
            "type":"integer",
            "example":1
        },
        "percentOff":{
            "description":"The percentage of the percent-based discount. Applicable only for awardType - 1",
            "type":"number",
            "example":1.55
        },
        "amountOff":{
            "description":"The discount amount for flat amount-based discount. Applicable only for awardType - 2",
            "type":"number",
            "example":2.55
        },
        "amountSubstitution":{
            "description":"The price to charge for each item in the Trigger Menu Item Group. Applicable only for awardType - 3",
            "type":"number",
            "example":1.22
        },
        "maxCount":{
            "description":"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-4",
            "type":"integer",
            "example":1
        },
        "awardCount":{
            "description":"The number of award items that are allowed once the Trigger MI Group's Minimum quantity is reached.",
            "type":"integer",
            "example":1
        }
    }
}