Get applicable discounts

Returns an array of ApplicableDiscount objects that contain information about the discounts that apply to the checks and menu item selections in an order.

Each ApplicableDiscount object contains information that you can use to determine which items and checks are eligible for the discount.

If you include a promoCode value in the ApplicableDiscount object, the applicableDiscounts endpoint returns the only the discounts that are associated with that promotional code.

Securityoauth2
Request
header Parameters
Toast-Restaurant-External-ID
required
string

The identifier of the restaurant.

Request Body schema: application/json

A JSON ApplicableDiscountsRequest object containing information about an order, and an optional promoCode.

required
object (Order)

A wrapper object with fields that allow reference to a Toast entity by Toast GUID.

promoCode
string

An optional promotional code. If you include a promotional code, the applicableDiscounts endpoint returns only discounts that are associated with that promotional code.

Responses
200

A JSON array of ApplicableDiscount objects.

400

Invalid arguments

500

An unexpected internal error occurred. The requestId that is attached to this error can be referenced by Toast.

post/applicableDiscounts
Request samples
application/json
{
  • "order": {
    },
  • "promoCode": "string"
}
Response samples
application/json
[
  • {
    }
]