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 response from the orders API

The following example shows the response returned by the /orders endpoint of the orders API.

Orders endpoint response for a dine-in order with an alternative payment

{
  "guid": "71e46534-c837-4492-b4c1-0a841aea4ad5",1
  "entityType": "Order",
  "externalId": null,
  "revenueCenter": null,
  "server": null,
  "deliveryInfo": null,
  "serviceArea": null,
  "numberOfGuests": 1,
  "diningOption": {
    "guid": "23fc2559-fc37-46ce-a963-cc5fdb88af0c",
    "entityType": "DiningOption",
    "externalId": null
  },
  "source": "API",
  "voidDate": null,
  "openedDate": "2017-05-09T16:24:10.158+0000",2
  "duration": null,
  "businessDate": 20170509,3
  "voidBusinessDate": null,
  "checks": [
    {
      "guid": "c1784eaf-7ca8-461a-ba38-795ec51cf84a",
      "entityType": "Check",
      "externalId": null,
      "displayNumber": "381",
      "amount": 8.99,
      "tabName": null,
      "taxExempt": false,
      "payments": [4
        {
          "guid": "b6e08e3f-56cb-4873-bcc7-f0ea30842fee",
          "entityType": "OrderPayment",
          "externalId": null,
          "originalProcessingFee": null,
          "amount": 9.55,
          "tipAmount": 0,
          "amountTendered": 9.55,
          "cashDrawer": null,
          "cardType": null,
          "refundStatus": "NONE",
          "houseAccount": null,
          "type": "OTHER",
          "voidInfo": null,
          "otherPayment": {
            "guid": "0dc19214-d29e-4ab9-a773-27e5812999c7",
            "entityType": "AlternatePaymentType",
            "externalId": null
          },
          "paidDate": "2017-05-09T16:24:09.000+0000",
          "cardEntryMode": null,
          "paymentStatus": "CAPTURED",
          "paidBusinessDate": 20170509,
          "last4Digits": null,
          "refund": null
        }
      ],
      "appliedDiscounts": [],
      "voidDate": null,
      "openedDate": "2017-05-09T16:24:10.165+0000",5
      "totalAmount": 9.55,
      "selections": [
        {
          "guid": "3ede373e-ed90-4315-88d0-3f34f76a7513",
          "entityType": "MenuItemSelection",
          "externalId": null,
          "itemGroup": {
            "guid": "46c963b8-a4c8-4cd0-9b7e-e1c431ed0b53",
            "entityType": "MenuGroup",
            "externalId": null
          },
          "deferred": false,
          "item": {
            "guid": "a8b4439d-185d-41df-8ad3-2ff4f7dfa6ec",
            "entityType": "MenuItem",
            "externalId": null
          },
          "quantity": 1,
          "preDiscountPrice": 8.99,
          "voidReason": null,
          "optionGroup": null,
          "displayName": "Crab Cakes",
          "appliedDiscounts": [],
          "tax": 0.56,
          "modifiers": [],
          "voidDate": null,
          "fulfillmentStatus": "NEW",
          "salesCategory": null,
          "selectionType": "NONE",
          "voidBusinessDate": null,
          "createdDate": "2017-05-09T16:24:10.193+0000",
          "preModifier": null,
          "price": 8.99,
          "modifiedDate": "2017-05-09T16:24:10.193+0000",
          "voided": false,
          "appliedTaxes": [
            {
              "entityType": "AppliedTaxRate",
              "taxRate": {
                "guid": "d5b88c05-1348-42ef-b1d3-577a83d70a80",
                "entityType": "TaxRate"
              },
              "name": "State Tax",
              "rate": 0.0625,
              "taxAmount": 0.56,
              "type": "PERCENT"
            }
          ]
        }
      ],
      "voidBusinessDate": null,
      "deleted": false,
      "paidDate": "2017-05-09T16:24:10.197+0000",6
      "closedDate": "2017-05-09T16:24:10.197+0000",7
      "deletedDate": null,
      "modifiedDate": "2017-05-09T16:24:10.203+0000",8
      "appliedLoyaltyInfo": null,
      "voided": false,
      "taxAmount": 0.56,
      "appliedServiceCharges": [],
      "paymentStatus": "CLOSED",
      "customer": null
    }
  ],
  "deleted": false,
  "paidDate": "2017-05-09T16:24:10.204+0000",9
  "closedDate": "2017-05-09T16:24:10.204+0000",10
  "deletedDate": null,
  "restaurantService": null,
  "modifiedDate": "2017-05-09T16:24:10.206+0000",11
  "promisedDate": null,
  "voided": false,
  "estimatedFulfillmentDate": null,
  "table": null
}

1

The unique identifier that the Toast platform assigns to the order.

2

The date and time that the order was created.

3

The restaurant business date on which the order was fulfilled. The restaurant business date can be different than the calendar dates when the order is created, paid, and closed. For example, if a restaurant business day extends after midnight, an order that is created after midnight might have a businessDate value that is one day earlier than the calendar date when the order was created.

4

Information about payments made for this check.

5

The date and time that the check was added to the order.

6

The date and time that the customer made a payment for the check.

7

The date and time that the check was completely fulfilled and paid.

8

The date and time that information about the check was changed most recently.

9

The date and time that all checks in the order were completely paid.

10

The date and time that all checks in the order were completely fulfilled and paid.

11

The date and time that information about the order was changed most recently.