|
Note |
|
Access to this endpoint requires an active subscription to Toast
Restaurant Management Suite Pro or higher. If you make a
request without the proper access, you’ll receive a |
Send a GET request to the
/kitchen/v1/export/itemFulfillments endpoint of the kitchen
API to get a JSON object containing a data array with details about
kitchen fulfillment of items for a specified date. The data includes
details such as the item name, when the ticket was fired, when the item
was fulfilled, and the level of fulfillment.
|
Note |
|
Menu item fulfillment data is only available if you use kitchen display system (KDS) devices. |
You must include a businessDate query parameter,
using the YYYYMMDD format, to identify which date of
kitchen fulfillment data you want to retrieve. Historical kitchen item
fulfillment data is available starting from January 2022.
|
Value name |
Definition |
|---|---|
|
|
The unique identifier assigned to the restaurant by the Toast platform. |
|
|
The unique identifier assigned to the order by the Toast platform. |
|
|
The unique identifier assigned to the
|
|
|
The unique identifier assigned to the menu item by the Toast platform. |
|
|
The descriptive name for the menu item, if available. For example, “Caesar Salad” or “Turkey Sandwich”. |
|
|
An identifier used to identify and consolidate menu entities that are versions of each other. For more information about multi-location identifiers, see Toast identifiersToast identifiers. |
|
|
The unique identifier assigned to the kitchen ticket by the Toast platform. |
|
|
The time and date when the ticket for the menu item was fired to the kitchen, in ISO format. |
|
|
The time and date when the item was fulfilled, in ISO format. |
|
|
The time and date when an employee started
working on the item, in ISO format. If the restaurant does not
use the start queue feature,
this value is the same as the |
|
|
The level of fulfillment for the menu item:
An |
|
|
The unique identifier assigned to the prep
station by the Toast platform, if available. If more than one
prep station is assigned to the menu item, an
This value is |
|
|
The descriptive name for the prep station, if
available. For example, “Grill/Fry” or “Drinks”. If more than
one prep station is assigned to the menu item, an
This value is |
|
|
An identifier used to identify and consolidate
prep stations that are versions of each other. If more than
one prep station is assigned to the menu item, an
This value is |
|
|
The unique identifier assigned to the dining option by the Toast platform, if available. |
|
|
The descriptive name for the dining option associated with the menu item, if available. For example, “Take Out” or “Dine In”. |
|
|
The dining behavior associated with the dining option used for the order. For more information about dining options and dining behaviors, see Dining options. |
|
|
The unique identifier assigned to the course associated with the menu item, if available. |
|
|
The descriptive name for the course associated with the menu item, if available. For example, “Appetizer” or “Dessert”. |
|
|
Indicates the way the order was placed. For
example, |
The following curl command sends a
GET request to the
/kitchen/v1/export/itemFulfillments endpoint.
curl -X GET \ ‘https://[toast-api-hostname]/kitchen/v1/export/itemFulfillments?businessDate=20260131’ \
-H ‘Authorization: Bearer [token]’ \
-H ‘Content-Type: application/json’ \
-H ‘Accept: application/json’ \
-H "Toast-Restaurant-External-ID: 95a96d7b-dbf5-46d3-98c5-c65c8ad18021"
|
Send a |
|
|
Specify the date for the kitchen item fulfillment data you are
retrieving using the |
|
|
Include an authentication token. For more information, see Authentication and restaurant access. |
|
|
Set the data type of the message body to
|
|
|
Optionally, set the acceptance requirement for returned data
to |
|
|
Specify the GUID of the restaurant you are requesting data from. This must be the GUID of an individual restaurant. It cannot be the GUID of a restaurant group. |
The following example shows the response data from the
/kitchen/v1/export/itemFulfillments endpoint.
|
Note |
|
An |
[
{
"restaurantGuid": "95a96d7b-dbf5-46d3-98c5-c65c8ad18021",
"orderGuid": "f8e4ae5e-ccbd-49e5-81e8-947d673c30ad",
"selectionGuid": "98bca966-4969-4314-9a8a-8486340164d2",
"selectionMenuItemGuid": "025d8278-edc3-409a-a16e-c082ccd9e5a5",
"selectionMenuItemName": "Ramen",
"selectionMenuItemMultiLocationId": "800000000001234567",
"ticketGuid": "e3dd31e1-78bb-47e4-a1a3-7c14c9f8c8ff",
"ticketFiredAt": "2026-02-24T17:09:27Z",
"itemFulfilledAt": "2026-02-24T17:12:26Z",
"itemStartedAt": "2026-02-24T17:09:27Z",
"itemFulfillmentLevel": 0,
"prepStationGuid": "95a97b2d-31a2-46a3-8592-5fb5fb74cf13",
"prepStationName": "Food",
"prepStationMultiLocationId": "600000000004865548",
"diningOptionGuid": "5a3dd0fd-48e0-4f32-8dc4-500784498477",
"diningOptionName": "Dine In",
"diningOptionBehavior": "DINE_IN",
"courseGuid": null,
"courseName": null,
"orderSource": "IN_STORE"
},
{
"restaurantGuid": "95a96d7b-dbf5-46d3-98c5-c65c8ad18021",
"orderGuid": "f8e4ae5e-ccbd-49e5-81e8-947d673c30ad",
"selectionGuid": "98bca966-4969-4314-9a8a-8486340164d2",
"selectionMenuItemGuid": "025d8278-edc3-409a-a16e-c082ccd9e5a5",
"selectionMenuItemName": "Ramen",
"selectionMenuItemMultiLocationId": "800000000001234567",
"ticketGuid": "e3dd31e1-78bb-47e4-a1a3-7c14c9f8c8ff",
"ticketFiredAt": "2026-02-24T17:09:27Z",
"itemFulfilledAt": "2026-02-24T17:19:46Z",
"itemStartedAt": "2026-02-24T17:09:27Z",
"itemFulfillmentLevel": 1,
"prepStationGuid": null,
"prepStationName": null,
"prepStationMultiLocationId": null,
"diningOptionGuid": "5a3dd0fd-48e0-4f32-8dc4-500784498477",
"diningOptionName": "Dine In",
"diningOptionBehavior": "DINE_IN",
"courseGuid": null,
"courseName": null,
"orderSource": "IN_STORE"
},
{
"restaurantGuid": "95a96d7b-dbf5-46d3-98c5-c65c8ad18021",
"orderGuid": "98bca966-4969-4314-9a8a-8486340164d2",
"selectionGuid": "e3dd31e1-78bb-47e4-a1a3-7c14c9f8c8ff",
"selectionMenuItemGuid": "d1a45259-de30-48fc-950b-7ff2b3a31c75",
"selectionMenuItemName": "Yakisoba",
"selectionMenuItemMultiLocationId": "100000000987654321",
"ticketGuid": "98bca966-4969-4314-9a8a-8486340164d2",
"ticketFiredAt": "2026-02-24T17:06:10Z",
"itemFulfilledAt": "2026-02-24T17:10:00Z",
"itemStartedAt": "2026-02-24T17:06:10Z",
"itemFulfillmentLevel": 0,
"prepStationGuid": "2659d1bb-3265-41f5-8c59-7f51859fff9f",
"prepStationName": "Grill/Fry",
"prepStationMultiLocationId": null,
"diningOptionGuid": "5a3dd0fd-48e0-4f32-8dc4-500784498477",
"diningOptionName": "Dine In",
"diningOptionBehavior": "DINE_IN",
"courseGuid": null,
"courseName": null,
"orderSource": "IN_STORE"
},
{
"restaurantGuid": "95a96d7b-dbf5-46d3-98c5-c65c8ad18021",
"orderGuid": "98bca966-4969-4314-9a8a-8486340164d2",
"selectionGuid": "e3dd31e1-78bb-47e4-a1a3-7c14c9f8c8ff",
"selectionMenuItemGuid": "d1a45259-de30-48fc-950b-7ff2b3a31c75",
"selectionMenuItemName": "Yakisoba",
"selectionMenuItemMultiLocationId": "100000000987654321",
"ticketGuid": "98bca966-4969-4314-9a8a-8486340164d2",
"ticketFiredAt": "2026-02-24T17:06:10Z",
"itemFulfilledAt": "2026-02-24T17:10:44Z",
"itemStartedAt": "2026-02-24T17:06:10Z",
"itemFulfillmentLevel": 1,
"prepStationGuid": null,
"prepStationName": null,
"prepStationMultiLocationId": null,
"diningOptionGuid": "5a3dd0fd-48e0-4f32-8dc4-500784498477",
"diningOptionName": "Dine In",
"diningOptionBehavior": "DINE_IN",
"courseGuid": null,
"courseName": null,
"orderSource": "IN_STORE"
},
[content omitted]
]
|
Status code |
Name |
Description |
|---|---|---|
|
|
No Content |
No data is returned because the restaurant does not have an active subscription to Toast Restaurant Management Suite Pro or higher. |
|
|
Bad Request |
The request is invalid. This often occurs when the syntax of the request is incorrect. |
|
|
Unauthorized |
The authentication token is not recognized. For more information, see Authentication and restaurant access. |
|
|
Forbidden |
The request is not permitted. This means you do not have access to the restaurant or location. |
|
|
Not Found |
The endpoint was not found. |
|
|
Internal Server Error |
There was an unexpected server error. |
For more information about Toast API responses and errors, see API responses and errors.