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.

Example Order object for a scheduled order

The Order object in the following example creates an order that is scheduled for future fulfillment.

{
  "entityType": "Order",
  "diningOption": {
    "guid": "23fc2559-fc37-46ce-a963-cc5fdb88af0c",
    "entityType": "DiningOption"
  },
  "checks": [
    {
      "entityType": "Check",
      "selections": [
        {
          "entityType": "MenuItemSelection",
          "itemGroup": {
            "guid": "46c963b8-a4c8-4cd0-9b7e-e1c431ed0b53",
            "entityType": "MenuGroup"
          },
          "item": {
            "entityType": "MenuItem",
            "guid": "a8b4439d-185d-41df-8ad3-2ff4f7dfa6ec"
          },
          "quantity": 1,
          "modifiers": []
        }
      ],
      "payments": [
        {
          "paidDate": "2022-03-01T10:00:00.000+0000",1
          "type": "OTHER",
          "otherPayment": {
            "guid": "b9ba25d1-519a-4ea8-ba05-ed1d952b28bf"
          },
          "amount": 8.63,
          "tipAmount": 1.02
        }
      ]
    }
  ],
  "promisedDate": "2022-03-05T16:00:00.000+0000",2
  "openedDate": "2022-03-05T16:00:00.000+0000"3
}

1

If you submit a payment with the order, the paidDate for the payment should be the timestamp when the payment is placed.

2

The promisedDate value specifies the date and time when the order will be fulfilled.

3

The openedDate value specifies the business date of the order. If you do not include an openedDate value, the business date of the order is set to the restaurant business day that corresponds to the current date and time. This openedDate value matches the promisedDate value.