Jump to

• Request
• Response

Get Discount Trigger Groups

post

/config/sim/v1/sales/discounts/gettriggergroups

Gets all the trigger groups for the specified Discount configured for the specified

Request

Supported Media Types

• application/json
• multipart/form-data

Body ()

A request body

Root Schema : DiscountTriggerGrpsGetRequestBody

Type: object

The input Body model that needs to be given.

Show Source

• effGrpObjNum: integer
  ObjectNumber of Effectivity Group

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

  Example: 1
• include: string
  Objects included in response
• includeAll: string
  This can take 2 values: basic or detailed. If 'basic' is specified, The response contains all the properties of the object except Ext values. If 'detailed' is specified, The response contains all the properties of the object.

  Example: detailed
• languages: string
  If specified, limits translated strings returned
• limit: integer
  If using paging, number of results returned in this page.
• objectNum(required): integer
  Object number of the Discount

  Example: 1
• offset: integer
  Starting resource record index. Not required if paging parameters are not supported
• orderBy: string
  Sorts the response by the specified field name and sort order.
• searchCriteria: string
  Search criteria to filter results based on field value

{
    "description":"The input Body model that needs to be given.",
    "type":"object",
    "required":[
        "hierUnitId",
        "objectNum"
    ],
    "properties":{
        "searchCriteria":{
            "type":"string",
            "description":"Search criteria to filter results based on field value"
        },
        "include":{
            "type":"string",
            "description":"Objects included in response"
        },
        "includeAll":{
            "type":"string",
            "example":"detailed",
            "description":"This can take 2 values: basic or detailed.\nIf 'basic' is specified, The response contains all the properties of the object except <options-string-name>Ext values.\nIf 'detailed' is specified, The response contains all the properties of the object.\n"
        },
        "languages":{
            "type":"string",
            "description":"If specified, limits translated strings returned"
        },
        "offset":{
            "type":"integer",
            "description":"Starting resource record index. Not required if paging parameters are not supported"
        },
        "limit":{
            "type":"integer",
            "description":"If using paging, number of results returned in this page."
        },
        "orderBy":{
            "type":"string",
            "description":"Sorts the response by the specified field name and sort order."
        },
        "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
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

A collection of DiscountTriggerGrps entities in an organization.

Body ()

Root Schema : DiscountTriggerGrpsGetResponse

Type: object

Model for Discount Trigger Groups Object

Show Source

• effGrpObjNum(required): integer
  ObjectNumber of Effectivity Group

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

  Example: 1
• hierUnitName(required): object hierUnitName
  Additional Properties Allowed: additionalProperties

  A group of string objects representing the name of the hierarchy unit configured languages
• hierUnitObjNum(required): integer
  Object number of the hierarchy unit

  Example: 1
• minimumQuantity(required): 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
• name(required): object name
  Additional Properties Allowed: additionalProperties

  A group of string objects representing the name of the Discounts in configured languages
• objectNum(required): integer
  Object number of the Discount

  Example: 1
• sequenceNum(required): integer
  Sequence Number of the Menu Item Group

  Example: 1
• total(required): 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
• triggerCondimentGroupName(required): object triggerCondimentGroupName
  Additional Properties Allowed: additionalProperties

  A group of string objects representing the name of the trigger condiment menu item group in configured languages
• triggerCondimentGroupObjNum(required): integer
  Object number of the Condiment Menu Item Group to use as the trigger for the discount

  Example: 1
• triggerMIGroupName(required): object triggerMIGroupName
  Additional Properties Allowed: additionalProperties

  A group of string objects representing the name of the trigger condiment menu item group in configured languages
• 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",
        "hierUnitObjNum",
        "hierUnitName",
        "objectNum",
        "name",
        "effGrpObjNum",
        "sequenceNum",
        "triggerMIGroupObjNum",
        "triggerMIGroupName",
        "triggerCondimentGroupObjNum",
        "triggerCondimentGroupName",
        "minimumQuantity",
        "total"
    ],
    "properties":{
        "hierUnitId":{
            "description":"Unique reference of the hierarchy unit of the property",
            "type":"integer",
            "example":1
        },
        "hierUnitObjNum":{
            "description":"Object number of the hierarchy unit",
            "type":"integer",
            "example":1
        },
        "hierUnitName":{
            "description":"A group of string objects representing the name of the hierarchy unit configured languages",
            "type":"object",
            "example":{
                "en-US":"Enterprise",
                "de-DE":"Unternehmen",
                "es-MX":"Empresa"
            },
            "additionalProperties":{
                "type":"string"
            }
        },
        "objectNum":{
            "description":"Object number of the Discount",
            "type":"integer",
            "example":1
        },
        "name":{
            "description":"A group of string objects representing the name of the Discounts  in configured languages",
            "type":"object",
            "example":{
                "en-US":"Enterprise",
                "de-DE":"Unternehmen",
                "es-MX":"Empresa"
            },
            "additionalProperties":{
                "type":"string"
            }
        },
        "effGrpObjNum":{
            "description":"ObjectNumber of Effectivity Group",
            "type":"integer",
            "example":1
        },
        "sequenceNum":{
            "description":"Sequence Number of the Menu Item Group",
            "type":"integer",
            "example":1
        },
        "triggerMIGroupObjNum":{
            "description":"Object number of the Menu Item Group to trigger the discount award.",
            "type":"integer",
            "example":1
        },
        "triggerMIGroupName":{
            "description":"A group of string objects representing the name of the trigger condiment menu item group in configured languages",
            "type":"object",
            "example":{
                "en-US":"Enterprise",
                "de-DE":"Unternehmen",
                "es-MX":"Empresa"
            },
            "additionalProperties":{
                "type":"string"
            }
        },
        "triggerCondimentGroupObjNum":{
            "description":"Object number of the Condiment Menu Item Group to use as the trigger for the discount",
            "type":"integer",
            "example":1
        },
        "triggerCondimentGroupName":{
            "description":"A group of string objects representing the name of the trigger condiment menu item group in configured languages",
            "type":"object",
            "example":{
                "en-US":"Enterprise",
                "de-DE":"Unternehmen",
                "es-MX":"Empresa"
            },
            "additionalProperties":{
                "type":"string"
            }
        },
        "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
        }
    }
}

Nested Schema : hierUnitName

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"A group of string objects representing the name of the hierarchy unit configured languages",
    "type":"object",
    "example":{
        "en-US":"Enterprise",
        "de-DE":"Unternehmen",
        "es-MX":"Empresa"
    },
    "additionalProperties":{
        "type":"string"
    }
}

A group of string objects representing the name of the hierarchy unit configured languages

Example:

{
    "en-US":"Enterprise",
    "de-DE":"Unternehmen",
    "es-MX":"Empresa"
}

Nested Schema : name

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"A group of string objects representing the name of the Discounts  in configured languages",
    "type":"object",
    "example":{
        "en-US":"Enterprise",
        "de-DE":"Unternehmen",
        "es-MX":"Empresa"
    },
    "additionalProperties":{
        "type":"string"
    }
}

A group of string objects representing the name of the Discounts in configured languages

Example:

{
    "en-US":"Enterprise",
    "de-DE":"Unternehmen",
    "es-MX":"Empresa"
}

Nested Schema : triggerCondimentGroupName

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"A group of string objects representing the name of the trigger condiment menu item group in configured languages",
    "type":"object",
    "example":{
        "en-US":"Enterprise",
        "de-DE":"Unternehmen",
        "es-MX":"Empresa"
    },
    "additionalProperties":{
        "type":"string"
    }
}

A group of string objects representing the name of the trigger condiment menu item group in configured languages

Example:

{
    "en-US":"Enterprise",
    "de-DE":"Unternehmen",
    "es-MX":"Empresa"
}

Nested Schema : triggerMIGroupName

Type: object

Additional Properties Allowed

Show Source

• string

{
    "description":"A group of string objects representing the name of the trigger condiment menu item group in configured languages",
    "type":"object",
    "example":{
        "en-US":"Enterprise",
        "de-DE":"Unternehmen",
        "es-MX":"Empresa"
    },
    "additionalProperties":{
        "type":"string"
    }
}

A group of string objects representing the name of the trigger condiment menu item group in configured languages

Example:

{
    "en-US":"Enterprise",
    "de-DE":"Unternehmen",
    "es-MX":"Empresa"
}

400 Response

400 Bad Request

Body ()

Root Schema : ErrorDetails

Type: object

Response 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 problem

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

{
    "description":"Response body when the request returns an error.\n",
    "type":"object",
    "required":[
        "o:errorCode",
        "detail",
        "status",
        "type",
        "title",
        "errorDetails"
    ],
    "properties":{
        "o:errorCode":{
            "description":"Error code of the problem",
            "type":"integer",
            "example":55223
        },
        "detail":{
            "description":"A short, human-readable summary of the problem.",
            "type":"string",
            "example":"Specified Data is invalid"
        },
        "status":{
            "description":"HTTP status code.",
            "type":"integer",
            "example":400
        },
        "type":{
            "description":"A URI reference that identifies the problem type. When this member is not present, its value is assumed to be \"about:blank\".",
            "type":"string",
            "example":"http://www.abc.org/xyz.html"
        },
        "title":{
            "description":"A short, human-readable summary of the problem type.",
            "type":"string",
            "example":"VALIDATION ERROR"
        },
        "errorDetails":{
            "description":"A human-readable explanation specific to this occurrence of the problem.",
            "type":"string",
            "example":"Entity Does Not Exist"
        }
    }
}

404 Response

404 Requested resource not found

Back to Top