Configuration and Content API Guide

Get Discount Award Groups

post

/config/sim/v1/sales/discounts/getawardgroups

Gets all the Discount Award Groups

Request

Supported Media Types

application/json
multipart/form-data

Header Parameters

Simphony-AuditTrailRef: string

Detail that identifies, who made the change.

Discount Award Groups Get Object

Root Schema : DiscountAwardGrpsBody

Type: object

The input Body model that needs to be given.

Show Source

effGrpObjNum: integer

Object Number of the effectivity group

Example: 2
hierUnitId(required): integer

Unique reference of the hierarchy.

Example: 2
include: string

Objects included in the 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
limit: integer

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

Example: 10
objectNum(required): integer

Object Number of the discount

Example: 2
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",
            "example":"where equals(objectNum,1)",
            "description":"Search criteria to filter results based on field value."
        },
        "include":{
            "type":"string",
            "example":"hierUnitId",
            "description":"Objects included in the 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",
            "example":"en-US, de-DE"
        },
        "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.",
            "type":"integer",
            "example":2
        },
        "objectNum":{
            "description":"Object Number of the discount",
            "type":"integer",
            "example":2
        },
        "effGrpObjNum":{
            "description":"Object Number of the effectivity group",
            "type":"integer",
            "example":2
        }
    }
}

Response

Supported Media Types

application/json

200 Response

A collection of Discount Award Groups.

Root Schema : DiscountAwardGrpsGetResponsev1

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 Award 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 Award Group objects of the organization.",
            "items":{
                "$ref":"#/definitions/DiscountAwardGrpsResponsev1"
            }
        },
        "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 Award Group objects of the organization.

Show Source

Array of: object DiscountAwardGrpsResponsev1

Model for Discount Award Groups Object

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

Nested Schema : DiscountAwardGrpsResponsev1

Type: object

Model for Discount Award Groups Object

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

A group of string objects representing the name of the trigger condiment menu item group in configured languages
awardMIGroupObjNum: 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: 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
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
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
percentOff: number

The percentage of the percent-based discount. Applicable only for awardType - 1

Example: 1.55
sequenceNum: integer

Sequence Number of the Menu Item Group

Example: 1

{
    "description":"Model for Discount Award 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":"Object Number of the effectivity group",
            "type":"integer",
            "example":1
        },
        "sequenceNum":{
            "description":"Sequence Number of the Menu Item Group",
            "type":"integer",
            "example":1
        },
        "awardMIGroupObjNum":{
            "description":"Object number of the Menu Item Group to trigger the discount award.",
            "type":"integer",
            "example":1
        },
        "awardMIGroupName":{
            "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"
            }
        },
        "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
        }
    }
}

Nested Schema : awardMIGroupName

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