Toast · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Kitchen Export API

2 actions 2 updates phrasing extends openapi/toast-export-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Toast's API. It is a proposal applied on top of the contract, not a document Toast publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info

$.paths['/export/itemFulfillments'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Kitchen Export API
  version: 1.0.0
extends: openapi/toast-export-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 1
- target: $.paths['/export/itemFulfillments'].get
  update:
    x-apievangelist-phrasing:
      intent: Export item fulfillments for a business date
      effect: read
      questions:
      - Can I export all item fulfillments for a single business date?
      - What fulfillment data is available for one day's items?
      instructions:
      - text: Export item fulfillments for business date {date}.
        slots:
          date: query.businessDate
      - text: Download the item fulfillment export for {date}.
        slots:
          date: query.businessDate
      method: generated
      generated: '2026-10-01'