Generated by API Evangelist
Written by API Evangelist tooling for Shopify's API. It is a proposal applied on top of the contract, not a document Shopify publishes.
# 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 Items API
version: 1.0.0
extends: openapi/shopify-inventory-items-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_items.json'].get
update:
x-apievangelist-phrasing:
intent: List inventory items by ID
effect: read
questions:
- How do I fetch several inventory items at once when I know their IDs?
- Can I list inventory items without passing IDs, or are IDs required?
- What's the maximum number of inventory items returned per request?
instructions:
- text: Get inventory items {ids}.
slots:
ids: query.ids
- text: Fetch up to {limit} inventory items for IDs {ids}.
slots:
limit: query.limit
ids: query.ids
method: generated
generated: '2026-09-24'
- target: $.paths['/inventory_items/{inventory_item_id}.json'].get
update:
x-apievangelist-phrasing:
intent: Retrieve a single inventory item
effect: read
questions:
- Which call returns one inventory item by its ID?
- Where can I see the details of a single inventory item in Shopify?
instructions:
- text: Show inventory item {inventory_item}.
slots:
inventory_item: path.inventory_item_id
- text: Retrieve the inventory item with ID {inventory_item}.
slots:
inventory_item: path.inventory_item_id
method: generated
generated: '2026-09-24'
- target: $.paths['/inventory_items/{inventory_item_id}.json'].put
update:
x-apievangelist-phrasing:
intent: Update an inventory item
effect: write
questions:
- How do I update an existing inventory item?
- Can I change an inventory item's details after it's created?
instructions:
- text: Update inventory item {inventory_item} with {changes}.
slots:
inventory_item: path.inventory_item_id
changes: requestBody.inventory_item
- text: 'Apply these changes to inventory item {inventory_item}: {changes}.'
slots:
inventory_item: path.inventory_item_id
changes: requestBody.inventory_item
method: generated
generated: '2026-09-24'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.