Toast Orders API — Orders

naftiko: 1.0.0-alpha2
info:
  label: Toast Orders API — Orders
  description: 'Toast Orders API — Orders. 8 operations. Lead operation: Toast Post an Order. Self-contained Naftiko capability
    covering one Toast business surface.'
  tags:
  - Toast
  - Orders
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    TOAST_API_KEY: TOAST_API_KEY
capability:
  consumes:
  - type: http
    namespace: orders-orders
    baseUri: https://toast-api-server/orders/v2
    description: Toast Orders API — Orders business capability. Self-contained, no shared references.
    resources:
    - name: orders
      path: /orders
      operations:
      - name: orderspost
        method: POST
        description: Toast Post an Order
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Toast-Restaurant-External-ID
          in: header
          type: string
          description: The identifier for the restaurant where this order was placed.
          required: true
        - name: body
          in: body
          type: string
          description: A JSON object containing information about an order.
          required: true
      - name: ordersget
        method: GET
        description: Toast Get Order Identifiers (deprecated)
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Toast-Restaurant-External-ID
          in: header
          type: string
          description: The identifier for the restaurant to retrieve orders from.
          required: true
        - name: startDate
          in: query
          type: string
          description: \
        - name: endDate
          in: query
          type: string
          description: The exclusive end date and time. The results exclude orders with an equal
        - name: businessDate
          in: query
          type: string
          description: The business date that same-day orders opened or that
    - name: orders-guid
      path: /orders/{guid}
      operations:
      - name: ordersguidget
        method: GET
        description: Toast Get an Order
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Toast-Restaurant-External-ID
          in: header
          type: string
          description: The identifier of the restaurant where this order was placed.
          required: true
        - name: guid
          in: path
          type: string
          description: The GUID for the order to be returned.
          required: true
    - name: orders-orderGuid-checks-checkGuid-selections
      path: /orders/{orderGuid}/checks/{checkGuid}/selections
      operations:
      - name: ordersorderguidcheckscheckguidselectionspost
        method: POST
        description: Toast Add Items to a Check
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Toast-Restaurant-External-ID
          in: header
          type: string
          description: The identifier of the restaurant.
          required: true
        - name: orderGuid
          in: path
          type: string
          description: The Toast platform identifier of the order that you are
          required: true
        - name: checkGuid
          in: path
          type: string
          description: The Toast platform identifier of the check that you are
          required: true
        - name: body
          in: body
          type: array
          description: An array of JSON `Selection` objects that identify the menu items you are adding.
          required: true
    - name: orders-orderGuid-deliveryInfo
      path: /orders/{orderGuid}/deliveryInfo
      operations:
      - name: ordersorderguiddeliveryinfopatch
        method: PATCH
        description: Toast Update Delivery Information
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Toast-Restaurant-External-ID
          in: header
          type: string
          description: The identifier of the restaurant.
          required: true
        - name: orderGuid
          in: path
          type: string
          description: The Toast platform identifier of the order that you are
          required: true
        - name: body
          in: body
          type: object
          description: A JSON `DeliveryInfo` object
          required: true
    - name: orders-orderGuid-void
      path: /orders/{orderGuid}/void
      operations:
      - name: voidorder
        method: POST
        description: Toast Void an Order
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Toast-Restaurant-External-ID
          in: header
          type: string
          description: The identifier of the restaurant.
          required: true
        - name: orderGuid
          in: path
          type: string
          description: The GUID of the order to be voided.
          required: true
        - name: body
          in: body
          type: object
    - name: ordersBulk
      path: /ordersBulk
      operations:
      - name: ordersbulkget
        method: GET
        description: Toast Get Multiple Orders
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Toast-Restaurant-External-ID
          in: header
          type: string
          description: The identifier for the restaurant that processed the orders.
          required: true
        - name: startDate
          in: query
          type: string
          description: The inclusive start date and time. The results include orders with a modified
        - name: endDate
          in: query
          type: string
          description: The exclusive end date and time. The results exclude any orders that have
        - name: businessDate
          in: query
          type: string
          description: The business date that same-day orders opened or that
        - name: pageSize
          in: query
          type: integer
          description: The maximum number of objects to return in the array. If the
        - name: page
          in: query
          type: integer
          description: The sequence number of the set of objects to return in
    - name: prices
      path: /prices
      operations:
      - name: pricespost
        method: POST
        description: Toast Get Order Prices
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Toast-Restaurant-External-ID
          in: header
          type: string
          description: The identifier of the restaurant to be used for this price
          required: true
        - name: body
          in: body
          type: string
          description: A _required_ JSON `Order` object containing information about
          required: true
  exposes:
  - type: rest
    namespace: orders-orders-rest
    port: 8080
    description: REST adapter for Toast Orders API — Orders. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/orders
      name: orders
      description: REST surface for orders.
      operations:
      - method: POST
        name: orderspost
        description: Toast Post an Order
        call: orders-orders.orderspost
        with:
          Toast-Restaurant-External-ID: rest.Toast-Restaurant-External-ID
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: ordersget
        description: Toast Get Order Identifiers (deprecated)
        call: orders-orders.ordersget
        with:
          Toast-Restaurant-External-ID: rest.Toast-Restaurant-External-ID
          startDate: rest.startDate
          endDate: rest.endDate
          businessDate: rest.businessDate
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/orders/{guid}
      name: orders-guid
      description: REST surface for orders-guid.
      operations:
      - method: GET
        name: ordersguidget
        description: Toast Get an Order
        call: orders-orders.ordersguidget
        with:
          Toast-Restaurant-External-ID: rest.Toast-Restaurant-External-ID
          guid: rest.guid
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/orders/{orderguid}/checks/{checkguid}/selections
      name: orders-orderguid-checks-checkguid-selections
      description: REST surface for orders-orderGuid-checks-checkGuid-selections.
      operations:
      - method: POST
        name: ordersorderguidcheckscheckguidselectionspost
        description: Toast Add Items to a Check
        call: orders-orders.ordersorderguidcheckscheckguidselectionspost
        with:
          Toast-Restaurant-External-ID: rest.Toast-Restaurant-External-ID
          orderGuid: rest.orderGuid
          checkGuid: rest.checkGuid
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/orders/{orderguid}/deliveryinfo
      name: orders-orderguid-deliveryinfo
      description: REST surface for orders-orderGuid-deliveryInfo.
      operations:
      - method: PATCH
        name: ordersorderguiddeliveryinfopatch
        description: Toast Update Delivery Information
        call: orders-orders.ordersorderguiddeliveryinfopatch
        with:
          Toast-Restaurant-External-ID: rest.Toast-Restaurant-External-ID
          orderGuid: rest.orderGuid
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/orders/{orderguid}/void
      name: orders-orderguid-void
      description: REST surface for orders-orderGuid-void.
      operations:
      - method: POST
        name: voidorder
        description: Toast Void an Order
        call: orders-orders.voidorder
        with:
          Toast-Restaurant-External-ID: rest.Toast-Restaurant-External-ID
          orderGuid: rest.orderGuid
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/ordersbulk
      name: ordersbulk
      description: REST surface for ordersBulk.
      operations:
      - method: GET
        name: ordersbulkget
        description: Toast Get Multiple Orders
        call: orders-orders.ordersbulkget
        with:
          Toast-Restaurant-External-ID: rest.Toast-Restaurant-External-ID
          startDate: rest.startDate
          endDate: rest.endDate
          businessDate: rest.businessDate
          pageSize: rest.pageSize
          page: rest.page
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/prices
      name: prices
      description: REST surface for prices.
      operations:
      - method: POST
        name: pricespost
        description: Toast Get Order Prices
        call: orders-orders.pricespost
        with:
          Toast-Restaurant-External-ID: rest.Toast-Restaurant-External-ID
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: orders-orders-mcp
    port: 9090
    transport: http
    description: MCP adapter for Toast Orders API — Orders. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: toast-post-order
      description: Toast Post an Order
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: orders-orders.orderspost
      with:
        Toast-Restaurant-External-ID: tools.Toast-Restaurant-External-ID
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: toast-get-order-identifiers-deprecated
      description: Toast Get Order Identifiers (deprecated)
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: orders-orders.ordersget
      with:
        Toast-Restaurant-External-ID: tools.Toast-Restaurant-External-ID
        startDate: tools.startDate
        endDate: tools.endDate
        businessDate: tools.businessDate
      outputParameters:
      - type: object
        mapping: $.
    - name: toast-get-order
      description: Toast Get an Order
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: orders-orders.ordersguidget
      with:
        Toast-Restaurant-External-ID: tools.Toast-Restaurant-External-ID
        guid: tools.guid
      outputParameters:
      - type: object
        mapping: $.
    - name: toast-add-items-check
      description: Toast Add Items to a Check
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: orders-orders.ordersorderguidcheckscheckguidselectionspost
      with:
        Toast-Restaurant-External-ID: tools.Toast-Restaurant-External-ID
        orderGuid: tools.orderGuid
        checkGuid: tools.checkGuid
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: toast-update-delivery-information
      description: Toast Update Delivery Information
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: orders-orders.ordersorderguiddeliveryinfopatch
      with:
        Toast-Restaurant-External-ID: tools.Toast-Restaurant-External-ID
        orderGuid: tools.orderGuid
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: toast-void-order
      description: Toast Void an Order
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: orders-orders.voidorder
      with:
        Toast-Restaurant-External-ID: tools.Toast-Restaurant-External-ID
        orderGuid: tools.orderGuid
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: toast-get-multiple-orders
      description: Toast Get Multiple Orders
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: orders-orders.ordersbulkget
      with:
        Toast-Restaurant-External-ID: tools.Toast-Restaurant-External-ID
        startDate: tools.startDate
        endDate: tools.endDate
        businessDate: tools.businessDate
        pageSize: tools.pageSize
        page: tools.page
      outputParameters:
      - type: object
        mapping: $.
    - name: toast-get-order-prices
      description: Toast Get Order Prices
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: orders-orders.pricespost
      with:
        Toast-Restaurant-External-ID: tools.Toast-Restaurant-External-ID
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.