Skip to main content
Skip table of contents

VFO Schema

Oveview

The JSON response described below is generated at the conclusion of the VFO dialog session. The JSON serves as a comprehensive summary of the interaction, encapsulating details about:

  • The restaurant where the dialogue took place,

  • The final list of items ordered by the user,

  • The outcome of the dialogue.

General structure

JSON
{
  "dialog_id": string,            
  "escalated": boolean,             
  "escalation_reason": string,      
  "items": [...],
  "message_type": string,            
  "ocp_group_name": string,          
  "ocp_organization_id": string,     
  "offers": [...],
  "region": string,                  
  "session_id": string,              
  "store_information": {...},
  "test_flag": boolean,              
  "time": integer,                  
  "total_price": decimal         
}

Property

Type

Description

dialog_id

String

Unique identifier for the dialog.

escalated

Boolean

Indicates whether the dialogue required escalation.

escalation_reason

String

Contains the escalation code if the order was escalated (for example, menu issues, payment problems).
This field is optional.

items

Array of items

A detailed list of products ordered by the user.

message_type

String

Type of message (for example, vfo_order).

ocp_group_name

String

Name of the group associated with the store where the order was placed.

ocp_organization_id

String

Unique identifier for the organization to which the dialog belongs.

offers

Array of offers

List of offers and their details applied or suggested with the order.

region

String

The region of the cloud environment that order was placed.

session_id

String

Unique identifier for the session.

store_information

Object

A detailed Information about the store where the order was placed.

test_flag

Boolean

If true, indicates that the dialog is for testing purposes.

time

Integer

Dialog’s start time.

total_price

Double

Total price of the order as announced to the customer

The overall cost of the ordered items, including any modifications and applicable offers.

crew_escalation_type

String

Contains the detailed escalation reason if the order was escalated by a crew member.
This field is optional.

mobile_order_ss

String

Indicates whether the system successfully processed a digital order request.
Allowed values: success, fail.
This field is optional.

drive_away

String

Indicates that the customer drove away early, either before or after ordering any products.
Allowed values: full_cart, empty_cart.
This field is optional.

store_information

This section contains details about the restaurant.

Property

Type

Description

store_id

String

The unique identifier for the store.

legal_entity

String

Legal name of the restaurant entity.

lane

String

The drive-through lane number.

daypart

String

The time of day when the service was availed (for example, breakfast, lunch, afternoon, dinner, evening, lateNight).

city

String

The city where the restaurant is located.

state

String

The state where the restaurant is located.

country

String

The country where the restaurant is located.

items

List of items ordered by the user, with each item having the following details.

Property

Type

Description

quantity

Number

Number of units of the item ordered.

productName

String

Name of the product ordered.

price

Decimal

Price of the individual item.

upsold

Boolean

Indicates if the item was a result of upselling.

modifications

Array

Any modifications made to the item, detailed further below.

modifications

Details about modifications to an item.

Property

Type

Description

quantity

Number

Quantity of the modification.

modifier_subtype

String

Type of modification applied (for example, remove_ingredient).

productName

String

Name of the product being modified.

price

Number

Price adjustment due to the modification.

upsold

Boolean

Indicates if the modification was a result of upselling.

offers

Details about offers or special options during the order.

Property

Type

Description

type

String

Type of offer (for example, donation).

subtype

String

Specific subtype of the offer (for example, roundup).

accepted

Boolean

Indicates if the offer was accepted by the customer.

amount

Decimal

The financial amount associated with the offer or donation.

JSON Example

This JSON example details an order from Taco Bell, indicating the store information, ordered items, total price, and an accepted roundup donation offer.

JSON
{
  "dialog_id": "78977ae3796d73ce0df345f43df8df075daa54a6.1683276326110.63abf63debd946c4bbd4592bc3d800b",
  "escalated": true,
  "escalation_reason": "dummyReason",
  "items": [
    {
      "item": [
        {
          "price": 2.01,
          "productName": "Cinnabon",
          "quantity": 1,
          "upsold": false
        },
        {
          "price": 2.01,
          "productName": "Medium Generic Soda",
          "quantity": 1,
          "upsold": false
        },
        {
          "price": 4.53,
          "productName": "Bread Toast",
          "quantity": 1,
          "upsold": false
        },
        {
           "modifications": [
                      {
                          "quantity": 1,
                          "modifier_subtype": "remove_ingredient",
                          "productName": "Ice",
                          "price": 0,
                          "upsold": false
                      }
                    ],
                },
        {
          "price": 8.55,
          "productName": "Breakfast Combo",
          "quantity": 1,
          "upsold": false
        },
        {
          "price": 0,
          "productName": "Hot Sauce",
          "quantity": 1,
          "upsold": false
        }
  ],
  "message_type": "vfo_order",
  "ocp_group_name": "12345",
  "ocp_organization_id": "12a12ab1-1234-12a1-abcd-a12aa1234567",
  "offers": [
    {
      "accepted": false,
      "amount": 1.18,
      "subtype": "roundup",
      "type": "donation"
    }
  ],
  "region": "aws-us-east-1",
   "session_id": "0DE14D29-95D9-4E63-882F-421BC934588D",
   "store_information": {
    "city": "Juneau",
    "country": "United States",
    "daypart": "breakfast",
    "lane": "1",
    "legal_entity": "AB Legal",
    "state": "Alaska",
    "store_id": "123456"
  },
  "test_flag": false,
  "time": 1738588840891,
  "total_price": 12.12
}
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.