Get multiple orders

Returns an array of Order objects containing detailed information about all orders opened during a period of time. You can return the orders for either a specific period of time or for one business day.

  • Specify both startDate and endDate to return the orders modified during that period of time.

  • Specify the businessDate to return the orders promised during that business day.

Request
query Parameters
startDate
string <ISO-8601>

The inclusive start date and time. Orders with a modified date and time that are equal to or later than the startDate, but not greater than the endDate, are included. Use ISO-8601 format for the date and time, including a decimal fraction of a second, as described in the orders API overview. For example, 2016-01-01T14:13:12.000+0400. URL encode the date and time value. The date must be after 2015-12-01T00:00:00.000+0000.

endDate
string <ISO-8601>

The exclusive end date and time. Any orders with an equal or later modified date and time will be excluded. Use ISO-8601 format for the date and time, including a decimal fraction of a second, as described in the orders API overview. For example, 2016-01-01T14:13:12.000+0400. URL encode the date and time value. The endDate date and time must be later than the startDate parameter value.

businessDate
string

The business date that same-day orders opened or that future orders are promised, in the format yyyymmdd. The business day of an order is determined by the time the order is opened or promised in the local time zone and the restaurant's business day cutoff time, which is available from the General object of the restaurants API in the closeoutHour property.

pageSize
integer

The maximum number of objects to return in the array. If the number of objects selected by your request is greater than the pageSize, the API uses response pagination for the remaining objects. The maximum pageSize is 100. For more information, see the Toast Developer Guide.

page
integer

The sequence number of the set of objects to return in paginated response data. For example, if you set the pageSize parameter to 10 and you set page to 2, the API will return a set of objects starting with the eleventh object. For more information, see the Toast Developer Guide.

header Parameters
Toast-Restaurant-External-ID
required
string

The identifier for the restaurant that processed the orders.

Responses
200

A JSON array of Order objects for each order processed during the period of time you specify in your request.

400

The request contains data that is not supported by the API.

500

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

get/ordersBulk
Request samples
curl -i -X GET \
  'https://toast-api-server/orders/v2/ordersBulk?startDate=string&endDate=string&businessDate=string&pageSize=0&page=0' \
  -H 'Toast-Restaurant-External-ID: string'
Response samples
application/json
[
  • {
    }
]