ItemFulfillment

Details about the fulfillment of a menu item.

• courseGuid:
  string <uuid>

  The unique identifier assigned to the course by the Toast platform, if available.

• courseName:
  string

  The descriptive name of the course associated with the item, if available. For example, "Appetizer" or "Entree".

• diningOptionBehavior:
  string

  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.

• diningOptionGuid:
  string <uuid>

  The unique identifier assigned to the dining option by the Toast platform, if available.

• diningOptionName:
  string

  The descriptive name of the dining option associated with the order, if available. For example, "Dine In" or "Take Out".

• itemFulfilledAt:
  string <date-time>

  The time and date when the item was fulfilled, in ISO format.

• itemFulfillmentLevel:
  integer

  The fulfillment level for the menu item. The values include:

  • 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.
  • 1: The item was fulfilled at the first-level expediter.
  • 2: The item was fulfilled at the second-level expediter. This is only used if Two Level Fulfillment is enabled.
• itemStartedAt:
  string <date-time>

  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.

• orderGuid:
  string <uuid>

  The unique identifier assigned to the order by the Toast platform.

• orderSource:
  string

  The way the order was placed.

  Valid values:

  • In Store
  • Online
  • Order-and-Pay-at-Table
  • API
  • Kiosk
  • Caller Id
  • Google
  • Invoice
  • Toast Pickup App
  • Toast Local
  • Branded Online Ordering
  • Catering
  • Catering Online Ordering
  • Toast Tables
  • eCommerce Online ordering
  • Branded Mobile App
  • Grubhub (deprecated)
• prepStationGuid:
  string <uuid>

  The unique identifier assigned to the prep station by the Toast platform, if available.

• prepStationMultiLocationId:
  string

  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.

• prepStationName:
  string

  The descriptive name of the prep station where the item was fulfilled, if available.

• restaurantGuid:
  string <uuid>

  The unique identifier assigned to the restaurant by the Toast platform.

• selectionGuid:
  string <uuid>

  The unique identifier assigned to the Selection object, which represents an item, of an order by the Toast platform.

• selectionMenuItemGuid:
  string <uuid>

  The unique identifier assigned to the menu item by the Toast platform.

• selectionMenuItemMultiLocationId:
  string

  A number used to identify and consolidate menu entities that are versions of each other.

• selectionMenuItemName:
  string

  The descriptive name for the menu item, if available.

• ticketFiredAt:
  string <date-time>

  The time and date when the ticket for the menu item was fired to the kitchen, in ISO format.

• ticketGuid:
  string <uuid>

  The unique identifier assigned to the kitchen ticket by the Toast platform.

{
  "restaurantGuid": "ea0a8ddc-1996-4cd1-bc9b-c9aaabff38dc",
  "orderGuid": "c97d701b-064e-4c4d-9a3a-8063baec086f",
  "selectionGuid": "24431766-9610-435b-9499-e1558de4f38e",
  "selectionMenuItemGuid": "7fe5e9a1-f3f6-451d-a295-457caf4482c6",
  "selectionMenuItemName": "string",
  "selectionMenuItemMultiLocationId": "string",
  "ticketGuid": "3386f58c-aa32-4c32-b6b1-3eddbce86596",
  "ticketFiredAt": "2019-08-24T14:15:22Z",
  "itemFulfilledAt": "2019-08-24T14:15:22Z",
  "itemStartedAt": "2019-08-24T14:15:22Z",
  "itemFulfillmentLevel": 0,
  "prepStationGuid": "e82d0c04-1273-4c79-8df9-4b34fedef2d8",
  "prepStationName": "string",
  "prepStationMultiLocationId": "string",
  "diningOptionGuid": "c2cfa80e-8c9d-4ee4-bcdb-64e895dfe513",
  "diningOptionName": "string",
  "diningOptionBehavior": "string",
  "courseGuid": "c7cdbf7f-6749-4d78-9045-43ac6d277574",
  "courseName": "string",
  "orderSource": "string"
}