About the Online Orders API

The Online Orders API provides all the functionality required to create and manage restaurant orders.

Restaurant orders are made up of one or more menu items, which are created and managed with the Wix Restaurants Menus (New) app.

The settings for Restaurant orders and their fulfillment are managed in the Wix Restaurants Orders (New) app. Restaurant order fulfillments are always for the full order, not for individual items in the order.

The Online Orders API contains the following APIs:

  • Operations: The Operations API allows you to create and manage operations at restaurants. An operation refers to different services a restaurant may offer. This API requires the Wix Restaurants Orders (New) app.
  • Fulfillment methods: The Fulfillment Methods API allows you to create, retrieve, and manage fulfillment methods for restaurants. This API requires the Wix Restaurants Orders (New) app.
  • Menu ordering settings: The Menu Ordering Settings API allows you to retrieve and manage menu ordering settings for a restaurant operation. This API requires the Wix Restaurants Menus (New) app and the Wix Restaurants Orders (New) app.
  • Availability exceptions: The Availability Exceptions API allows you to create and manage availability exceptions for restaurant operations. This API requires the Wix Restaurants Orders (New) app.
  • Service fees - The Service Fees API allows you to manage your service fees rules and apply them to orders.

Business locations

Entities in this API can be linked to a restaurant location. To learn how this information is managed, see About Business Locations.

Before you begin

It's important to note the following point before starting to code:

  • The Wix user must install the Wix Restaurants Orders (New) app.

Terminology

  • Operation: A distinct service a restaurant offers, such as catering or takeaway.
  • Fulfillment method: The way in which an order is received by the customer (for example, pickup, delivery).
  • Availability exception: A scheduled time during which orders are restricted or modified for specific fulfillment methods.
  • Service fee rule: A predefined rule that determines additional charges based on order conditions.
  • Menu ordering settings: Settings that define the availability of menus for ordering.
Did this help?