A wrapper object that contains an `Order` object and an optional promotional code. You include an `ApplicableDiscountsRequest` object in the message body of a `POST` request to the `applicableDiscounts` endpoint.
Food ServicePoint-of-SaleRestaurantHospitality
Properties
Name
Type
Description
order
object
An `Order` object that contains information about the order that you want to get discounts for.
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.
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/toast/refs/heads/main/json-schema/orders-applicable-discounts-request-schema.json",
"title": "ApplicableDiscountsRequest",
"description": "A wrapper object that contains an `Order` object and an optional\npromotional code.\n\nYou include an `ApplicableDiscountsRequest`\nobject in the message body of a `POST` request to the\n`applicableDiscounts` endpoint.\n",
"type": "object",
"required": [
"order"
],
"properties": {
"order": {
"type": "object",
"$ref": "#/definitions/Order",
"description": "An `Order` object that\ncontains information about the order that you want to get discounts\nfor.\n"
},
"promoCode": {
"description": "An optional promotional code. If you include a promotional\ncode, the `applicableDiscounts` endpoint returns only\ndiscounts that are associated with that promotional code.\n",
"type": "string"
}
}
}
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.