This guide will be removed on April 29, 2022. Please use our new, easier-to-use Toast technical documentation site. All updated content is on the new site.
When you add a discount to an existing order, the response contains
an Order
object that shows the added discounts.
Here is an example of a response to a request to add discounts to a check:
{ "guid": "52b90296-359c-4015-a42b-044276a9c0b3","entityType": "Order", [contents omitted] "checks": [ { "guid": "b79bbce8-cc4f-42f5-b42d-1f644888db34",
"entityType": "Check", [contents omitted] "appliedDiscounts": [ { "guid": "43130ce2-24e4-4532-b77d-f1cee4690743",
"entityType": "AppliedCustomDiscount", "externalId": null, "approver": null, "processingState": null, "loyaltyDetails": null, "name": "MyCheckDiscount", "comboItems": [], "discountAmount": 11.1, "discount": { "guid": "c0c17bfb-db88-4322-ae58-df5059325a1a", "entityType": "Discount" }, "nonTaxDiscountAmount": 11.1, "triggers": [], "appliedPromoCode": null } ], [contents omitted] } ], [contents omitted] }
The Toast platform GUID of the order you added a discount in. |
|
The Toast platform GUID of the check you added a discount to. |
|
The Toast platform GUID of the discount you added. |
Here is an example of a response to a request to add a discount to a menu item selection:
{ "guid": "52b90296-359c-4015-a42b-044276a9c0b3","entityType": "Order", [contents omitted] "checks": [ { "guid": "b79bbce8-cc4f-42f5-b42d-1f644888db34",
"entityType": "Check", [contents omitted] "selections": [ { "guid": "ee3d2c4a-2d67-4c4e-8aa0-b8496fb00110",
"entityType": "MenuItemSelection", [contents omitted] "appliedDiscounts": [ { "guid": "9d0a2fb6-c962-4ccd-89b6-c96865a7b2f3",
"entityType": "AppliedCustomDiscount", "externalId": null, "approver": null, "processingState": null, "loyaltyDetails": null, "name": "MyItemDiscount", "comboItems": [], "discountAmount": 11.1, "discount": { "guid": "896304bc-6151-4e13-a407-89a4792fa2ba", "entityType": "Discount" }, "nonTaxDiscountAmount": 11.1, "triggers": [ { "selection": { "guid": "33182827-db63-4119-84a3-230e3e7eb809", "entityType": "MenuItemSelection", "externalId": null }, "quantity": 1 } ], "appliedPromoCode": null } ], [contents omitted] } ], [contents omitted] } ], [contents omitted] }