# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Shopify Admin REST Inventory Levels API
  version: 1.0.0
extends: openapi/shopify-inventory-levels-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-24'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/inventory_levels.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up stock levels by item or location
      effect: read
      questions:
      - How much stock of certain items do I have across my locations?
      - Can I check inventory for several items at several locations in one request?
      - What's the maximum number of inventory levels returned per page?
      instructions:
      - text: Show inventory levels for items {inventory_item_ids}.
        slots:
          inventory_item_ids: query.inventory_item_ids
      - text: List stock levels at locations {location_ids}, up to {limit} results.
        slots:
          location_ids: query.location_ids
          limit: query.limit
      method: generated
      generated: '2026-09-24'
- target: $.paths['/inventory_levels/set.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Set an item's available quantity at a location
      effect: write
      questions:
      - After a stock count, how do I overwrite the available quantity of an item at one location?
      - Can I set an exact on-hand number rather than adjusting by a delta?
      instructions:
      - text: Set item {inventory_item_id} to {available} available at location {location_id}.
        slots:
          inventory_item_id: requestBody.inventory_item_id
          available: requestBody.available
          location_id: requestBody.location_id
      - text: Make the available stock of inventory item {inventory_item_id} at {location_id} exactly {available}.
        slots:
          inventory_item_id: requestBody.inventory_item_id
          location_id: requestBody.location_id
          available: requestBody.available
      method: generated
      generated: '2026-09-24'
- target: $.paths['/locations/{location_id}/inventory_levels.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List all stock levels at one location
      effect: read
      questions:
      - What does everything stocked at one warehouse look like?
      - Can I see every item's inventory level for a single location?
      instructions:
      - text: List all inventory levels at location {location_id}.
        slots:
          location_id: path.location_id
      - text: Show the full stock sheet for store location {location_id}.
        slots:
          location_id: path.location_id
      method: generated
      generated: '2026-09-24'