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.
The following example shows the response data from the
/ordersBulk
endpoint. It contains detailed information about
multiple orders.
[ { "guid": "5274c0f8-bf61-4e37-ad04-cf4ca1326822","entityType": "Order", "externalId": null, "revenueCenter": null, "server": { "guid": "dc9b7cd6-4389-4a6d-83c3-2fde7f033567", "entityType": "RestaurantUser", "externalId": null }, "lastModifiedDevice": { "id": null }, "source": "API", "voidDate": null, "duration": null, "businessDate": 20200302, "paidDate": null, "restaurantService": null, "voided": false, "estimatedFulfillmentDate": "2020-03-03T19:55:00.000+0000", "table": null, "requiredPrepTime": "PT30M", "approvalStatus": "FUTURE", "deliveryInfo": {
"address1": "401 Park Drive", "address2": "Suite 801", "city": "Boston", "state": "MA", "zipCode": "02215", "latitude": 42.3446671, "longitude": -71.1023575, "notes": "" }, "serviceArea": null, "curbsidePickupInfo": {
"entityType": "CurbsidePickup", "notes": "Convertible with top down", "transportColor": "blue", "transportDescription": "Street Cruiser" }, "numberOfGuests": 1, "diningOption": { "guid": "18855a26-40d4-4a8f-b484-c6af211dd597", "entityType": "DiningOption", "externalId": null }, "openedDate": "2020-03-02T19:17:02.552+0000", "voidBusinessDate": null, "checks": [ { "guid": "df38b30c-04b3-4eb3-923e-7cec05357674", "entityType": "Check", "externalId": null, "displayNumber": "pdesjardins-api-1583176621", "payments": [], "appliedDiscounts": [], "lastModifiedDevice": { "id": null }, "voidDate": null, "paidDate": null, "appliedLoyaltyInfo": null, "voided": false, "paymentStatus": "OPEN", "amount": 111, "tabName": null, "taxExempt": false, "openedDate": "2020-03-02T19:17:02.552+0000", "totalAmount": 111, "selections": [ { "guid": "2e917d92-04e5-4a2b-bb1a-bde41009feb3", "entityType": "MenuItemSelection", "externalId": null, "deferred": false, "preDiscountPrice": 111, "voidReason": null, "optionGroup": null, "displayName": "Rejected", "appliedDiscounts": [], "modifiers": [], "seatNumber": -1, "voidDate": null, "fulfillmentStatus": "NEW", "salesCategory": { "guid": "c0915e46-341e-4ec0-b46e-cb87fab729fd", "entityType": "SalesCategory", "externalId": null }, "selectionType": "NONE", "price": 111, "voided": false, "appliedTaxes": [], "itemGroup": { "guid": "c639a684-7245-4259-b9c5-f913e481347e", "entityType": "MenuGroup", "externalId": null }, "item": { "guid": "88aebc5f-4635-4141-9c0f-5a9be6324218", "entityType": "MenuItem", "externalId": null }, "taxInclusion": "INCLUDED", "quantity": 1, "unitOfMeasure": "NONE", "tax": 0, "diningOption": { "guid": "18855a26-40d4-4a8f-b484-c6af211dd597", "entityType": "DiningOption", "externalId": null }, "voidBusinessDate": null, "createdDate": "2020-03-02T19:17:02.583+0000", "preModifier": null, "modifiedDate": "2020-03-02T19:17:02.583+0000" } ], "voidBusinessDate": null, "deleted": false, "createdDevice": { "id": null }, "closedDate": null, "deletedDate": null, "modifiedDate": "2020-03-02T19:17:02.609+0000", "taxAmount": 0, "appliedServiceCharges": [], "customer": {
"entityType": "Customer", "firstName": "Jack", "lastName": "Jones", "phone": "333-555-5555", "email": "jack@example.com" } } ], "deleted": false, "createdDevice": { "id": null }, "closedDate": null, "deletedDate": null, "modifiedDate": "2020-03-02T19:17:02.612+0000", "promisedDate": "2020-03-03T19:55:00.000+0000", "pricingFeatures": [ "TAXESV2" ] }, { "guid": "529d9853-e28a-482b-9ee7-41580b0a53d0",
"entityType": "Order",
[contents omitted]
}, { "guid": "c3f0c5bd-3b06-4b5d-8035-be57ae38a02a", "entityType": "Order",[contents omitted]
} ]
The first |
|
The |
|
The |
|
The |
|
Each subsequent |