# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for 2026-07 Consignments API
  version: 1.0.0
extends: openapi/lightspeed-consignments-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: 6
- target: $.paths['/consignments'].get
  update:
    x-apievangelist-phrasing:
      intent: List consignments
      effect: read
      questions:
      - What stock orders, transfers and stocktakes are in progress?
      - Can I filter consignments by type, status or outlet?
      instructions:
      - text: List consignments of type {type} with status {status}.
        slots:
          type: query.type
          status: query.status
      - text: Show consignments for outlet {outlet}.
        slots:
          outlet: query.outlet_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/consignments'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a stock order, transfer or stocktake
      effect: write
      questions:
      - How do I raise a supplier stock order or an outlet transfer?
      - Which consignment types and workflow statuses can I start with?
      instructions:
      - text: Create consignment {consignment}.
        slots:
          consignment: requestBody.data
      - text: Start a new supplier stock order with details {consignment}.
        slots:
          consignment: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/consignments/{consignment_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a consignment
      effect: read
      questions:
      - What is the status of a specific stock order?
      - Can I look up one transfer or stocktake by its ID?
      instructions:
      - text: Get consignment {consignment}.
        slots:
          consignment: path.consignment_id
      - text: Show me stock order {consignment}.
        slots:
          consignment: path.consignment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/consignments/{consignment_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a consignment or advance its status
      effect: write
      questions:
      - How do I mark a supplier order as sent or received?
      - Can I change a consignment's type after it's created?
      instructions:
      - text: Update consignment {consignment} with {changes}.
        slots:
          consignment: path.consignment_id
          changes: requestBody.data
      - text: Move consignment {consignment} to the next workflow status using {changes}.
        slots:
          consignment: path.consignment_id
          changes: requestBody.data
      method: generated
      generated: '2026-09-26'
- target: $.paths['/consignments/{consignment_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a consignment
      effect: destructive
      questions:
      - Can I delete a stock order that was created by mistake?
      - What scope is needed to delete a stock transfer?
      instructions:
      - text: Delete consignment {consignment}.
        slots:
          consignment: path.consignment_id
      - text: Remove stock order {consignment} permanently.
        slots:
          consignment: path.consignment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/consignments/{consignment_id}/totals'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a consignment's item count and cost
      effect: read
      questions:
      - How many items and what total cost are on a stock order?
      - Can I get totals for a stocktake consignment?
      instructions:
      - text: Get the totals for consignment {consignment}.
        slots:
          consignment: path.consignment_id
      - text: Show the count and cost of stock order {consignment}.
        slots:
          consignment: path.consignment_id
      method: generated
      generated: '2026-09-26'