Get order identifiers (deprecated)

Returns a list of the GUIDs of all orders opened during a period of time. You can return the list of orders for either a period of up to one hour or for one business day.

  • Specify both startDate and endDate to return the list of orders modified during a period of up to one hour.
  • Specify the businessDate to return the list of orders promised for delivery during a business day.
Request
query Parameters
businessDate
string

The business date that same-day orders opened or that scheduled 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 by the restaurant's business day cutoff time, which is available from the General object of the restaurants API in the closeoutHour property.

endDate
string <ISO-8601>

The exclusive end date and time. The results exclude orders with an equal or later modified date and time.

Use ISO-8601 format for the date and time, including a decimal fraction of a second. 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.

startDate
string <ISO-8601>


The inclusive start date and time. The results exclude orders with an earlier modified date and time. Use ISO-8601 format for the date and time, including a decimal fraction of a second. 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.

header Parameters
Toast-Restaurant-External-ID
required
string

The identifier for the restaurant to retrieve orders from.

Responses
200

A JSON array of the GUID identifiers for orders.

400

The request contains data that is not supported by the current version of the API as described. For example, specifying credit card as the payment type.

500

An unexpected internal error occurred. The requestId that is attached to this error can be referenced by Toast.

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