Jump to

• Request
• Response

Get Discount Award Groups

post

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

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

Request

Supported Media Types

• application/json
• multipart/form-data

Header Parameters

• Simphony-AuditTrailRef: string
  Detail that identifies, who made the change.
• Simphony-OrgShortName: string
  The ShortName of the organization

Body ()

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
• hierUnitId: integer
  Unique reference of the hierarchy.
• include(optional): string
  Objects included in response
• languages(optional): string
  If specified, limits translated strings returned
• limit(optional): integer
  If using paging, number of results returned in this page.
• objectNum: integer
  Object Number of the discount
• offset(optional): integer
  Starting resource record index. Not required if paging parameters are not supported
• orderBy(optional): integer
  Sorts the response by the specified field name and sort order.
• searchCriteria(optional): 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",
        "effGrpObjNum"
    ],
    "properties":{
        "searchCriteria":{
            "type":"string",
            "description":"Search criteria to filter results based on field value"
        },
        "include":{
            "type":"string",
            "description":"Objects included in response"
        },
        "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":"integer",
            "description":"Sorts the response by the specified field name and sort order."
        },
        "hierUnitId":{
            "description":"Unique reference of the hierarchy.",
            "type":"integer"
        },
        "objectNum":{
            "description":"Object Number of the discount",
            "type":"integer"
        },
        "effGrpObjNum":{
            "description":"Object Number of the effectivity group",
            "type":"integer"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

A collection of DiscountAwardGrps entities in an organization.

Body ()

Root Schema : DiscountAwardGrps

Type: object

Model for Discount Award Groups Object

Show Source

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

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

  Example: 1.22
• awardMIGroupName(optional): object awardMIGroupName
  Additional Properties Allowed: additionalProperties

  A group of string objects representing the name of the trigger condiment menu item group in configured languages
• awardMIGroupObjNum(optional): integer
  Object number of the Menu Item Group to trigger the discount award.

  Example: 1
• awardType(optional): 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(optional): object hierUnitName
  Additional Properties Allowed: additionalProperties

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

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

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

  Example: 1
• percentOff(optional): 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",
    "required":[
        "hierUnitId",
        "objectNum",
        "effGrpObjNum",
        "sequenceNum",
        "awardMiGroupObjNum"
    ],
    "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",
                "es-SS":"Empresa",
                "lt=LT":"??mon??"
            },
            "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",
                "es-SS":"Empresa",
                "lt=LT":"??mon??"
            },
            "additionalProperties":{
                "type":"string"
            }
        },
        "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",
                "es-SS":"Empresa",
                "lt=LT":"??mon??"
            },
            "additionalProperties":{
                "type":"string"
            }
        },
        "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

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",
        "es-SS":"Empresa",
        "lt=LT":"??mon??"
    },
    "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",
    "es-SS":"Empresa",
    "lt=LT":"??mon??"
}

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",
        "es-SS":"Empresa",
        "lt=LT":"??mon??"
    },
    "additionalProperties":{
        "type":"string"
    }
}

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

Example:

{
    "en-US":"Enterprise",
    "es-SS":"Empresa",
    "lt=LT":"??mon??"
}

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",
        "es-SS":"Empresa",
        "lt=LT":"??mon??"
    },
    "additionalProperties":{
        "type":"string"
    }
}

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

Example:

{
    "en-US":"Enterprise",
    "es-SS":"Empresa",
    "lt=LT":"??mon??"
}

400 Response

400 Bad Request

Body ()

Root Schema : ErrorDetails

Type: object

Response body when the request returns an error.

Show Source

• detail(optional): string
  A short, human-readable summary of the problem.

  Example: Specified Data is invalid
• errorDetails(optional): string
  A human-readable explanation specific to this occurrence of the problem.

  Example: Entity Does Not Exist
• o:errorCode(optional): integer
  Error code of the problem

  Example: 55223
• status(optional): integer
  HTTP status code.

  Example: 400
• title(optional): string
  A short, human-readable summary of the problem type.

  Example: VALIDATION ERROR
• type(optional): 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",
    "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