# 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 Inventory API
  version: 1.0.0
extends: openapi/lightspeed-inventory-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: 10
- target: $.paths['/custom_inventory_adjustment_reasons'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom inventory adjustment reasons
      effect: read
      questions:
      - What custom reasons have we set up for adjusting stock?
      - Can I page through our custom stock adjustment reasons?
      instructions:
      - text: List our custom inventory adjustment reasons.
      - text: Show custom stock adjustment reasons, {page_size} per page.
        slots:
          page_size: query.page_size
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom_inventory_adjustment_reasons'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom inventory adjustment reason
      effect: write
      questions:
      - How do I add a new reason like 'water damage' for stock adjustments?
      - Can I create a custom adjustment reason that starts out disabled?
      instructions:
      - text: Create a custom adjustment reason named {name} of type {type}, enabled {enabled}.
        slots:
          name: requestBody.name
          type: requestBody.type
          enabled: requestBody.enabled
      - text: Add {name} as a new {type} reason for inventory adjustments, with enabled set to {enabled}.
        slots:
          name: requestBody.name
          type: requestBody.type
          enabled: requestBody.enabled
      method: generated
      generated: '2026-09-26'
- target: $.paths['/custom_inventory_adjustment_reasons/{custom_reason_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename or toggle an adjustment reason
      effect: write
      questions:
      - How do I disable a custom stock adjustment reason we no longer use?
      - Can I rename an existing custom adjustment reason?
      instructions:
      - text: Rename custom adjustment reason {custom_reason_id} to {name}.
        slots:
          custom_reason_id: path.custom_reason_id
          name: requestBody.name
      - text: Set enabled to {enabled} on custom adjustment reason {custom_reason_id}.
        slots:
          enabled: requestBody.enabled
          custom_reason_id: path.custom_reason_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/inventory'].post
  update:
    x-apievangelist-phrasing:
      intent: List inventory records across products
      effect: read
      questions:
      - How do I pull inventory records for all products and outlets?
      - Can the inventory record list include deleted records?
      instructions:
      - text: List inventory records across all products.
      - text: 'Get inventory records for product {product_id}, including deleted ones: {include_deleted}.'
        slots:
          product_id: requestBody.product_id
          include_deleted: requestBody.include_deleted
      method: generated
      generated: '2026-09-26'
- target: $.paths['/inventory/reorder_points'].post
  update:
    x-apievangelist-phrasing:
      intent: Set reorder points for products at outlets
      effect: write
      questions:
      - How do I set the reorder point for products at specific outlets?
      - Does the reorder method have to match across a product's variants?
      instructions:
      - text: Set reorder points for these products at their outlets.
      - text: Update the reorder thresholds for a product family across outlets.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/inventory/{product_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get inventory records for one product
      effect: read
      questions:
      - How much of a specific product do we have at each outlet?
      - Can I include the variants when looking up one product's inventory records?
      instructions:
      - text: Get the inventory records for product {product_id} at all outlets.
        slots:
          product_id: path.product_id
      - text: 'Show inventory records for product {product_id} with variants included: {variants}.'
        slots:
          product_id: path.product_id
          variants: query.variants
      method: generated
      generated: '2026-09-26'
- target: $.paths['/inventory_levels'].post
  update:
    x-apievangelist-phrasing:
      intent: List inventory levels with filters
      effect: read
      questions:
      - Which products need to be procured based on current inventory levels?
      - Can I filter inventory levels by supplier or outlet location?
      instructions:
      - text: List inventory levels at locations {location_ids}.
        slots:
          location_ids: requestBody.location_ids
      - text: 'Show inventory levels for supplier {supplier_ids}, only items to be procured: {to_be_procured_only}.'
        slots:
          supplier_ids: requestBody.supplier_ids
          to_be_procured_only: requestBody.to_be_procured_only
      method: generated
      generated: '2026-09-26'
- target: $.paths['/inventory_levels/{product_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get inventory levels for one product
      effect: read
      questions:
      - What are the current stock levels for a single product?
      - Can I include inactive outlets when checking one product's levels?
      instructions:
      - text: Get inventory levels for product {product_id}.
        slots:
          product_id: path.product_id
      - text: 'Show stock levels for product {product_id} including inactive ones: {include_inactive}.'
        slots:
          product_id: path.product_id
          include_inactive: query.include_inactive
      method: generated
      generated: '2026-09-26'
- target: $.paths['/stock_adjustments'].get
  update:
    x-apievangelist-phrasing:
      intent: List stock adjustments
      effect: read
      questions:
      - What stock adjustments have been made recently?
      - How do I page through the history of inventory adjustments?
      instructions:
      - text: List our stock adjustments.
      - text: Show stock adjustments after cursor {after}, {page_size} per page.
        slots:
          after: query.after
          page_size: query.page_size
      method: generated
      generated: '2026-09-26'
- target: $.paths['/stock_adjustments'].post
  update:
    x-apievangelist-phrasing:
      intent: Adjust stock for items in a batch
      effect: write
      questions:
      - How do I adjust stock counts for many items in one request?
      - What's the maximum number of stock adjustments per batch?
      instructions:
      - text: 'Create these stock adjustments: {stock_adjustments}.'
        slots:
          stock_adjustments: requestBody.stock_adjustments
      - text: Record a batch of inventory adjustments {stock_adjustments}.
        slots:
          stock_adjustments: requestBody.stock_adjustments
      method: generated
      generated: '2026-09-26'