{"componentChunkName":"component---src-templates-redoc-operation-js","path":"/kitchen/operation/itemFulfillmentsGet/","result":{"data":{"contentItem":{"type":"redoc-operation","link":"/kitchen/operation/itemFulfillmentsGet/","data":{"redocStoreStr":"{\"menu\":{\"activeItemIdx\":-1},\"definition\":{\"data\":{\"openapi\":\"3.0.0\",\"info\":{\"title\":\"Kitchen API\",\"version\":\"1.0.2\",\"description\":\"Returns information about kitchen operations.\\n\",\"contact\":{\"name\":\"Toast developer support\"}},\"paths\":{\"/export/itemFulfillments\":{\"get\":{\"operationId\":\"itemFulfillmentsGet\",\"summary\":\"Get item fulfillments\",\"description\":\"Exports item fulfillments for a single, specified business date.\\n\",\"parameters\":[{\"name\":\"businessDate\",\"in\":\"query\",\"description\":\"The business date for the item fulfillments to export. This  value must be in `YYYYMMDD` format.\\n\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns a list of `ItemFulfillment` objects.\\n\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/ItemFulfillment\"}}}}},\"204\":{\"description\":\"No data is returned. The restaurant does not have an active subscription to Toast Restaurant Management Suite Pro or higher.\\n\"},\"400\":{\"description\":\"The request is invalid.\\n\"},\"401\":{\"description\":\"The authentication token is not recognized.\\n\"},\"403\":{\"description\":\"The request is not permitted.\\n\"},\"404\":{\"description\":\"The endpoint was not found.\\n\"},\"500\":{\"description\":\"There was an unexpected server error.\\n\"}},\"security\":[{\"oauth2\":[\"kitchen:read\"]}]}},\"/published/prepStations\":{\"get\":{\"operationId\":\"prepStationsGet\",\"summary\":\"Get all prep stations\",\"description\":\"Returns the configuration for every prep station that has been created for the specified restaurant. A prep station represents the location of a kitchen printer or KDS device that receives orders for fulfillment. You can use optional query parameters to paginate the results. If a `lastModified` date is specified, returns all objects that were created or modified after that date.<br>\\n<br>\\n*Related topics:*<br>\\n<a href=\\\"https://doc.toasttab.com/doc/platformguide/platformKitchenRoutingOverview.html#adminRoutingToPrepStations\\\">Routing to prep stations</a>\\n\",\"parameters\":[{\"name\":\"pageToken\",\"in\":\"query\",\"description\":\"A string that identifies the set of data objects that the \\nendpoint will return in its response data. You can use this \\nparameter to control the pagination of response data. You \\nget the value that you supply in the `pageToken` parameter \\nfrom the `Toast-Next-Page-Token` header field value of a \\nprevious request to the endpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response data</a>.\\n\",\"schema\":{\"type\":\"string\"}},{\"name\":\"lastModified\",\"in\":\"query\",\"description\":\"Limits the return data to objects created or modified after a specific date and time. For example: `2021-12-01T00:00:00.000+0000`.\\n\",\"schema\":{\"type\":\"string\",\"format\":\"date-time\"}},{\"name\":\"Toast-Restaurant-External-ID\",\"in\":\"header\",\"description\":\"The Toast platform identifier for the restaurant.\\n\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns an array of `PrepStation` objects. A prep station represents the location of a kitchen printer or KDS device that receives orders for fulfillment.<br>\\n*Related topics:*<br>\\n<a href=\\\"https://doc.toasttab.com/doc/platformguide/platformKitchenRoutingOverview.html#adminRoutingToPrepStations\\\">Routing to prep stations</a>\\n\",\"headers\":{\"Toast-Next-Page-Token\":{\"description\":\"A string that identifies the following set of objects \\nthat the endpoint will return. You can use this value \\nto control the pagination of response data. To return \\nthe next page of objects you supply this value in the \\n`pageToken` parameter of the next request to the \\nendpoint. For more information, see \\n<a href=\\\"https://doc.toasttab.com/doc/devguide/apiResponseDataPagination.html\\\">Paginating response \\ndata</a>.\\n\\nThe endpoint does not return the \\n`Toast-Next-Page-Token` field if there is no following \\npage of response data objects. For example, the \\nendpoint will not return a `Toast-Next-Page-Token` \\nheader field if all the data objects fit in one \\nresponse or if you have reached the last page of \\nresponse objects.\\n\",\"schema\":{\"type\":\"string\"}}},\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"minItems\":0,\"maxItems\":1000,\"items\":{\"$ref\":\"#/components/schemas/PrepStation\"}}}}}},\"security\":[{\"oauth2\":[\"kitchen:read\"]}]}},\"/published/prepStations/{guid}\":{\"parameters\":[{\"name\":\"guid\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"get\":{\"operationId\":\"prepStationsGuidGet\",\"summary\":\"Get a prep station\",\"description\":\"Returns the configuration for a single prep station that has been defined for the specified restaurant. A prep station represents the location of a kitchen printer or KDS device that receives orders for fulfillment.<br>\\n<br>\\n*Related topics:*<br>\\n<a href=\\\"https://doc.toasttab.com/doc/platformguide/platformKitchenRoutingOverview.html#adminRoutingToPrepStations\\\">Routing to prep stations</a>\\n\",\"parameters\":[{\"name\":\"Toast-Restaurant-External-ID\",\"in\":\"header\",\"description\":\"The Toast platform identifier for the restaurant.\\n\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"Returns a `PrepStation` object.\\n\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/PrepStation\"}}}}},\"security\":[{\"oauth2\":[\"kitchen:read\"]}]}}},\"servers\":[{\"url\":\"https://toast-api-server/kitchen/v1\"}],\"components\":{\"securitySchemes\":{\"oauth2\":{\"description\":\"Access to Toast APIs, specific endpoints, \\nand specific API endpoint operations is \\ncontrolled by the scopes that are associated \\nwith your API account. \\n\\nA full reference for Toast API scopes and \\ntheir capabilities can be found in the\\n[_Toast Developer Guide_](https://doc.toasttab.com/doc/devguide/apiScopes.html).\\n\\nThe `/kitchen/v1/export/itemFulfillments` endpoint requires an active subscription\\nto <a href=\\\"https://www.toasttab.com/customers/shop/software-services/restaurant-management-suite?tier=Pro\\\">Toast Restaurant Management Suite Pro or higher</a> \\nto retrieve the data.\\n\",\"type\":\"oauth2\",\"flows\":{\"clientCredentials\":{\"tokenUrl\":\"https://toast-api-server/authentication/v1/authentication/login\",\"scopes\":{\"kitchen:read\":\"Allows reading from the kitchen API.\\n\"}}}}},\"schemas\":{\"ItemFulfillment\":{\"title\":\"ItemFulfillment\",\"type\":\"object\",\"description\":\"Details about the fulfillment of a menu item.\\n\",\"allOf\":[{\"type\":\"object\",\"properties\":{\"restaurantGuid\":{\"description\":\"The unique identifier assigned to the restaurant by the Toast platform.\",\"type\":\"string\",\"format\":\"uuid\"},\"orderGuid\":{\"description\":\"The unique identifier assigned to the order by the Toast platform.\",\"type\":\"string\",\"format\":\"uuid\"},\"selectionGuid\":{\"description\":\"The unique identifier assigned to the `Selection` object, which represents an item, of an order by the Toast platform.\",\"type\":\"string\",\"format\":\"uuid\"},\"selectionMenuItemGuid\":{\"description\":\"The unique identifier assigned to the menu item by the Toast platform.\",\"type\":\"string\",\"format\":\"uuid\"},\"selectionMenuItemName\":{\"description\":\"The descriptive name for the menu item, if available.\",\"type\":\"string\"},\"selectionMenuItemMultiLocationId\":{\"description\":\"A number used to identify and consolidate menu entities that are versions of each other.\",\"type\":\"string\"},\"ticketGuid\":{\"description\":\"The unique identifier assigned to the kitchen ticket by the Toast platform.\",\"type\":\"string\",\"format\":\"uuid\"},\"ticketFiredAt\":{\"description\":\"The time and date when the ticket for the menu item was fired to the kitchen, in ISO format.\",\"type\":\"string\",\"format\":\"date-time\"},\"itemFulfilledAt\":{\"description\":\"The time and date when the item was fulfilled, in ISO format.\",\"type\":\"string\",\"format\":\"date-time\"},\"itemStartedAt\":{\"description\":\"The time and date when an employee started working on the item, in ISO format. If the restaurant is not using the start queue feature, this value is the same as the `ticketFiredAt` value.\",\"type\":\"string\",\"format\":\"date-time\"},\"itemFulfillmentLevel\":{\"description\":\"The fulfillment level for the menu item. The values include:\\n  * `0`: The item was fulfilled at the prep station level. If an item has multiple prep stations, a separate `ItemFulfillment` object exists for each prep station that reaches this level.\\n  * `1`: The item was fulfilled at the first-level expediter.\\n  * `2`: The item was fulfilled at the second-level expediter. This is only used if [Two Level Fulfillment](https://doc.toasttab.com/doc/platformguide/adminKitchenDiningRoomReference.html#configTwoLevelFulfillment) is enabled.\\n\",\"type\":\"integer\"},\"prepStationGuid\":{\"description\":\"The unique identifier assigned to the prep station by the Toast platform, if available.\",\"type\":\"string\",\"format\":\"uuid\"},\"prepStationName\":{\"description\":\"The descriptive name of the prep station where the item was fulfilled, if available.\",\"type\":\"string\"},\"prepStationMultiLocationId\":{\"description\":\"An identifier used to identify and consolidate prep station entities that are versions of each other. For more information about multi-location identifiers, see [Toast identifiers](https://doc.toasttab.com/doc/devguide/apiIdentifiers.html).\",\"type\":\"string\"},\"diningOptionGuid\":{\"description\":\"The unique identifier assigned to the dining option by the Toast platform, if available.\",\"type\":\"string\",\"format\":\"uuid\"},\"diningOptionName\":{\"description\":\"The descriptive name of the dining option associated with the order, if available. For example, \\\"Dine In\\\" or \\\"Take Out\\\".\",\"type\":\"string\"},\"diningOptionBehavior\":{\"description\":\"The behavior type of the dining option, indicating whether the order is on-premise or off-premise, if available. For example, `DINE_IN` or `TAKE_OUT`.\",\"type\":\"string\"},\"courseGuid\":{\"description\":\"The unique identifier assigned to the course by the Toast platform, if available.\",\"type\":\"string\",\"format\":\"uuid\"},\"courseName\":{\"description\":\"The descriptive name of the course associated with the item, if available. For example, \\\"Appetizer\\\" or \\\"Entree\\\".\",\"type\":\"string\"},\"orderSource\":{\"description\":\"The way the order was placed.\\n\\nValid values:\\n\\n* `In Store`\\n* `Online`\\n* `Order-and-Pay-at-Table`\\n* `API`\\n* `Kiosk`\\n* `Caller Id`\\n* `Google`\\n* `Invoice`\\n* `Toast Pickup App`\\n* `Toast Local`\\n* `Branded Online Ordering`\\n* `Catering`\\n* `Catering Online Ordering`\\n* `Toast Tables`\\n* `eCommerce Online ordering`\\n* `Branded Mobile App`\\n* `Grubhub` (deprecated)\\n\",\"type\":\"string\"}}}]},\"PrepStation\":{\"title\":\"PrepStation\",\"type\":\"object\",\"description\":\"The configuration for a single prep station. A prep station represents the location of a kitchen printer or KDS device that receives orders for fulfillment.<br>\\n<br>\\n*Related topics:*<br>\\n<a href=\\\"https://doc.toasttab.com/doc/platformguide/adminAddPrepStation.html\\\">Add a prep station</a>\\n\",\"allOf\":[{\"$ref\":\"#/components/schemas/ToastReference\"},{\"type\":\"object\",\"properties\":{\"connectedPrepStations\":{\"type\":\"array\",\"description\":\"An array of `ToastReference` objects containing the identifiers of the other prep stations that this prep station monitors.<br>\\n<br>\\nAllowing a prep station to monitor other prep stations makes it easier for restaurant employees to coordinate when an order includes items that are fulfilled at more than one prep station.<br>\\n<br>\\n*Related topics:*<br>\\n<a href=\\\"https://doc.toasttab.com/doc/platformguide/adminMonitoringTicketsOtherPrepStations.html\\\">Monitoring items at other prep stations</a><br>\\n<a href=\\\"https://doc.toasttab.com/doc/platformguide/adminMonitoringTicketsOtherPrepStations.html#adminConfigurePrintOtherStationsItems\\\">Configure printing of other stations' items</a>\\n\",\"items\":{\"$ref\":\"#/components/schemas/ToastReference\"}},\"printingMode\":{\"type\":\"string\",\"description\":\"Determines whether tickets sent to this prep station are printed at the prep station's assigned printer. Values include:\\n* ON: Every ticket sent to this prep station prints at the prep station's assigned printer.\\n* OFFLINE_ONLY: Tickets sent to this prep station only print at the assigned printer if the prep station normally uses a KDS device for ticket display but that device is offline.          \\n\",\"enum\":[\"ON\",\"OFFLINE_ONLY\"]},\"includeWithExpediter\":{\"type\":\"boolean\",\"description\":\"True if tickets sent to this prep station should also be sent to the printer or KDS device that has been set up for the restaurant's expediter.<br>\\n<br>\\n*Related topics:*<br>\\n<a href=\\\"https://doc.toasttab.com/doc/platformguide/adminUsingExpo.html\\\">Using an expediter KDS</a><br>\\n\"},\"expoRouting\":{\"type\":\"string\",\"description\":\"Determines how tickets are routed to the expediter. This field works in conjunction with `includeWithExpediter` to provide more granular control over expo routing. Values include:\\n* SEND_TO_EXPO: Tickets are sent to both the prep station and the expediter (equivalent to `includeWithExpediter: true`)\\n* EXPO_ONLY: Tickets are sent only to the expediter, not to the prep station\\n* SKIP_EXPO: Tickets are sent only to the prep station, not to the expediter (equivalent to `includeWithExpediter: false`)\\n<br>\\n<br>\\n*Related topics:*<br>\\n<a href=\\\"https://doc.toasttab.com/doc/platformguide/adminUsingExpo.html\\\">Using an expediter KDS</a><br>\\n\",\"enum\":[\"SEND_TO_EXPO\",\"EXPO_ONLY\",\"SKIP_EXPO\"]},\"name\":{\"type\":\"string\",\"description\":\"The name of this prep station.\"},\"kitchenPrinter\":{\"$ref\":\"#/components/schemas/ToastReference\"}}}]},\"ToastReference\":{\"type\":\"object\",\"title\":\"ToastReference\",\"description\":\"A wrapper object containing a Toast platform GUID.\\n\",\"properties\":{\"guid\":{\"type\":\"string\",\"description\":\"A Toast platform identifier for an entity.\\n\"},\"entityType\":{\"type\":\"string\",\"description\":\"The type of object this is. For prep stations, `entityType` is set to `PrepStation`.\\n\"}},\"required\":[\"guid\",\"entityType\"]}}}}},\"options\":{\"hideTryItPanel\":true,\"pagination\":\"item\",\"generateCodeSamples\":{\"languages\":[{\"lang\":\"curl\"},{\"lang\":\"Java\"},{\"lang\":\"Python\"},{\"lang\":\"Node.js\"},{\"lang\":\"C#\"}]},\"showConsole\":false,\"hideHostname\":true,\"hideDownloadButton\":false,\"sortPropsAlphabetically\":true,\"schemaDefinitionsTagName\":\"Data definitions\",\"showAccessMode\":true,\"downloadDefinitionUrl\":\"https://doc.toasttab.com/toast-api-specifications/toast-kitchen-api-docs.yaml\",\"disableSearch\":true,\"ctrlFHijack\":false,\"disableSidebar\":true,\"theme\":{\"overrides\":{\"DownloadButton\":{\"custom\":\"\"},\"NextSectionButton\":{\"custom\":\"\"}},\"codeBlock\":{\"tokens\":{}},\"schema\":{\"constraints\":{},\"examples\":{}},\"rightPanel\":{\"textColor\":\"#eeeeee\"},\"typography\":{\"heading1\":{},\"heading2\":{},\"heading3\":{},\"rightPanelHeading\":{}}}}}","redocHasSecurityDefinitions":false,"redocInfoPageLink":"/kitchen/overview/","redocItemId":"operation/itemFulfillmentsGet","redocHasInfoPage":false,"settings":{"generateCodeSamples":{"languages":[{"lang":"curl"},{"lang":"Java"},{"lang":"Python"},{"lang":"Node.js"},{"lang":"C#"}]},"showConsole":false,"hideHostname":true,"hideDownloadButton":false,"sortPropsAlphabetically":true,"schemaDefinitionsTagName":"Data definitions","hideTryItPanel":true,"showAccessMode":true,"downloadDefinitionUrl":"https://doc.toasttab.com/toast-api-specifications/toast-kitchen-api-docs.yaml"},"requestLogin":false,"lastModified":"2026-07-16T11:29:22.439Z"},"seo":{"title":"Get item fulfillments"}}},"pageContext":{"id":"016853b3-3abd-546d-8a72-a6f44e2da661operation/itemFulfillmentsGet/__redocly content/kitchen/operation/itemFulfillmentsGet/","seo":{"title":"Get item fulfillments","description":"Exports item fulfillments for a single, specified business date.\n","image":"","keywords":null,"jsonLd":null,"lang":null},"pageId":"kitchen.reference.page.yaml#operation/itemFulfillmentsGet/","pageBaseUrl":"/kitchen","type":"redoc-operation","toc":{"enable":true,"maxDepth":4,"headings":null},"data":{},"catalogInfo":null,"link":"/kitchen/operation/itemFulfillmentsGet/","sidebarName":"api-reference","isLanding":false,"showPrevButton":null,"showNextButton":null,"apiVersions":[{"definitionId":"kitchen","id":"kitchen","title":"kitchen","isDefault":true,"apiId":null}],"apiVersionId":null,"isDefaultApiVersion":true}},"staticQueryHashes":["1123603147","1180902673","1302185487","1344209882","1398840060","1520077861","1975142765","2667623876","2950305614","3743992808","561138138"]}