Getting the list of configured discounts for a restaurant

To get information about the discounts configured for a restaurant, send a GET request to the /discounts endpoint of the configuration API.

In the results, the information about each discount includes the GUID that you use to apply the discount to an order in the orders API.

The following example shows the JSON return data for a GET request to the /discounts endpoint.

[
  {
    "guid": "a96fd992-9d69-4a62-894f-b621c31127a5",(1)
    "entityType": "Discount",
    "amount": 25,
    "selectionType": "CHECK",(2)
    "nonExclusive": true,(3)
    "percentage": null,
    "name": "$25 Off",
    "active": true,
    "itemPickingPriority": "FIRST",
    "type": "FIXED",(4)
    "fixedTotal": null
  },
  {
    "guid": "f66bd37f-8814-4f3a-a8ec-536d359dc1b7",
    "entityType": "Discount",
    "amount": null,
    "selectionType": "ITEM",(5)
    "nonExclusive": false,
    "percentage": null,
    "name": "Buy one, get one apple!",
    "active": true,
    "itemPickingPriority": "LEAST_EXPENSIVE",(6)
    "type": "BOGO",(7)
    "fixedTotal": null
  },
  {
    "guid": "baf12b76-511a-416d-871f-8d4532d425e4",
    "entityType": "Discount",
    "amount": null,
    "selectionType": "ITEM",
    "nonExclusive": false,
    "percentage": 100,
    "name": "Comp",
    "active": true,
    "itemPickingPriority": "FIRST",
    "type": "PERCENT",(8)
    "fixedTotal": null
  },
  {
    "guid": "23b26475-7e0a-4c0b-a2dc-9b6fcbe49e15",
    "entityType": "Discount",
    "amount": null,
    "selectionType": "CHECK",
    "nonExclusive": false,
    "percentage": null,
    "name": "ComboWingsDrinks",
    "active": true,
    "itemPickingPriority": "FIRST",
    "type": "FIXED_TOTAL",(9)
    "fixedTotal": 5(10)
  }
]

• (1):

  The /discounts endpoint returns an array of Discount objects. You can use the guid value to apply the discount to an order.

• (2):

  The selectionType value indicates whether you can apply the discount to an item or to an entire check. This discount applies to an entire check.

• (3):

  The nonExclusive value indicates the discount exclusivity of this discount. If true, then the discount is nonexclusive and can be combined with discounts. If false, the discount is exclusive and cannot be combined with other discounts.

• (4):

  The type value FIXED indicates that this discount reduces the check price by the fixed currency amount value.

• (5):

  Because it is a BOGO discount, the Toast platform applies the discount to items that match the item specification for the discount. In this case, it applies the discount to one of each set of two apples that are included as menu item selections in the check.

• (6):

  For BOGO discounts, the itemPickingPriority value indicates the setting of the item picking priority option. For example, a value of LEAST_EXPENSIVE means that the least expensive "get" item is discounted.

• (7):

  The type value BOGO indicates that this discount matches item selections based on the criteria that you configure for the discount.

• (8):

  The type value PERCENT indicates that this discount reduces the price of an item by the percentage value.

• (9):

  The type value FIXED_TOTAL indicates this is a combo discount that reduces the price of all the eligible items to a set currency amount.

• (10):

  The fixedTotal value indicates the total price of items discounted by this combo discount. The fixedTotal value is null for discounts that are not combo discounts.