# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Platform REST Order Fulfillment Forms API
  version: 1.0.0
extends: openapi/vendasta-order-fulfillment-forms-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: 6
- target: $.paths['/orderFulfillmentForms'].get
  update:
    x-apievangelist-phrasing:
      intent: List fulfillment forms for an order
      effect: read
      questions:
      - Which fulfillment forms need filling out for the apps in an order?
      - Does each app in an order get its own fulfillment form entry?
      instructions:
      - text: List fulfillment forms for order {order}.
        slots:
          order: query.ordersID
      - text: Show every app's fulfillment form submission on order {order}.
        slots:
          order: query.ordersID
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orderFulfillmentForms'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods on fulfillment forms
      effect: read
      questions:
      - Which HTTP verbs does the orderFulfillmentForms collection allow?
      - What does a CORS preflight to the fulfillment forms list return?
      instructions:
      - text: Send an OPTIONS preflight to the orderFulfillmentForms collection.
      - text: List permitted verbs on the order fulfillment forms list endpoint.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orderFulfillmentForms/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one app's fulfillment form
      effect: read
      questions:
      - What was last submitted on the fulfillment form for one app in an order?
      - Can I fetch a single fulfillment form by its ID?
      instructions:
      - text: Get fulfillment form {id}.
        slots:
          id: path.id
      - text: Show the latest submission of fulfillment form {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orderFulfillmentForms/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Save answers on a fulfillment form
      effect: write
      questions:
      - How do I fill in the fulfillment details a vendor needs for an order?
      - Does the form submit to the vendor automatically once required fields are filled?
      instructions:
      - text: Save {data} on fulfillment form {id}.
        slots:
          data: requestBody.data
          id: path.id
      - text: Fill in fulfillment form {id} with answers {data}.
        slots:
          id: path.id
          data: requestBody.data
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orderFulfillmentForms/{id}'].options
  update:
    x-apievangelist-phrasing:
      intent: Check allowed methods on one fulfillment form
      effect: read
      questions:
      - Which verbs can a browser use on a single fulfillment form URL?
      - Does one fulfillment form resource allow PATCH cross-origin?
      instructions:
      - text: Run a CORS preflight on fulfillment form {id}.
        slots:
          id: path.id
      - text: Show allowed HTTP methods for the fulfillment form {id} resource.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orderFulfillmentForms/{id}/actions/submit'].post
  update:
    x-apievangelist-phrasing:
      intent: Submit a fulfillment form to the vendor
      effect: write
      questions:
      - Can I force a fulfillment form into review before every required field is filled?
      - When do I need to submit a fulfillment form explicitly instead of relying on auto-submit?
      instructions:
      - text: Submit fulfillment form {id} to the vendor now.
        slots:
          id: path.id
      - text: Save fields {fields} and send fulfillment form {id} for vendor review.
        slots:
          fields: requestBody.fields
          id: path.id
      method: generated
      generated: '2026-10-01'