Get order prices

Calculates the check price amounts, tax amounts, and service charges for an Order object you supply as a required message body parameter. The prices endpoint validates the order you submit to ensure all referenced data exists and that you include item selections in the expected structure with all required modifier options. Some values that would be present in the response data when creating an order are not present in the response data for the prices endpoint. For example, the order GUID is not set because the Toast platform does not create persistent data for the order.

The calculated price can change between requests to the prices endpoint with the same Order object if enough time passes between the requests. The difference in price is possible because the restaurant configuration can change and because some pricing configuration is based on time and date schedules.

Request
header Parameters
Toast-Restaurant-External-ID
required
string

The identifier of the restaurant to be used for this price calculation.

Request Body schema: application/json

A required JSON Order object containing information about the checks, item selections, modifier options, and other parts of the order.

string
Responses
200

Success. The response body contains a JSON Order object with values for check amounts, taxes, service charges, and other parts of the order. Because this endpoint only calculates prices, no parts of the order persist in the Toast platform and do not have GUIDs in the response object.

400

Either the request contains data that is not supported by the current version of the API as described or the order contains an item that is negatively priced.

403

The API client does not have access to the restaurant, the API client does not have the orders:read scope, or both.

404

An entity referenced in the order does not exist, or belongs to a restaurant the API client is not authorized to access.

413

The number of checks in the submitted order exceeds the limit.

415

The request did not have application/json in the Content-Type HTTP header field.

500

An unexpected internal error occurred. There is a requestId attached to the error that can be referenced by the Toast support team.

post/prices
Request samples
application/json
"string"
Response samples
application/json
{
  • "orders": [
    ]
}