Jump to

• Request
• Response

Update Discount Trigger Groups

post

/config/sim/v1/sales/discounts/updatetriggergroups

Updates the Discount Trigger Group. If Discount Trigger Group is not found, it creates a new Discount Trigger Group

Request

Supported Media Types

• application/json
• multipart/form-data

Header Parameters

• Simphony-AuditTrailRef: string
  Detail that identifies, who made the change.

Body ()

Discount Trigger Group object of the organization

Root Schema : schema

Type: object

Model for Discount Trigger Groups Object

Show Source

• effGrpObjNum: integer
  ObjectNumber of Effectivity Group

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

  Example: 1
• minimumQuantity: integer
  The minimum number of items that must be ordered from the Trigger Menu Item Group before the discount is applied to the check. Applicable only for autoRuleType 1 and 2

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

  Example: 1
• sequenceNum(required): integer
  Sequence Number of the discount trigger group

  Example: 1
• total: number
  The total amount of Trigger Menu Item Group Items that must ordered to activate the Award Menu Item Group. Applicable only for autoRuleType 3

  Example: 1.23
• triggerCondimentGroupObjNum: integer
  Object number of the Condiment Menu Item Group to use as the trigger for the discount

  Example: 1
• triggerMIGroupObjNum(required): integer
  Object number of the Menu Item Group to trigger the discount award.

  Example: 1

{
    "description":"Model for Discount Trigger Groups Object",
    "type":"object",
    "required":[
        "hierUnitId",
        "objectNum",
        "sequenceNum",
        "triggerMIGroupObjNum"
    ],
    "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":"ObjectNumber of Effectivity Group",
            "type":"integer",
            "example":1
        },
        "sequenceNum":{
            "description":"Sequence Number of the discount trigger group",
            "type":"integer",
            "example":1
        },
        "triggerMIGroupObjNum":{
            "description":"Object number of the Menu Item Group to trigger the discount award.",
            "type":"integer",
            "example":1
        },
        "triggerCondimentGroupObjNum":{
            "description":"Object number of the Condiment Menu Item Group to use as the trigger for the discount",
            "type":"integer",
            "example":1
        },
        "minimumQuantity":{
            "description":"The minimum number of items that must be ordered from the Trigger Menu Item Group before the discount is applied to the check. Applicable only for autoRuleType 1 and 2",
            "type":"integer",
            "example":1
        },
        "total":{
            "description":"The total amount of Trigger Menu Item Group Items that must ordered to activate the Award Menu Item Group. Applicable only for autoRuleType 3",
            "type":"number",
            "example":1.23
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Discount trigger group Updated or Added.

Body ()

Root Schema : DiscountTriggerGrpsResponse

Type: object

Show Source

• effGrpObjNum: integer
  ObjectNumber of Effectivity Group

  Example: 1
• hierUnitId: integer
  Unique Hierarchy Unit Value

  Example: 1
• objectNum: integer
  Object Number of the Discount.

  Example: 1
• sequenceNum: integer
  Sequence Number of the discount trigger group

  Example: 1

{
    "type":"object",
    "properties":{
        "hierUnitId":{
            "description":"Unique Hierarchy Unit Value",
            "type":"integer",
            "example":1
        },
        "objectNum":{
            "description":"Object Number of the Discount.",
            "type":"integer",
            "example":1
        },
        "effGrpObjNum":{
            "description":"ObjectNumber of Effectivity Group",
            "type":"integer",
            "example":1
        },
        "sequenceNum":{
            "description":"Sequence Number of the discount trigger group",
            "type":"integer",
            "example":1
        }
    }
}

Back to Top