Toast · JSON Structure

Orders Applicable Discounts Request Structure

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.

Type: object Properties: 2 Required: 1
Food ServicePoint of SaleRestaurantsHospitality

ApplicableDiscountsRequest is a JSON Structure definition published by Toast, describing 2 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

order promoCode

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/toast/refs/heads/main/json-structure/orders-applicable-discounts-request-structure.json",
  "name": "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"
    }
  }
}