# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Lightspeed Restaurant K Series Order and Pay API
  version: 1.0.0
extends: openapi/lightspeed-order-and-pay-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 20
- target: $.paths['/o/op/data/businesses'].get
  update:
    x-apievangelist-phrasing:
      intent: List businesses and locations for my token
      effect: read
      questions:
      - Which businesses and business locations can my access token reach?
      - How do I find the business location ID I need for ordering calls?
      instructions:
      - text: List every business and business location my access token is linked to.
      - text: Show me the business location IDs available to this integration.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/o/op/data/{businessLocationId}/floorplans'].get
  update:
    x-apievangelist-phrasing:
      intent: List a location's floorplans
      effect: read
      questions:
      - What floorplans are set up for my restaurant location?
      - Can I get the floorplans with their tables expanded in one call?
      instructions:
      - text: List the floorplans for business location {businessLocationId}.
        slots:
          businessLocationId: path.businessLocationId
      - text: Get all floorplans at location {businessLocationId} with tables expanded set to {expandTables}.
        slots:
          businessLocationId: path.businessLocationId
          expandTables: query.expandTables
      method: generated
      generated: '2026-09-26'
- target: $.paths['/o/op/data/{businessLocationId}/floorplans/{floorPlanId}/tables'].get
  update:
    x-apievangelist-phrasing:
      intent: List the tables on one floorplan
      effect: read
      questions:
      - Which tables are on a particular floorplan in my venue?
      - How do I get the table list for just one dining room layout?
      instructions:
      - text: List the tables on floorplan {floorPlanId} at location {businessLocationId}.
        slots:
          floorPlanId: path.floorPlanId
          businessLocationId: path.businessLocationId
      - text: Show the table numbers for floorplan {floorPlanId} in business location {businessLocationId}.
        slots:
          floorPlanId: path.floorPlanId
          businessLocationId: path.businessLocationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/o/op/data/account-profiles'].get
  update:
    x-apievangelist-phrasing:
      intent: List active order profiles for a location
      effect: read
      questions:
      - What order profiles are active at my business location?
      - Where do I find the order profile codes to use when placing online orders?
      instructions:
      - text: List all active order profiles for business location {businessLocationId}.
        slots:
          businessLocationId: query.businessLocationId
      - text: Show me the order profile codes available at location {businessLocationId}.
        slots:
          businessLocationId: query.businessLocationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/o/op/data/{businessLocationId}/account-profiles/tagcode/{tagCode}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one order profile by its code
      effect: read
      questions:
      - How do I look up the details of a single order profile by its code?
      - Can I check what an order profile code like TAKEAWAY is configured to do?
      instructions:
      - text: Get the order profile with code {tagCode} at location {businessLocationId}.
        slots:
          tagCode: path.tagCode
          businessLocationId: path.businessLocationId
      - text: Show the settings of order profile {tagCode} for business location {businessLocationId}.
        slots:
          tagCode: path.tagCode
          businessLocationId: path.businessLocationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/o/op/1/menu/list'].get
  update:
    x-apievangelist-phrasing:
      intent: List the menus at a business location
      effect: read
      questions:
      - Which menus exist for my business location?
      - How can I find the menu IDs before loading a full menu?
      instructions:
      - text: List all menus for business location {businessLocationId}.
        slots:
          businessLocationId: query.businessLocationId
      - text: Show the menu names and IDs at location {businessLocationId}.
        slots:
          businessLocationId: query.businessLocationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/o/op/1/menu/load/{menuId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Load a single menu (deprecated V1)
      effect: read
      questions:
      - How do I load a menu with the older deprecated V1 menu endpoint?
      - Does the V1 single-menu load still work without product modifier groups?
      instructions:
      - text: Load menu {menuId} for location {businessLocationId} using the deprecated V1 endpoint.
        slots:
          menuId: path.menuId
          businessLocationId: query.businessLocationId
      - text: Fetch V1 menu {menuId} at location {businessLocationId} for order profile {accountProfile}.
        slots:
          menuId: path.menuId
          businessLocationId: query.businessLocationId
          accountProfile: query.accountProfile
      method: generated
      generated: '2026-09-26'
- target: $.paths['/o/op/2/menu/load/{menuId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Load a single menu with modifiers (V2)
      effect: read
      questions:
      - How do I load a full menu including product modifier groups and modifiers?
      - Can I get a menu's rich content like descriptions and images in the V2 load?
      instructions:
      - text: Load menu {menuId} for location {businessLocationId} with the V2 endpoint including modifiers.
        slots:
          menuId: path.menuId
          businessLocationId: query.businessLocationId
      - text: Get V2 menu {menuId} at location {businessLocationId} with rich content set to {richContent}.
        slots:
          menuId: path.menuId
          businessLocationId: query.businessLocationId
          richContent: query.richContent
      method: generated
      generated: '2026-09-26'
- target: $.paths['/o/op/1/menu/modifiers'].get
  update:
    x-apievangelist-phrasing:
      intent: List production instructions for a location
      effect: read
      questions:
      - What production instructions like 'no onions' are set up at my location?
      - Where can I get the list of kitchen modifiers for a business location?
      instructions:
      - text: List all production instruction modifiers for location {businessLocationId}.
        slots:
          businessLocationId: query.businessLocationId
      - text: Show the kitchen modifiers configured at business location {businessLocationId}.
        slots:
          businessLocationId: query.businessLocationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/o/op/1/menu/discounts'].get
  update:
    x-apievangelist-phrasing:
      intent: List discounts at a business location
      effect: read
      questions:
      - Which discounts are available at my restaurant location?
      - Can I pull the discount list to show in my ordering app?
      instructions:
      - text: List the discounts configured for business location {businessLocationId}.
        slots:
          businessLocationId: query.businessLocationId
      - text: Get every discount I can apply at location {businessLocationId}.
        slots:
          businessLocationId: query.businessLocationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/o/op/1/order/local'].post
  update:
    x-apievangelist-phrasing:
      intent: Place a dine-in order
      effect: write
      questions:
      - How do I send a dine-in order for a table to the POS?
      - Can a dine-in order include the table number and number of guests?
      - Is it possible to schedule a dine-in order for a later time?
      instructions:
      - text: Place a dine-in order at location {businessLocationId} for table {tableNumber} with reference {thirdPartyReference}.
        slots:
          businessLocationId: requestBody.businessLocationId
          tableNumber: requestBody.tableNumber
          thirdPartyReference: requestBody.thirdPartyReference
      - text: Create a dine-in order via endpoint {endpointId} at location {businessLocationId} for {clientCount} guests.
        slots:
          endpointId: requestBody.endpointId
          businessLocationId: requestBody.businessLocationId
          clientCount: requestBody.clientCount
      method: generated
      generated: '2026-09-26'
- target: $.paths['/o/op/1/order/toGo'].post
  update:
    x-apievangelist-phrasing:
      intent: Place a takeaway or delivery order
      effect: write
      questions:
      - How do I submit a takeaway order from my online ordering site to the POS?
      - Can I send a delivery order with the customer's delivery address?
      instructions:
      - text: Place a takeaway order at location {businessLocationId} with reference {thirdPartyReference}.
        slots:
          businessLocationId: requestBody.businessLocationId
          thirdPartyReference: requestBody.thirdPartyReference
      - text: Create a delivery order at location {businessLocationId} to be delivered to {deliveryAddress}.
        slots:
          businessLocationId: requestBody.businessLocationId
          deliveryAddress: requestBody.deliveryAddress
      method: generated
      generated: '2026-09-26'
- target: $.paths['/o/op/1/order/table/getCheck'].get
  update:
    x-apievangelist-phrasing:
      intent: List all open checks for today
      effect: read
      questions:
      - Which orders are still open today at my location?
      - How can I see every unpaid check for the current day?
      instructions:
      - text: List all open checks today for business location {businessLocationId}.
        slots:
          businessLocationId: query.businessLocationId
      - text: Show every unpaid order for the current day at location {businessLocationId}.
        slots:
          businessLocationId: query.businessLocationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/o/op/1/order/table/{tableNumber}/getCheck'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the open check for a table
      effect: read
      questions:
      - How do I pull up the open bill for a specific table number?
      - If a table has two orders, which open check comes back?
      instructions:
      - text: Get the open check for table {tableNumber} at location {businessLocationId}.
        slots:
          tableNumber: path.tableNumber
          businessLocationId: query.businessLocationId
      - text: Show what table {tableNumber} currently owes at business location {businessLocationId}.
        slots:
          tableNumber: path.tableNumber
          businessLocationId: query.businessLocationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/o/op/1/order/accounts/{accountIdentifier}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a check by its account identifier
      effect: read
      questions:
      - How do I retrieve a check when I only have its account identifier?
      - Can I look up an order by account identifier instead of by table?
      instructions:
      - text: Get the check with account identifier {accountIdentifier} at location {businessLocationId}.
        slots:
          accountIdentifier: path.accountIdentifier
          businessLocationId: query.businessLocationId
      - text: Look up check {accountIdentifier} for business location {businessLocationId}.
        slots:
          accountIdentifier: path.accountIdentifier
          businessLocationId: query.businessLocationId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/o/op/1/pay'].post
  update:
    x-apievangelist-phrasing:
      intent: Apply a payment to an existing order
      effect: write
      questions:
      - How do I record a payment against an open order from my app?
      - Can I include a tip when applying a payment to a check?
      instructions:
      - text: Apply a payment of {paymentAmount} to order {iKaccountIdentifier} at location {businessLocationId}.
        slots:
          paymentAmount: requestBody.paymentAmount
          iKaccountIdentifier: requestBody.iKaccountIdentifier
          businessLocationId: requestBody.businessLocationId
      - text: Pay {paymentAmount} plus a {tipAmount} tip on account {iKaccountId} with reference {thirdPartyPaymentReference}.
        slots:
          paymentAmount: requestBody.paymentAmount
          tipAmount: requestBody.tipAmount
          iKaccountId: requestBody.iKaccountId
          thirdPartyPaymentReference: requestBody.thirdPartyPaymentReference
      method: generated
      generated: '2026-09-26'
- target: $.paths['/o/op/1/printMsg'].post
  update:
    x-apievangelist-phrasing:
      intent: Send a message to the POS screen or printer
      effect: write
      questions:
      - Can I push a notification message to the register screen?
      - What happens to a POS message if the register is offline?
      instructions:
      - text: Send the message {message} to the POS at location {businessLocationId}.
        slots:
          message: requestBody.message
          businessLocationId: query.businessLocationId
      - text: 'Show {message} on the register at location {businessLocationId} and print it too: {alsoToPrinter}.'
        slots:
          message: requestBody.message
          businessLocationId: query.businessLocationId
          alsoToPrinter: requestBody.alsoToPrinter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/o/op/1/itemAvailability'].get
  update:
    x-apievangelist-phrasing:
      intent: Check item availability by SKU
      effect: read
      questions:
      - Which of my menu items are currently unavailable or 86'd?
      - How do I check availability for a few SKUs in the query string?
      instructions:
      - text: Check availability of SKUs {skus} at location {businessLocationId}.
        slots:
          skus: query.skus
          businessLocationId: query.businessLocationId
      - text: Get item availability for {skus} at business location {businessLocationId}, page {page}.
        slots:
          skus: query.skus
          businessLocationId: query.businessLocationId
          page: query.page
      method: generated
      generated: '2026-09-26'
- target: $.paths['/o/op/1/itemAvailability'].post
  update:
    x-apievangelist-phrasing:
      intent: Check availability for a long SKU list
      effect: read
      questions:
      - How do I check availability for a long list of SKUs sent in the request body?
      - Is there a POST version of the item availability lookup for many items?
      instructions:
      - text: Post the SKU list {skus} to check item availability at location {businessLocationId}.
        slots:
          skus: requestBody.skus
          businessLocationId: query.businessLocationId
      - text: Look up availability in bulk for body SKUs {skus} at location {businessLocationId}, {size} per page.
        slots:
          skus: requestBody.skus
          businessLocationId: query.businessLocationId
          size: query.size
      method: generated
      generated: '2026-09-26'
- target: $.paths['/o/op/1/onlineOrderReadiness'].get
  update:
    x-apievangelist-phrasing:
      intent: Check if a location can accept online orders
      effect: read
      questions:
      - Is my business location ready to accept online orders right now?
      - How can I tell whether the POS will take incoming online orders?
      instructions:
      - text: Check online order readiness for business location {businessLocationId}.
        slots:
          businessLocationId: query.businessLocationId
      - text: Tell me whether location {businessLocationId} can accept online orders.
        slots:
          businessLocationId: query.businessLocationId
      method: generated
      generated: '2026-09-26'