Configuration and Content API Guide

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

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

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

Example: en-US, de-DE, es-MX
limit: integer

If using paging, number of results returned in this page.

Example: 10
objectNum(required): integer

Object number of the Discount

Example: 1
offset: integer

Starting resource record index. Not required if paging parameters are not supported

Example: 0
orderBy: string

Sorts the response by the specified field name and sort order.

Example: objectNum:asc
searchCriteria: string

Search criteria to filter results based on field value

Example: where equals(objectNum,1)

{
    "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",
            "example":"where equals(objectNum,1)"
        },
        "include":{
            "type":"string",
            "description":"Objects included in response",
            "example":"hierUnitId"
        },
        "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",
            "example":"en-US, de-DE, es-MX"
        },
        "offset":{
            "type":"integer",
            "description":"Starting resource record index. Not required if paging parameters are not supported",
            "example":0
        },
        "limit":{
            "type":"integer",
            "description":"If using paging, number of results returned in this page.",
            "example":10
        },
        "orderBy":{
            "type":"string",
            "description":"Sorts the response by the specified field name and sort order.",
            "example":"objectNum:asc"
        },
        "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
        }
    }
}

Response

Supported Media Types

application/json

200 Response

A collection of DiscountTriggerGrps entities in an organization.

Root Schema : DiscountTriggerGrpsGetResponsev1

Type: object

Show Source

count: integer

Current response record count.

Example: 9
hasMore: boolean

Flag indicating if there are more objects to fetch.

Example: true
items: array items

Array of Discount Trigger Group objects of the organization.
limit: integer

Server page size

Example: 10
offset: integer

Starting resource record index

Example: 0
totalResults: integer

Total number of rows (excluding the paging parameters)

Example: 100

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "example":100,
            "description":"Total number of rows (excluding the paging parameters)"
        },
        "hasMore":{
            "type":"boolean",
            "example":true,
            "description":"Flag indicating if there are more objects to fetch."
        },
        "count":{
            "type":"integer",
            "example":9,
            "description":"Current response record count."
        },
        "items":{
            "type":"array",
            "description":"Array of Discount Trigger Group objects of the organization.",
            "items":{
                "$ref":"#/definitions/DiscountTriggerGrpsResponsev1"
            }
        },
        "offset":{
            "type":"integer",
            "example":0,
            "description":"Starting resource record index"
        },
        "limit":{
            "type":"integer",
            "example":10,
            "description":"Server page size"
        }
    }
}

Nested Schema : items

Type: array

Array of Discount Trigger Group objects of the organization.

Show Source

Array of: object DiscountTriggerGrpsResponsev1

Model for Discount Trigger Groups Object

{
    "type":"array",
    "description":"Array of Discount Trigger Group objects of the organization.",
    "items":{
        "$ref":"#/definitions/DiscountTriggerGrpsResponsev1"
    }
}

Nested Schema : DiscountTriggerGrpsResponsev1

Type: object

Model for Discount Trigger Groups Object

Show Source

effGrpObjNum: integer

ObjectNumber of Effectivity Group

Example: 1
hierUnitId: integer

Unique reference of the hierarchy unit of the property

Example: 1
hierUnitName: object hierUnitName

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

Object number of the hierarchy unit

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
name: object name

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

Object number of the Discount

Example: 1
sequenceNum: integer

Sequence Number of the Menu Item 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
triggerCondimentGroupName: object triggerCondimentGroupName

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

Object number of the Condiment Menu Item Group to use as the trigger for the discount

Example: 1
triggerMIGroupName: object triggerMIGroupName

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

Object number of the Menu Item Group to trigger the discount award.

Example: 1

{
    "description":"Model for Discount Trigger Groups Object",
    "type":"object",
    "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        },
        "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

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

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

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

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"
}