Shopify · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Shopify Get API

9 actions 9 updates phrasing extends openapi/shopify-get-api-openapi.yml

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.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 9

$.info

$.paths['/admin/api/2020-01/products/{product_id}/images/{image_id}.json'].get

$.paths['/admin/api/2020-04/products/{product_id}/images/{image_id}.json'].get

$.paths['/admin/api/2020-07/products/{product_id}/images/{image_id}.json'].get

$.paths['/admin/api/2020-10/products/{product_id}/images/{image_id}.json'].get

$.paths['/admin/api/2021-01/products/{product_id}/images/{image_id}.json'].get

$.paths['/admin/api/unstable/products/{product_id}/images/{image_id}.json'].get

$.paths['/fetch_tracking_numbers'].get

$.paths['/fetch_stock'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Shopify Get API
  version: 1.0.0
extends: openapi/shopify-get-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: 8
- target: $.paths['/admin/api/2020-01/products/{product_id}/images/{image_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one product image (API 2020-01)
      effect: read
      questions:
      - How do I fetch a single image of a product by its ID on API 2020-01?
      - Can a 2020-01 product image lookup return only certain fields?
      instructions:
      - text: Get image {image_id} of product {product_id} using version 2020-01.
        slots:
          image_id: path.image_id
          product_id: path.product_id
      - text: Show only {fields} for image {image_id} on product {product_id}, January 2020 API.
        slots:
          fields: query.fields
          image_id: path.image_id
          product_id: path.product_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/products/{product_id}/images/{image_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one product image (API 2020-04)
      effect: read
      questions:
      - Which April 2020 call returns one specific product image?
      - Is there a fields filter when reading a product image on 2020-04?
      instructions:
      - text: Fetch product {product_id}'s image {image_id} via 2020-04.
        slots:
          product_id: path.product_id
          image_id: path.image_id
      - text: 'April 2020 release: return {fields} of image {image_id} for product {product_id}.'
        slots:
          fields: query.fields
          image_id: path.image_id
          product_id: path.product_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/products/{product_id}/images/{image_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one product image (API 2020-07)
      effect: read
      questions:
      - Where do I read a single product photo's details on the July 2020 API?
      - Can I limit the fields of a 2020-07 product image response?
      instructions:
      - text: Look up image {image_id} on product {product_id} with API 2020-07.
        slots:
          image_id: path.image_id
          product_id: path.product_id
      - text: Using July 2020, get the {fields} of product {product_id} image {image_id}.
        slots:
          fields: query.fields
          product_id: path.product_id
          image_id: path.image_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/products/{product_id}/images/{image_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one product image (API 2020-10)
      effect: read
      questions:
      - What's the 2020-10 way to retrieve one image from a product?
      - Does the October 2020 product image endpoint honor a fields list?
      instructions:
      - text: Retrieve image {image_id} from product {product_id}, version 2020-10.
        slots:
          image_id: path.image_id
          product_id: path.product_id
      - text: 'October 2020: show {fields} for product {product_id}''s image {image_id}.'
        slots:
          fields: query.fields
          product_id: path.product_id
          image_id: path.image_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/products/{product_id}/images/{image_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one product image (API 2021-01)
      effect: read
      questions:
      - How can I view a single product image by ID on the 2021-01 release?
      - Will the January 2021 image lookup return just the fields I request?
      instructions:
      - text: View image {image_id} of product {product_id} on 2021-01.
        slots:
          image_id: path.image_id
          product_id: path.product_id
      - text: 'January 2021 API: return {fields} for image {image_id} on product {product_id}.'
        slots:
          fields: query.fields
          image_id: path.image_id
          product_id: path.product_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/products/{product_id}/images/{image_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one product image (unstable API)
      effect: read
      questions:
      - Can I get one product image through the unstable Admin API?
      - Does the unstable product image call accept a fields parameter?
      instructions:
      - text: Get product {product_id} image {image_id} on unstable.
        slots:
          product_id: path.product_id
          image_id: path.image_id
      - text: Via unstable, fetch {fields} of image {image_id} belonging to product {product_id}.
        slots:
          fields: query.fields
          image_id: path.image_id
          product_id: path.product_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/fetch_tracking_numbers'].get
  update:
    x-apievangelist-phrasing:
      intent: Get tracking numbers for fulfillments
      effect: read
      questions:
      - How does a fulfillment service supply tracking numbers for a merchant's orders?
      - 'Can I request tracking numbers for several fulfillments like #1001.1 at once?'
      instructions:
      - text: Fetch tracking numbers for fulfillments {order_names}.
        slots:
          order_names: query.order_names
      - text: Get tracking numbers for {order_names} on shop {shop}.
        slots:
          order_names: query.order_names
          shop: query.shop
      method: generated
      generated: '2026-09-24'
- target: $.paths['/fetch_stock'].get
  update:
    x-apievangelist-phrasing:
      intent: Get stock levels from a fulfillment service
      effect: read
      questions:
      - How does a fulfillment service report inventory levels for a SKU?
      - What stock information comes back when the store asks my fulfillment service for inventory?
      instructions:
      - text: Get the stock level for SKU {sku}.
        slots:
          sku: query.sku
      - text: Fetch inventory for SKU {sku} at shop {shop}.
        slots:
          sku: query.sku
          shop: query.shop
      method: generated
      generated: '2026-09-24'

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this

find_overlaysBrowse and filter every overlay in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This overlay

curl "https://apis.io/api/v1/overlays/shopify-get-api-phrasing-overlay"

All openapi overlays

curl "https://apis.io/api/v1/overlays?limit=25"

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.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.