How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Toast Discounts API

Related to price reduction applied to restaurant orders. For example, arestaurant might apply a discount for a promotion.

Toast Discounts API is one of 80 APIs that Toast publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Discounts. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 5 paths, and defines 31 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against 2 base URLs: https://toast-api-server/config/v2, https://toast-api-server/authentication/v1.

5 operations 5 paths 31 schemas 2 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Servers
https://toast-api-server/config/v2
https://toast-api-server/authentication/v1
Authentication
OAuth 2.0
Contact
Toast developer support
Resource Areas
1

Authentication & Security 1

Toast Discounts API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the clientCredentials flow, exposing 1 scope.

  • oauth2 — Access to Toast APIs, specific endpoints, and specific API endpoint operations is controlled by the scopes that are associated with your API account. A full re…

Paths & Operations 5

Across 5 paths, the API surfaces 5 operations — 2 GET, 3 POST. Each is listed below with its method, path, parameters, and response codes.

Discounts 5
GET
/discounts/{guid}
Get a discount
discountsGuidGet 2 params → 200
GET
/discounts
Get discounts
discountsGet 3 params → 200
POST
/orders/{orderGuid}/checks/{checkGuid}/appliedDiscounts
Toast Add Check-level Discounts
ordersChecksAppliedDiscountsPost 2 params body → 200400
POST
/orders/{orderGuid}/checks/{checkGuid}/selections/{selectionGuid}/appliedDiscounts
Toast Add Item-level Discounts
ordersChecksSelectionsAppliedDiscountsPost 3 params body → 200400
POST
/applicableDiscounts
Toast Get Applicable Discounts
applicableDiscountsPost 1 param body → 200400500

Schemas 31

The contract defines 31 schemas that model the data the API accepts and returns. The most detailed are DeliveryInfo (14 properties), Refund (5 properties), VoidInformation (5 properties), AppliedDiscountReason (4 properties). Each schema is shown below with its type and property counts.

ToastReference
object
A wrapper object with fields that allow reference to a Toast entity by Toast GUID.
2 properties 2 required
Discount
object
PromoCode
object
RefundTransaction
Device
object
The Device ID value that the Toast platform assigns to a specific Toast POS device. The id value is a unique identifier for a device. To find the ID for a Toas…
1 property
AppliedDiscountTrigger
object
The Selection that triggered the application of this discount
2 properties
RefundDetails
object
Information about refunded currency amounts for an item selection, modifier option, or service charge. The refund information includes separate values for the…
3 properties
Order
object
A Toast platform order is composed of one or more checks. Each check has one or more menu item selections. The externalId value for an order must be unique. If…
ToastReference_2
object
A wrapper object with fields that allow reference to a Toast entity by Toast GUID.
2 properties 2 required
AppliedLoyaltyInfo
object
Information about the customer loyalty program account associated with a check.
2 required
Refund
object
A currency amount removed from a guest payment.
5 properties
AppliedTaxRate
object
A tax rate that is applied to an item or service charge.
1 required
ConfigReference
object
A wrapper object containing identifier values for Toast platform entities.
AppliedServiceCharge
object
A service charge that is added to a check. A service charge can represent an upcharge such as a gratuity or a delivery fee. Whether the upcharge is taxable is…
DeliveryInfo
object
Information related to delivery orders. Required if the dining option behavior is DELIVERY.
14 properties 4 required
ApplicableDiscountsRequest
object
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…
2 properties 1 required
Selection
object
A Selection object can represent either a primary item (for example, Check.selections) or a modifier (Selection.modifiers) selection. Quantity defaults to 1. F…
ExternalReference
object
A wrapper object with fields that allow reference to a Toast platform entity by Toast GUID or a partner's identifier.
CurbsidePickupInfo
object
Information that the restaurant can use to identify a guest when they arrive outside the restaurant to pick up their order. transportDescription is a required…
Fulfillment
object
Information about the fulfillment requirements for a menu item selection.
2 properties
ApplicableDiscount
object
A wrapper object that contains information about a discount that you can apply to an order, and which checks or menu item selections you can apply it to.
3 properties 1 required
Payment
object
Defines a payment.
MarketplaceFacilitatorTaxInfo
object
Information about the taxes that a marketplace facilitator organization remits on behalf of a Toast platform restaurant. POST only. The orders API does not inc…
2 properties
AppliedPackagingInfo
object
Information describing the guest's packaging preferences for this order, for example utensils, napkins, condiments. For more information, see [Packaging prefer…
LoyaltyDetails
object
Information about the loyalty program discount that is applied to a check. The loyalty program account is identified in the AppliedLoyaltyInfo value for the ch…
2 properties 2 required
AppliedPackagingItem
object
Indicates the guest preference for an individual packaging item in this order.
VoidInformation
object
Information about a void applied to a check or item.
5 properties
AppliedDiscountReason
object
4 properties 1 required
Customer
object
AppliedDiscount
object
A discount applied to a check or item. The Toast platform calculates service charges before it applies discounts. The system calculates tax after applying disc…
Check
object
Represents a single check within an order. The externalId value for a check must be unique. If you submit a check with an externalId that already exists for an…

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

toast-discounts-api-openapi.yml Raw ↑

Other APIs Toast publishes across the network.

Toast Authentication API
Toast ConnectedRestaurants API
Toast Employees API
Toast Groups API
Toast Jobs API
Toast Menus API
Toast Metadata API
Toast Orders API
Toast Payments API
Toast Restaurants API
Toast Shifts API
Toast Stock API
Where this information came from

This is an independent, third-party profile of Toast Discounts API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.