API Evangelist conversational phrasing for Shopify Inventory API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Shopify Inventory API
  version: 1.0.0
extends: openapi/shopify-inventory-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: 30
- target: $.paths['/admin/api/2020-01/inventory_items.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up inventory items by ID (2020-01)
      effect: read
      questions:
      - How do I fetch several inventory items at once by their IDs with the 2020-01 API?
      - Is there a cap on how many inventory item IDs version 2020-01 accepts?
      instructions:
      - text: Get inventory items {ids} using version 2020-01.
        slots:
          ids: query.ids
      - text: On 2020-01, look up inventory items {ids}, at most {limit} per page.
        slots:
          ids: query.ids
          limit: query.limit
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/inventory_items.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up inventory items by ID (2020-04)
      effect: read
      questions:
      - Can I pull SKU and cost details for a batch of inventory items on release 2020-04?
      - What's the page size limit when listing inventory items in 2020-04?
      instructions:
      - text: Fetch the inventory item records {ids} via 2020-04.
        slots:
          ids: query.ids
      - text: Using 2020-04, return up to {limit} inventory items from the list {ids}.
        slots:
          ids: query.ids
          limit: query.limit
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/inventory_items.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up inventory items by ID (2020-07)
      effect: read
      questions:
      - Is there a 2020-07 endpoint that retrieves a list of inventory items?
      - Can the 2020-07 version return inventory items for a comma-separated ID list?
      instructions:
      - text: Retrieve inventory items {ids} through API version 2020-07.
        slots:
          ids: query.ids
      - text: Page through inventory items {ids} {limit} at a time on 2020-07.
        slots:
          ids: query.ids
          limit: query.limit
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/inventory_items.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up inventory items by ID
      effect: read
      questions:
      - What call lists inventory items by ID in the 2020-10 Admin API?
      - How many inventory items can I request in one 2020-10 call?
      instructions:
      - text: List inventory items {ids} with the 2020-10 Admin API.
        slots:
          ids: query.ids
      - text: Using 2020-10, show me inventory items {ids}, limited to {limit} results.
        slots:
          ids: query.ids
          limit: query.limit
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/inventory_items.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up inventory items by ID (2021-01)
      effect: read
      questions:
      - Does the January 2021 (2021-01) API let me list inventory items?
      - Can I check whether items are tracked for inventory on 2021-01?
      instructions:
      - text: Show inventory items {ids} via the 2021-01 version.
        slots:
          ids: query.ids
      - text: With API version 2021-01, load at most {limit} inventory items for IDs {ids}.
        slots:
          ids: query.ids
          limit: query.limit
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/inventory_items.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up inventory items by ID (unstable)
      effect: read
      questions:
      - Can I list inventory items through the unstable Admin API?
      - Does the unstable version filter inventory items by ID?
      instructions:
      - text: Get inventory items {ids} against the unstable API.
        slots:
          ids: query.ids
      - text: Use the unstable endpoint to read inventory item records {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/inventory_levels.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List stock levels by item or location (2020-01)
      effect: read
      questions:
      - How can I see available quantities for several items across locations using 2020-01?
      - Can version 2020-01 show inventory levels changed since a date?
      instructions:
      - text: List inventory levels for items {inventory_item_ids} with API version 2020-01.
        slots:
          inventory_item_ids: query.inventory_item_ids
      - text: On 2020-01, show stock levels at locations {location_ids} updated after {updated_at_min}.
        slots:
          location_ids: query.location_ids
          updated_at_min: query.updated_at_min
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/inventory_levels/adjust.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Add or subtract available stock (2020-01)
      effect: write
      questions:
      - How do I add received stock to an item's count at one location with the 2020-01 API?
      - Can I subtract units from available inventory by sending a negative number in 2020-01?
      instructions:
      - text: Adjust available stock of item {inventory_item_id} at location {location_id} by {available_adjustment} using 2020-01.
        slots:
          inventory_item_id: "query.inventory_item_id\n                  required"
          location_id: "query.location_id\n                  required"
          available_adjustment: "query.available_adjustment\n                  required"
      - text: On version 2020-01, change inventory for {inventory_item_id} at {location_id} by {available_adjustment} units.
        slots:
          inventory_item_id: "query.inventory_item_id\n                  required"
          location_id: "query.location_id\n                  required"
          available_adjustment: "query.available_adjustment\n                  required"
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/inventory_levels/set.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Set the exact available stock (2020-01)
      effect: write
      questions:
      - How do I overwrite an item's stock count at a location with an exact number using 2020-01?
      - Can version 2020-01 set inventory after a physical stock count?
      instructions:
      - text: Set available stock of item {inventory_item_id} at location {location_id} to {available} using 2020-01.
        slots:
          inventory_item_id: "query.inventory_item_id\n                  required"
          location_id: "query.location_id\n                  required"
          available: "query.available\n                  required"
      - text: On version 2020-01, record a stock count of {available} for {inventory_item_id} at {location_id}.
        slots:
          inventory_item_id: "query.inventory_item_id\n                  required"
          location_id: "query.location_id\n                  required"
          available: "query.available\n                  required"
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/inventory_levels.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List stock levels by item or location (2020-04)
      effect: read
      questions:
      - Can I query stock on hand for a group of items and warehouses on release 2020-04?
      - What's the maximum number of location IDs I can filter by in 2020-04?
      instructions:
      - text: Get inventory levels for items {inventory_item_ids} at locations {location_ids} via 2020-04.
        slots:
          inventory_item_ids: query.inventory_item_ids
          location_ids: query.location_ids
      - text: Using 2020-04, list available stock across locations {location_ids}.
        slots:
          location_ids: query.location_ids
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/inventory_levels/adjust.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Add or subtract available stock (2020-04)
      effect: write
      questions:
      - Can I increment stock after a delivery arrives using release 2020-04?
      - Does the 2020-04 adjust call change quantity relative to what's already there?
      instructions:
      - text: Increment item {inventory_item_id} at {location_id} by {available_adjustment} via 2020-04.
        slots:
          inventory_item_id: "query.inventory_item_id\n                  required"
          location_id: "query.location_id\n                  required"
          available_adjustment: "query.available_adjustment\n                  required"
      - text: Using 2020-04, apply a stock adjustment of {available_adjustment} to {inventory_item_id} in location {location_id}.
        slots:
          inventory_item_id: "query.inventory_item_id\n                  required"
          location_id: "query.location_id\n                  required"
          available_adjustment: "query.available_adjustment\n                  required"
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/inventory_levels/set.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Set the exact available stock (2020-04)
      effect: write
      questions:
      - Can I connect an item to a new location and set its quantity with release 2020-04?
      - What does disconnect_if_necessary do when setting stock in 2020-04?
      instructions:
      - text: Set item {inventory_item_id} at {location_id} to exactly {available} units via 2020-04.
        slots:
          inventory_item_id: "query.inventory_item_id\n                  required"
          location_id: "query.location_id\n                  required"
          available: "query.available\n                  required"
      - text: Using 2020-04, set {inventory_item_id} to {available} at location {location_id}, disconnecting other locations if needed ({disconnect_if_necessary}).
        slots:
          inventory_item_id: "query.inventory_item_id\n                  required"
          location_id: "query.location_id\n                  required"
          available: "query.available\n                  required"
          disconnect_if_necessary: query.disconnect_if_necessary
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/inventory_levels.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List stock levels by item or location (2020-07)
      effect: read
      questions:
      - Is there a 2020-07 endpoint to list inventory levels across multiple locations?
      - Can the 2020-07 version return only stock levels that changed recently?
      instructions:
      - text: Retrieve inventory levels changed since {updated_at_min} at locations {location_ids} through 2020-07.
        slots:
          location_ids: query.location_ids
          updated_at_min: query.updated_at_min
      - text: Pull stock counts for inventory items {inventory_item_ids} on 2020-07.
        slots:
          inventory_item_ids: query.inventory_item_ids
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/inventory_levels/adjust.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Add or subtract available stock (2020-07)
      effect: write
      questions:
      - Is there a 2020-07 endpoint to adjust available inventory at a single location?
      - Can I record shrinkage or damaged units as a negative adjustment on 2020-07?
      instructions:
      - text: Record a stock change of {available_adjustment} for item {inventory_item_id} at location {location_id} through 2020-07.
        slots:
          inventory_item_id: "query.inventory_item_id\n                  required"
          location_id: "query.location_id\n                  required"
          available_adjustment: "query.available_adjustment\n                  required"
      - text: Decrease or increase {inventory_item_id} at {location_id} by {available_adjustment} on the 2020-07 API.
        slots:
          inventory_item_id: "query.inventory_item_id\n                  required"
          location_id: "query.location_id\n                  required"
          available_adjustment: "query.available_adjustment\n                  required"
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/inventory_levels/set.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Set the exact available stock (2020-07)
      effect: write
      questions:
      - Is there a 2020-07 endpoint to set an absolute inventory quantity at one location?
      - Can I reset a location's stock to zero on 2020-07?
      instructions:
      - text: Reset stock of {inventory_item_id} at location {location_id} to {available} through 2020-07.
        slots:
          inventory_item_id: "query.inventory_item_id\n                  required"
          location_id: "query.location_id\n                  required"
          available: "query.available\n                  required"
      - text: Overwrite the available quantity for item {inventory_item_id} in {location_id} with {available} on the 2020-07 API.
        slots:
          inventory_item_id: "query.inventory_item_id\n                  required"
          location_id: "query.location_id\n                  required"
          available: "query.available\n                  required"
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/inventory_levels.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List stock levels by item or location
      effect: read
      questions:
      - What call lists inventory levels for many items in the 2020-10 Admin API?
      - Which filters narrow down inventory levels on 2020-10 — items, locations, or update date?
      instructions:
      - text: List inventory levels for items {inventory_item_ids} with the 2020-10 Admin API.
        slots:
          inventory_item_ids: query.inventory_item_ids
      - text: Using 2020-10, show stock at locations {location_ids} for items {inventory_item_ids}.
        slots:
          inventory_item_ids: query.inventory_item_ids
          location_ids: query.location_ids
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/inventory_levels/adjust.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Add or subtract available stock
      effect: write
      questions:
      - What call adjusts an item's available quantity by a delta in the 2020-10 Admin API?
      - Can I bump stock up or down at one location without knowing the current count on 2020-10?
      instructions:
      - text: Adjust inventory item {inventory_item_id} at location {location_id} by {available_adjustment} with the 2020-10 Admin API.
        slots:
          inventory_item_id: "query.inventory_item_id\n                  required"
          location_id: "query.location_id\n                  required"
          available_adjustment: "query.available_adjustment\n                  required"
      - text: Using 2020-10, add {available_adjustment} units to item {inventory_item_id} at {location_id}.
        slots:
          inventory_item_id: "query.inventory_item_id\n                  required"
          location_id: "query.location_id\n                  required"
          available_adjustment: "query.available_adjustment\n                  required"
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/inventory_levels/set.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Set the exact available stock
      effect: write
      questions:
      - What call sets an item's exact available quantity in the 2020-10 Admin API?
      - When I set stock on 2020-10, can other connected locations be zeroed and disconnected?
      instructions:
      - text: Set inventory item {inventory_item_id} at location {location_id} to {available} with the 2020-10 Admin API.
        slots:
          inventory_item_id: "query.inventory_item_id\n                  required"
          location_id: "query.location_id\n                  required"
          available: "query.available\n                  required"
      - text: Using 2020-10, make {available} the on-hand count for {inventory_item_id} at {location_id}, with disconnect_if_necessary {disconnect_if_necessary}.
        slots:
          inventory_item_id: "query.inventory_item_id\n                  required"
          location_id: "query.location_id\n                  required"
          available: "query.available\n                  required"
          disconnect_if_necessary: query.disconnect_if_necessary
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/inventory_levels.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List stock levels by item or location (2021-01)
      effect: read
      questions:
      - Does the January 2021 (2021-01) API let me list inventory levels in bulk?
      - Can I sync inventory changes since my last run on 2021-01?
      instructions:
      - text: Sync inventory levels updated after {updated_at_min} across {location_ids} via the 2021-01 version.
        slots:
          location_ids: query.location_ids
          updated_at_min: query.updated_at_min
      - text: With API version 2021-01, fetch stock levels for items {inventory_item_ids}.
        slots:
          inventory_item_ids: query.inventory_item_ids
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/inventory_levels/adjust.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Add or subtract available stock (2021-01)
      effect: write
      questions:
      - Does the January 2021 (2021-01) API support relative inventory adjustments?
      - Can I remove sold-offline units from a location's stock on 2021-01?
      instructions:
      - text: 'Remove sold-offline units: adjust {inventory_item_id} at {location_id} by {available_adjustment} via 2021-01.'
        slots:
          inventory_item_id: "query.inventory_item_id\n                  required"
          location_id: "query.location_id\n                  required"
          available_adjustment: "query.available_adjustment\n                  required"
      - text: With API version 2021-01, shift available stock for item {inventory_item_id} at location {location_id} by {available_adjustment}.
        slots:
          inventory_item_id: "query.inventory_item_id\n                  required"
          location_id: "query.location_id\n                  required"
          available_adjustment: "query.available_adjustment\n                  required"
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/inventory_levels/set.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Set the exact available stock (2021-01)
      effect: write
      questions:
      - Does the January 2021 (2021-01) API let me set absolute stock levels?
      - Can I sync counts from my warehouse system by setting exact quantities on 2021-01?
      instructions:
      - text: 'Sync the warehouse count: set {inventory_item_id} at {location_id} to {available} via 2021-01.'
        slots:
          inventory_item_id: "query.inventory_item_id\n                  required"
          location_id: "query.location_id\n                  required"
          available: "query.available\n                  required"
      - text: With API version 2021-01, fix available stock for item {inventory_item_id} at location {location_id} at {available}.
        slots:
          inventory_item_id: "query.inventory_item_id\n                  required"
          location_id: "query.location_id\n                  required"
          available: "query.available\n                  required"
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/inventory_levels.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List stock levels by item or location (unstable)
      effect: read
      questions:
      - Can I list inventory levels through the unstable Admin API?
      - Does the unstable version filter stock levels by location IDs?
      instructions:
      - text: Get inventory levels at locations {location_ids} against the unstable API.
        slots:
          location_ids: query.location_ids
      - text: Use the unstable endpoint to list stock for items {inventory_item_ids} at {location_ids}.
        slots:
          inventory_item_ids: query.inventory_item_ids
          location_ids: query.location_ids
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/inventory_levels/adjust.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Add or subtract available stock (unstable)
      effect: write
      questions:
      - Can I adjust inventory levels through the unstable Admin API?
      - Does the unstable version accept negative inventory adjustments?
      instructions:
      - text: Adjust stock for {inventory_item_id} at {location_id} by {available_adjustment} against the unstable API.
        slots:
          inventory_item_id: "query.inventory_item_id\n                  required"
          location_id: "query.location_id\n                  required"
          available_adjustment: "query.available_adjustment\n                  required"
      - text: Use the unstable endpoint to modify available quantity of item {inventory_item_id} at location {location_id} by {available_adjustment}.
        slots:
          inventory_item_id: "query.inventory_item_id\n                  required"
          location_id: "query.location_id\n                  required"
          available_adjustment: "query.available_adjustment\n                  required"
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/inventory_levels/set.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Set the exact available stock (unstable)
      effect: write
      questions:
      - Can I set inventory levels through the unstable Admin API?
      - Does the unstable version support connecting an item to a location while setting stock?
      instructions:
      - text: Set stock for {inventory_item_id} at {location_id} to {available} against the unstable API.
        slots:
          inventory_item_id: "query.inventory_item_id\n                  required"
          location_id: "query.location_id\n                  required"
          available: "query.available\n                  required"
      - text: Use the unstable endpoint to assign {available} available units to item {inventory_item_id} at location {location_id}.
        slots:
          inventory_item_id: "query.inventory_item_id\n                  required"
          location_id: "query.location_id\n                  required"
          available: "query.available\n                  required"
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/locations/{location_id}/inventory_levels.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List all stock held at one location (2020-01)
      effect: read
      questions:
      - How do I see everything stocked at a single warehouse with the 2020-01 API?
      - Can version 2020-01 list inventory levels scoped to one location ID?
      instructions:
      - text: List all inventory levels at location {location_id} using 2020-01.
        slots:
          location_id: path.location_id
      - text: On version 2020-01, show every item's stock held at warehouse {location_id}.
        slots:
          location_id: path.location_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/locations/{location_id}/inventory_levels.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List all stock held at one location (2020-04)
      effect: read
      questions:
      - Can I audit one store location's inventory with release 2020-04?
      - Which endpoint in 2020-04 returns the stock levels of a given location?
      instructions:
      - text: Audit the inventory at location {location_id} via 2020-04.
        slots:
          location_id: path.location_id
      - text: Using 2020-04, get the stock levels belonging to location {location_id}.
        slots:
          location_id: path.location_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/locations/{location_id}/inventory_levels.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List all stock held at one location (2020-07)
      effect: read
      questions:
      - Is there a 2020-07 endpoint for a single location's inventory levels?
      - Can I check what a retail store has on hand using 2020-07?
      instructions:
      - text: Retrieve on-hand stock for store location {location_id} through API version 2020-07.
        slots:
          location_id: path.location_id
      - text: Show what location {location_id} holds on 2020-07.
        slots:
          location_id: path.location_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/locations/{location_id}/inventory_levels.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List all stock held at one location
      effect: read
      questions:
      - What call lists a location's inventory levels in the 2020-10 Admin API?
      - Can I pull the full stock sheet for one warehouse on version 2020-10?
      instructions:
      - text: List inventory levels for location {location_id} with the 2020-10 Admin API.
        slots:
          location_id: path.location_id
      - text: Using 2020-10, pull the full stock sheet of warehouse {location_id}.
        slots:
          location_id: path.location_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/locations/{location_id}/inventory_levels.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List all stock held at one location (2021-01)
      effect: read
      questions:
      - Does the January 2021 (2021-01) API list stock for a single location?
      - Can I review a pop-up shop's inventory by location on 2021-01?
      instructions:
      - text: Review the inventory of pop-up location {location_id} via the 2021-01 version.
        slots:
          location_id: path.location_id
      - text: With API version 2021-01, fetch every inventory level at location {location_id}.
        slots:
          location_id: path.location_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/locations/{location_id}/inventory_levels.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List all stock held at one location (unstable)
      effect: read
      questions:
      - Can I list a location's inventory through the unstable Admin API?
      - Is per-location stock listing supported on the unstable version?
      instructions:
      - text: Get stock levels at location {location_id} against the unstable API.
        slots:
          location_id: path.location_id
      - text: Use the unstable endpoint to list inventory held by location {location_id}.
        slots:
          location_id: path.location_id
      method: generated
      generated: '2026-09-24'