1. Configuration and Content API Guide
  2. Tasks
  3. Sales
  4. Discounts
  5. Discount

Get Discounts

post

/config/sim/v1/sales/getDiscounts

Gets all the Discounts configured

Request

Supported Media Types
Header Parameters
Body ()
A request body
Root Schema : DiscountGetRequestBody
Type: object
The input Body model that needs to be given.
Show Source
Back to Top

Response

Supported Media Types

200 Response

A collection of Discount entities in an organization.
Body ()
Root Schema : Discount
Type: object
Model for Discount Object
Show Source
Nested Schema : autoRule
Type: object
Determine how Simphony calculates a discount
Show Source
Example:
1
Nested Schema : awardGroups
Type: array
Show Source
Nested Schema : consumerDisplayname
Type: object
Additional Properties Allowed
Show Source
A group of string objects representing the name of the Discounts in configured languages
Example:
{
    "en-US":"Enterprise",
    "es-SS":"Empresa",
    "lt=LT":"??mon??"
}
Nested Schema : dscItmzrExt
Type: object
An object containing the descriptive list associated with the condiment set associated with the menu item
Show Source
Nested Schema : effectivity
Type: object
An object representing the effective dates for the record
Show Source
Nested Schema : effGrpName
Type: object
Additional Properties Allowed
Show Source
A group of string objects representing the name of the effectivity group for the discount in configured languages
Example:
{
    "en-US":"Enterprise",
    "es-SS":"Empresa",
    "lt=LT":"??mon??"
}
Nested Schema : exclusivity
Type: object
Exclusivity stops all discounts from applying to a check at once. Discount exclusivity controls how multiple discounts interact with each other.
Show Source
Nested Schema : hierUnitName
Type: object
Additional Properties Allowed
Show Source
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 : menuLevels
Type: object
An object containing the menu levels on which the discount is active
Show Source
Nested Schema : name
Type: object
Additional Properties Allowed
Show Source
A group of string objects representing the name of the Discounts in configured languages
Example:
{
    "en-US":"Enterprise",
    "es-SS":"Empresa",
    "lt=LT":"??mon??"
}
Nested Schema : optionsExt
Type: object
An object containing the descriptive option list
Show Source
Nested Schema : printClassName
Type: object
Additional Properties Allowed
Show Source
A group of string objects representing the name of the print class for the discount in configured languages
Example:
{
    "en-US":"Enterprise",
    "es-SS":"Empresa",
    "lt=LT":"??mon??"
}
Nested Schema : reportGroupName
Type: object
Additional Properties Allowed
Show Source
A group of string objects representing the name of the report group associated with the discount in configured languages
Example:
{
    "en-US":"Enterprise",
    "es-SS":"Empresa",
    "lt=LT":"??mon??"
}
Nested Schema : rvcTypeExt
Type: object
An object containing the descriptive list of revenue centers where the discount is available.
Show Source
Nested Schema : sluName
Type: object
Additional Properties Allowed
Show Source
A group of string objects representing the name of the SLU in configured languages
Example:
{
    "en-US":"Enterprise",
    "es-SS":"Empresa",
    "lt=LT":"??mon??"
}
Nested Schema : taxClassName
Type: object
Additional Properties Allowed
Show Source
A group of string objects representing the name of the tax class to be discounted in configured languages
Example:
{
    "en-US":"Enterprise",
    "es-SS":"Empresa",
    "lt=LT":"??mon??"
}
Nested Schema : triggerCondimentGrpName
Type: object
Additional Properties Allowed
Show Source
A group of string objects representing the name of the print class for the discount in configured languages
Example:
{
    "en-US":"Enterprise",
    "es-SS":"Empresa",
    "lt=LT":"??mon??"
}
Nested Schema : triggerMIGrpName
Type: object
Additional Properties Allowed
Show Source
A group of string objects representing the name of the print class for the discount in configured languages
Example:
{
    "en-US":"Enterprise",
    "es-SS":"Empresa",
    "lt=LT":"??mon??"
}
Nested Schema : triggerGroups
Type: array
Menu Item Group to trigger the discount award.
Show Source
Example:
1
Nested Schema : items
Type: object
Show Source
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",
    "es-SS":"Empresa",
    "lt=LT":"??mon??"
}
Nested Schema : triggerMIGroupName
Type: object
A group of string objects representing the name of the trigger menu item group in configured languages
Example:
{
    "en-US":"Enterprise",
    "es-SS":"Empresa",
    "lt=LT":"??mon??"
}
Nested Schema : items
Type: object
Show Source
Nested Schema : awardMIGroupName
Type: object
A group of string objects representing the name of the menu item group that is to be discounted in configured languages; Applicable only for autoRuleType ??? 2 and 3
Example:
{
    "en-US":"Enterprise",
    "es-SS":"Empresa",
    "lt=LT":"??mon??"
}
Nested Schema : recurrenceDayOfWeekExt
Type: object
An object containing the descriptive list of recurrence effective day of the week for the record.
Show Source
Example:
1
Nested Schema : itemExt
Type: object
An object containing the descriptive list associated with the enablement or disablement of the discount on specific menu items
Show Source
Nested Schema : transactionExt
Type: object
An object containing the descriptive list associated with the enablement or disablement of the discount on transactions
Show Source
Nested Schema : mainLevelExt
Type: object
An object containing the descriptive list associated with the enablement or disablement of the discount on main level
Show Source
Nested Schema : subLevelExt
Type: object
An object containing the descriptive list associated with the enablement or disablement of the discount on sub level
Show Source

400 Response

400 Bad Request
Body ()
Root Schema : ErrorDetails
Type: object
Response body when the request returns an error.
Show Source

404 Response

404 Requested resource not found
Back to Top