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.
The response from the /prices
endpoint fills in the
amounts, including prices and taxes, for the menu item selections and
checks. For a description of the amount fields in the Order
object, see Order amounts.
The following example shows the response data returned by the
/prices
endpoint of the orders API.
{ "guid": null, "entityType": "Order", "externalId": null, "revenueCenter": null, "server": null, "deliveryInfo": null, "serviceArea": null, "numberOfGuests": 1, "diningOption": { "guid": "23fc2559-fc37-46ce-a963-cc5fdb88af0c", "entityType": "DiningOption", "externalId": null }, "source": "API", "voidDate": null, "openedDate": "2017-05-09T16:24:09.881+0000", "duration": null, "businessDate": 20170509, "voidBusinessDate": null, "checks": [ { "guid": null, "entityType": "Check", "externalId": null, "displayNumber": null, "amount": 8.99,"tabName": null, "taxExempt": false, "payments": [], "appliedDiscounts": [], "voidDate": null, "openedDate": "2017-05-09T16:24:09.883+0000", "totalAmount": 9.55,
"selections": [ { "guid": null, "entityType": "MenuItemSelection", "externalId": null, "itemGroup": { "guid": "46c963b8-a4c8-4cd0-9b7e-e1c431ed0b53", "entityType": "MenuGroup", "externalId": null }, "deferred": false, "item": { "guid": "a8b4439d-185d-41df-8ad3-2ff4f7dfa6ec", "entityType": "MenuItem", "externalId": null }, "quantity": 1, "preDiscountPrice": 8.99,
"voidReason": null, "optionGroup": null, "displayName": "Crab Cakes", "appliedDiscounts": [], "tax": 0.56,
"modifiers": [], "seatNumber": -1, "voidDate": null, "fulfillmentStatus": "NEW", "salesCategory": null, "selectionType": "NONE", "voidBusinessDate": null, "createdDate": null, "preModifier": null, "price": 8.99,
"modifiedDate": null, "voided": false, "appliedTaxes": [ { "entityType": "AppliedTaxRate", "taxRate": { "guid": "d5b88c05-1348-42ef-b1d3-577a83d70a80", "entityType": "TaxRate" }, "name": "State Tax", "rate": 0.0625, "taxAmount": 0.56, "type": "PERCENT" } ] } ], "voidBusinessDate": null, "deleted": false, "paidDate": null, "closedDate": null, "deletedDate": null, "modifiedDate": null, "appliedLoyaltyInfo": null, "voided": false, "taxAmount": 0.56,
"appliedServiceCharges": [], "paymentStatus": "OPEN", "customer": null } ], "deleted": false, "paidDate": null, "closedDate": null, "deletedDate": null, "restaurantService": null, "modifiedDate": null, "promisedDate": null, "voided": false, "estimatedFulfillmentDate": null, "table": null }
The price of the check after discounts, not including tax. |
|
The price of the check after discounts, including tax. |
|
The price of the menu item selection, before discounts. |
|
The tax amount applied to the menu item selection. |
|
The menu item selection, including discounts, quantity adjustments, and modifiers. |
|
The tax amount applied to the menu item selection. |