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.

Orders API Limitations

Users of Toast's orders API should be aware of the following API limitations.

Item Availability

  • The orders API does not evaluate whether the menu item selections in an order are available based on time or menu visibility.

  • The orders API does not evaluate whether menu item selections are available based on current inventory.

  • The orders API does not use the orderableOnline flag to evaluate whether the menu item selections in an order are available. The orderableOnline flag on menu entities is a display suggestion that does not perform order validation.

Restaurant Timing

  • The orders API does not evaluate whether an order is placed during the service hours of a restaurant. For example, the orders API will create an order at a restaurant while that restaurant is closed.

Creating Orders Limitations

  • The orders API cannot include open menu items in order checks. Open items allow restaurant employees to freely enter pricing and description for an item.

  • To post payment information, you must include a Payment object with its type value set to CREDIT or OTHER. For more information about creating orders with a CREDIT type payment, see Credit card payments. To create an order using an OTHER type payment, you include the GUID of the alternative payment type that you configure in an otherPayment value in the Payment object.

Restaurant Workflow Limitations

  • Orders that are entered using the orders API do not initiate SMS text messages. Messages are sent to guests or servers only for orders entered in the Toast POS system (for example, using a Toast POS device).

  • If a restaurant uses a Kitchen Display System (KDS) device, orders you create using the orders API are sent straight to the kitchen as long as the restaurant has an auto-firing device properly configured. Orders POSTed via API are not subject to approval rules or manual approval.

Gift Cards and Loyalty

  • Toast gift cards cannot be used with orders submitted through the orders API.

  • Toast loyalty functionality cannot be used with orders submitted through the orders API. For information about using loyalty program integrations with orders API orders, see Applying loyalty program discounts to an order.

Retrieving Orders

  • You can get historical order information for orders created after December 1, 2015 (2015-12-01).