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

Get Discounts

post

/config/sim/v1/sales/getDiscounts

Gets all the Discounts configured

Request

Supported Media Types
Body ()
A request body
Root Schema : DiscountGetRequestBody
Type: object
The input Body model that needs to be given.
Show Source
  • Objects included in response
  • 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
  • If specified, limits translated strings returned
  • If using paging, number of results returned in this page.
  • Starting resource record index. Not required if paging parameters are not supported
  • Sorts the response by the specified field name and sort order.
  • Search criteria to filter results based on field value
Back to Top

Response

Supported Media Types

200 Response

A collection of Discount entities in an organization.
Body ()
Root Schema : DiscountGetResponse
Type: object
Model for Discount Object
Show Source
Nested Schema : autoRule
Type: object
Determine how Simphony calculates a discount
Show Source
  • A Boolean flag indicating to allow award of a higher priced trigger item if the trigger item is also an award item. Applicable only for autoRuleType ??? 2 and 3
    Example: false
  • The types of Automatic Discounts rule;0 ??? Not Active;1 - Item Price Substitution;2 - Quantity Threshold;3 - Total Price Threshold;4 - Combination Pricing;5 - Sales Price
    Example: 1
  • The award algorithm to be used in the discount.;1- Best Deal for Customer to apply the highest discount amount to the check;2 - Best Deal for Merchant to apply the lowest discount amount to the check
    Example: 1
  • awardGroups
    An array of award groups for the discount
  • The types of Discounts Constraints;1-No Constraint, 2-Menu Item,3-Major Group,4-Family Group, Applicable only for autoRuleType 2 and 3.
    Example: 1
  • The maximum number of times the coupon discount can be entered on a check. Enter 0 for unlimited entries
    Example: 1
  • The order in which the POS client calculates discounts. Applicable only for autoRuleType 1-4
    Example: 1
  • triggerGroups
    Menu Item Group to trigger the discount award.
  • A Boolean flag indicating to use the Menu Item Groups promotion price for the discounted menu item. Does not function with Combination Pricing Discounts. Applicable only for autoRuleType ??? 1,2,3 and 5
    Example: false
Nested Schema : consumerDisplayname
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 : dataExtensions
Type: array
An array of data extensions
Show Source
Nested Schema : dscItmzrExt
Type: object
An object containing the descriptive list associated with the condiment set associated with the menu item
Show Source
  • A Boolean flag indicating if the discount is computable on discount itemizer 1
    Example: false
  • A Boolean flag indicating if the discount is computable on discount itemizer 10
    Example: false
  • A Boolean flag indicating if the discount is computable on discount itemizer 11
    Example: false
  • A Boolean flag indicating if the discount is computable on discount itemizer 12
    Example: false
  • A Boolean flag indicating if the discount is computable on discount itemizer 13
    Example: false
  • A Boolean flag indicating if the discount is computable on discount itemizer 14
    Example: false
  • A Boolean flag indicating if the discount is computable on discount itemizer 15
    Example: false
  • A Boolean flag indicating if the discount is computable on discount itemizer 2
    Example: false
  • A Boolean flag indicating if the discount is computable on discount itemizer 3
    Example: false
  • A Boolean flag indicating if the discount is computable on discount itemizer 4
    Example: false
  • A Boolean flag indicating if the discount is computable on discount itemizer 5
    Example: false
  • A Boolean flag indicating if the discount is computable on discount itemizer 6
    Example: false
  • A Boolean flag indicating if the discount is computable on discount itemizer 7
    Example: false
  • A Boolean flag indicating if the discount is computable on discount itemizer 8
    Example: false
  • A Boolean flag indicating if the discount is computable on discount itemizer 9
    Example: false
Nested Schema : effectivity
Type: object
An object representing the effective dates for the record
Show Source
Nested Schema : effGrpName
Type: object
A group of string objects representing the name of the effectivity group for the discount in configured languages
Example:
{
    "en-US":"Enterprise",
    "de-DE":"Unternehmen",
    "es-MX":"Empresa"
}
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
  • A string value of 0s & 1s of length 32 representing the enablement or disablement of the discount on specific menu items
    Example: 00000000000000000000000000000000
  • itemExt
    An object containing the descriptive list associated with the enablement or disablement of the discount on specific menu items
  • A string value of 0s & 1s of length 32 representing the enablement or disablement of the discount on transactions
    Example: 00000000000000000000000000000000
  • transactionExt
    An object containing the descriptive list associated with the enablement or disablement of the discount on transactions
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 : menuLevels
Type: object
An object containing the menu levels on which the discount is active
Show Source
  • A string value of 0s & 1s of length 8 representing the enablement or disablement of the discount on main levels
    Example: 00000000
  • mainLevelExt
    An object containing the descriptive list associated with the enablement or disablement of the discount on main level
  • A string value of 0s & 1s of length 8 representing the enablement or disablement of the discount on sub levels
    Example: 00000000
  • subLevelExt
    An object containing the descriptive list associated with the enablement or disablement of the discount on sub level
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 : optionsExt
Type: object
An object containing the descriptive option list
Show Source
Nested Schema : orderChannelRestrictions
Type: array
The order channels that are considered for the discount. Each objectNum belongs to a particular order channel.
Show Source
Example:
[
    {
        "name":{
            "en-US":"Delivery"
        },
        "objectNum":"4"
    }
]
Nested Schema : printClassName
Type: object
A group of string objects representing the name of the print class for the discount in configured languages
Example:
{
    "en-US":"Enterprise",
    "de-DE":"Unternehmen",
    "es-MX":"Empresa"
}
Nested Schema : reportGroupName
Type: object
A group of string objects representing the name of the report group associated with the discount in configured languages
Example:
{
    "en-US":"Enterprise",
    "de-DE":"Unternehmen",
    "es-MX":"Empresa"
}
Nested Schema : rvcTypeExt
Type: object
An object containing the descriptive list of revenue centers where the discount is available.
Show Source
  • A Boolean flag indicating if the discount is available at Revenue Center Type 1
    Example: false
  • A Boolean flag indicating if the discount is available at Revenue Center Type 10
    Example: true
  • A Boolean flag indicating if the discount is available at Revenue Center Type 11
    Example: true
  • A Boolean flag indicating if the discount is available at Revenue Center Type 12
    Example: true
  • A Boolean flag indicating if the discount is available at Revenue Center Type 13
    Example: false
  • A Boolean flag indicating if the discount is available at Revenue Center Type 14
    Example: false
  • A Boolean flag indicating if the discount is available at Revenue Center Type 15
    Example: false
  • A Boolean flag indicating if the discount is available at Revenue Center Type 16
    Example: false
  • A Boolean flag indicating if the discount is available at Revenue Center Type 17
    Example: false
  • A Boolean flag indicating if the discount is available at Revenue Center Type 18
    Example: false
  • A Boolean flag indicating if the discount is available at Revenue Center Type 19
    Example: false
  • A Boolean flag indicating if the discount is available at Revenue Center Type 2
    Example: false
  • A Boolean flag indicating if the discount is available at Revenue Center Type 20
    Example: false
  • A Boolean flag indicating if the discount is available at Revenue Center Type 21
    Example: false
  • A Boolean flag indicating if the discount is available at Revenue Center Type 22
    Example: false
  • A Boolean flag indicating if the discount is available at Revenue Center Type 23
    Example: false
  • A Boolean flag indicating if the discount is available at Revenue Center Type 24
    Example: false
  • A Boolean flag indicating if the discount is available at Revenue Center Type 25
    Example: false
  • A Boolean flag indicating if the discount is available at Revenue Center Type 26
    Example: false
  • A Boolean flag indicating if the discount is available at Revenue Center Type 27
    Example: false
  • A Boolean flag indicating if the discount is available at Revenue Center Type 28
    Example: false
  • A Boolean flag indicating if the discount is available at Revenue Center Type 29
    Example: false
  • A Boolean flag indicating if the discount is available at Revenue Center Type 3
    Example: true
  • A Boolean flag indicating if the discount is available at Revenue Center Type 30
    Example: false
  • A Boolean flag indicating if the discount is available at Revenue Center Type 31
    Example: false
  • A Boolean flag indicating if the discount is available at Revenue Center Type 32
    Example: true
  • A Boolean flag indicating if the discount is available at Revenue Center Type 4
    Example: true
  • A Boolean flag indicating if the discount is available at Revenue Center Type 5
    Example: true
  • A Boolean flag indicating if the discount is available at Revenue Center Type 6
    Example: true
  • A Boolean flag indicating if the discount is available at Revenue Center Type 7
    Example: true
  • A Boolean flag indicating if the discount is available at Revenue Center Type 8
    Example: true
  • A Boolean flag indicating if the discount is available at Revenue Center Type 9
    Example: true
Nested Schema : sluName
Type: object
A group of string objects representing the name of the SLU in configured languages
Example:
{
    "en-US":"Enterprise",
    "de-DE":"Unternehmen",
    "es-MX":"Empresa"
}
Nested Schema : taxClassName
Type: object
A group of string objects representing the name of the tax class to be discounted in configured languages
Example:
{
    "en-US":"Enterprise",
    "de-DE":"Unternehmen",
    "es-MX":"Empresa"
}
Nested Schema : triggerCondimentGrpName
Type: object
A group of string objects representing the name of the print class for the discount in configured languages
Example:
{
    "en-US":"Enterprise",
    "de-DE":"Unternehmen",
    "es-MX":"Empresa"
}
Nested Schema : triggerMIGrpName
Type: object
A group of string objects representing the name of the print class for the discount in configured languages
Example:
{
    "en-US":"Enterprise",
    "de-DE":"Unternehmen",
    "es-MX":"Empresa"
}
Nested Schema : awardGroups
Type: array
An array of award groups for the discount
Show Source
Nested Schema : triggerGroups
Type: array
Menu Item Group to trigger the discount award.
Show Source
Nested Schema : items
Type: object
Show Source
  • The discount amount for flat amount-based discount. Applicable only for awardType ??? 2
    Example: 1
  • The price to charge for each item in the Trigger Menu Item Group. Applicable only for awardType ??? 3
    Example: 1
  • The maximum number of items discounted after reaching the Trigger MI Group's Minimum Quantity
    Example: 1
  • awardMIGroupName
    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
  • Object number of the menu item group that is to be discounted. Applicable only for autoRuleType ??? 2 and 3
    Example: 1
  • Type of the award;0 ??? None;1 ??? Percent Off;2 ??? Amount Off;3 ??? Amount Substitution
    Example: 1
  • 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
  • The percentage of the percent-based discount. Applicable only for awardType 1. Value must lie between 0 and 1. For Example 15% will be 0.15 in the 200 response body.
    Example: 1
  • The sequence number of the award group
    Example: 1
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",
    "de-DE":"Unternehmen",
    "es-MX":"Empresa"
}
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",
    "de-DE":"Unternehmen",
    "es-MX":"Empresa"
}
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",
    "de-DE":"Unternehmen",
    "es-MX":"Empresa"
}
Nested Schema : items
Type: object
Show Source
Nested Schema : recurrenceDayOfWeekExt
Type: object
An object containing the descriptive list of recurrence effective day of the week for the record.
Show Source
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
  • A Boolean flag indicating to apply discount to a menu item 1.
    Example: false
  • A Boolean flag indicating to apply discount to a menu item 10.
    Example: false
  • A Boolean flag indicating to apply discount to a menu item 11.
    Example: false
  • A Boolean flag indicating to apply discount to a menu item 12.
    Example: false
  • A Boolean flag indicating to apply discount to a menu item 13.
    Example: false
  • A Boolean flag indicating to apply discount to a menu item 14.
    Example: false
  • A Boolean flag indicating to apply discount to a menu item 15.
    Example: false
  • A Boolean flag indicating to apply discount to a menu item 16.
    Example: false
  • A Boolean flag indicating to apply discount to a menu item 17.
    Example: false
  • A Boolean flag indicating to apply discount to a menu item 18.
    Example: false
  • A Boolean flag indicating to apply discount to a menu item 19.
    Example: false
  • A Boolean flag indicating to apply discount to a menu item 2.
    Example: false
  • A Boolean flag indicating to apply discount to a menu item 20.
    Example: false
  • A Boolean flag indicating to apply discount to a menu item 21.
    Example: false
  • A Boolean flag indicating to apply discount to a menu item 22.
    Example: false
  • A Boolean flag indicating to apply discount to a menu item 23.
    Example: false
  • A Boolean flag indicating to apply discount to a menu item 24.
    Example: false
  • A Boolean flag indicating to apply discount to a menu item 25.
    Example: false
  • A Boolean flag indicating to apply discount to a menu item 26.
    Example: false
  • A Boolean flag indicating to apply discount to a menu item 27.
    Example: false
  • A Boolean flag indicating to apply discount to a menu item 28.
    Example: false
  • A Boolean flag indicating to apply discount to a menu item 29.
    Example: false
  • A Boolean flag indicating to apply discount to a menu item 3.
    Example: false
  • A Boolean flag indicating to apply discount to a menu item 30.
    Example: false
  • A Boolean flag indicating to apply discount to a menu item 31.
    Example: false
  • A Boolean flag indicating to apply discount to a menu item 32.
    Example: false
  • A Boolean flag indicating to apply discount to a menu item 4.
    Example: false
  • A Boolean flag indicating to apply discount to a menu item 5.
    Example: false
  • A Boolean flag indicating to apply discount to a menu item 6.
    Example: false
  • A Boolean flag indicating to apply discount to a menu item 7.
    Example: false
  • A Boolean flag indicating to apply discount to a menu item 8.
    Example: false
  • A Boolean flag indicating to apply discount to a menu item 9.
    Example: false
Nested Schema : transactionExt
Type: object
An object containing the descriptive list associated with the enablement or disablement of the discount on transactions
Show Source
  • A Boolean flag indicating the discount to be applicable to entire check transaction 1
    Example: false
  • A Boolean flag indicating the discount to be applicable to entire check transaction 10
    Example: false
  • A Boolean flag indicating the discount to be applicable to entire check transaction 11
    Example: false
  • A Boolean flag indicating the discount to be applicable to entire check transaction 12
    Example: false
  • A Boolean flag indicating the discount to be applicable to entire check transaction 13
    Example: false
  • A Boolean flag indicating the discount to be applicable to entire check transaction 14
    Example: false
  • A Boolean flag indicating the discount to be applicable to entire check transaction 15
    Example: false
  • A Boolean flag indicating the discount to be applicable to entire check transaction 16
    Example: false
  • A Boolean flag indicating the discount to be applicable to entire check transaction 17
    Example: false
  • A Boolean flag indicating the discount to be applicable to entire check transaction 18
    Example: false
  • A Boolean flag indicating the discount to be applicable to entire check transaction 19
    Example: false
  • A Boolean flag indicating the discount to be applicable to entire check transaction 2
    Example: false
  • A Boolean flag indicating the discount to be applicable to entire check transaction 20
    Example: false
  • A Boolean flag indicating the discount to be applicable to entire check transaction 21
    Example: false
  • A Boolean flag indicating the discount to be applicable to entire check transaction 22
    Example: false
  • A Boolean flag indicating the discount to be applicable to entire check transaction 23
    Example: false
  • A Boolean flag indicating the discount to be applicable to entire check transaction 24
    Example: false
  • A Boolean flag indicating the discount to be applicable to entire check transaction 25
    Example: false
  • A Boolean flag indicating the discount to be applicable to entire check transaction 26
    Example: false
  • A Boolean flag indicating the discount to be applicable to entire check transaction 27
    Example: false
  • A Boolean flag indicating the discount to be applicable to entire check transaction 28
    Example: false
  • A Boolean flag indicating the discount to be applicable to entire check transaction 29
    Example: false
  • A Boolean flag indicating the discount to be applicable to entire check transaction 3
    Example: false
  • A Boolean flag indicating the discount to be applicable to entire check transaction 30
    Example: false
  • A Boolean flag indicating the discount to be applicable to entire check transaction 31
    Example: false
  • A Boolean flag indicating the discount to be applicable to entire check transaction 32
    Example: false
  • A Boolean flag indicating the discount to be applicable to entire check transaction 4
    Example: false
  • A Boolean flag indicating the discount to be applicable to entire check transaction 5
    Example: false
  • A Boolean flag indicating the discount to be applicable to entire check transaction 6
    Example: false
  • A Boolean flag indicating the discount to be applicable to entire check transaction 7
    Example: false
  • A Boolean flag indicating the discount to be applicable to entire check transaction 8
    Example: false
  • A Boolean flag indicating the discount to be applicable to entire check transaction 9
    Example: false
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
  • A Boolean flag indicating if the discount is available at Revenue Center Type 1
    Example: false
  • A Boolean flag indicating if the discount is available at Revenue Center Type 2
    Example: false
  • A Boolean flag indicating if the discount is available at Revenue Center Type 3
    Example: false
  • A Boolean flag indicating if the discount is available at Revenue Center Type 4
    Example: false
  • A Boolean flag indicating if the discount is available at Revenue Center Type 5
    Example: false
  • A Boolean flag indicating if the discount is available at Revenue Center Type 6
    Example: false
  • A Boolean flag indicating if the discount is available at Revenue Center Type 7
    Example: false
  • A Boolean flag indicating if the discount is available at Revenue Center Type 8
    Example: false
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
  • A Boolean flag indicating if the discount is available at Revenue Center Type 1
    Example: false
  • A Boolean flag indicating if the discount is available at Revenue Center Type 2
    Example: false
  • A Boolean flag indicating if the discount is available at Revenue Center Type 3
    Example: false
  • A Boolean flag indicating if the discount is available at Revenue Center Type 4
    Example: false
  • A Boolean flag indicating if the discount is available at Revenue Center Type 5
    Example: false
  • A Boolean flag indicating if the discount is available at Revenue Center Type 6
    Example: false
  • A Boolean flag indicating if the discount is available at Revenue Center Type 7
    Example: false
  • A Boolean flag indicating if the discount is available at Revenue Center Type 8
    Example: false
Nested Schema : items
Type: object
Show Source
Nested Schema : name
Type: object
A group of string objects representing the name of the order channel that is to be discounted in configured languages
Example:
{
    "en-US":"Default",
    "de-DE":"Standard",
    "es-MX":"Por defecto"
}

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