Include a diningOption with a DINE_IN dining behavior in the order. Send a GET request to the /diningOptions endpoint of the configuration API to retrieve the restaurant's dining options. Your integration should allow restaurants to choose which dining options they want your integration to use in your system's user interface.

Include a revenueCenter in the order. Assigning a revenue center to orders allows restaurants to categorize reservation orders in their revenue reporting. Send a GET request to the /revenueCenters endpoint of the configuration API to retrieve the restaurant's revenue centers. Your integration should allow restaurants to choose which revenue center they want your integration to use in your system's user interface.

Include a table in the order. This links the reservation details to the specific table at the restaurant where the guest will be dining. Send a GET request to the /tables endpoint of the configuration API to retrieve information about a restaurant's tables. Your table configurations should match the table configurations in the Toast platform.

Include the numberOfGuests value in the order to identify guest count. This helps restaurant staff prepare and manage the table effectively by knowing how many guests are dining. Additionally, the numberOfGuests provides useful information for building reports.

Include a tabName value in the order to identify your integration and guest information. Use the naming convention: {Partner name} - {Guest first name} {Guest last initial}. Your integration should allow restaurants to customize tab naming conventions in your system's user interface based on restaurant requirements.

For more information about where tab names appear in the Toast platform, see Guest personal identifiable information.

If your system collects deposits with reservations, you must communicate this information to the Toast platform when you submit the reservation so that the guest is not asked to repay their deposit amount. Deposits are processed through your system when the guest makes the reservation and is communicated to Toast when you submit the order. Deposits are not processed through Toast and use an alternative payment type in the reservation order submission. You are responsible for paying the restaurant for deposits made outside of the Toast platform.

To retrieve your alternative payment type identifier, send a GET request to the /alternativePaymentTypes endpoint of the configuration API and submit this payment type in the payments object of your reservation order. For more information, see Alternative payment types to learn more about submitting payments using the orders API.

If you support deposits, your onboarding process should include working with restaurants to create an alternative payment type specific to your integration. This guide outlines how to create alternative payment types in the Toast platform. Creating an alternative payment type cannot be done via API.

You can optionally allow restaurant operators to assign servers to reservations when guests check in. If your integration will support this, send a GET request to the /employees endpoint of the labor API to retrieve information about restaurant employees. Include the identifier of the employee in the server field in your order submission.

You can optionally pass service charges with reservation orders. Including a service charge enables restaurants to add additional fees to reservation orders, such as gratuity. To retrieve service charge information, send a GET request to the /serviceCharges endpoint of the configuration API. Your integration should allow restaurants to choose which service charges they want your integration to use in your system's user interface. For more information, see Service charge overview to learn more.

The workflow below outlines how to create a reservation in your system and submit the reservation information to the Toast platform:

{
  "diningOption": {
    "guid": "374d500f-c6d8-44d0-a18d-43fe5e7f750c"
  },
  "revenueCenter": {
    "guid": "81665a60-c20d-41da-a362-6474eab830d3"
  },
  "table": {
    "guid": "880a2f72-8960-4a3f-b2a2-60b7a19975e7"
  },
  "numberOfGuests": 4,
  "server": {
    "guid": "90d97fb8-931f-4196-aae9-d71bbcd5d3df"
  },
  "checks": [
    {
      "tabName": "Reservation Partner - Ann M"
    },
    {
      "appliedServiceCharges": [
        {
          "serviceCharge": {
            "guid": "9b2dd3cc-f4ab-4586-8c5a-2bbf6a9eef8d"
           }
         }
       ]
     },

    {
      "payments": [
        {
          "type": "OTHER",
          "amount": "20.00",
          "tipAmount": "0.00",
          "otherPayment": {
            "guid": "40dbc841-7f29-47d0-9834-9cf9c5b591d2"
          }
        }
      ]
    }
  ]
}