Shopify · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Shopify Product API

13 actions 13 updates phrasing extends openapi/shopify-product-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 13

$.info
$.paths['/admin/api/2020-01/products.json'].post
$.paths['/admin/api/2020-01/products/{product_id}.json'].get
$.paths['/admin/api/2020-04/products.json'].post
$.paths['/admin/api/2020-04/products/{product_id}.json'].get
$.paths['/admin/api/2020-07/products.json'].post
$.paths['/admin/api/2020-07/products/{product_id}.json'].get
$.paths['/admin/api/2020-10/products.json'].post
$.paths['/admin/api/2020-10/products/{product_id}.json'].get
$.paths['/admin/api/2021-01/products.json'].post
$.paths['/admin/api/2021-01/products/{product_id}.json'].get
$.paths['/admin/api/unstable/products.json'].post
$.paths['/admin/api/unstable/products/{product_id}.json'].get

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Shopify Product API
  version: 1.0.0
extends: openapi/shopify-product-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: 12
- target: $.paths['/admin/api/2020-01/products.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a product (API 2020-01)
      effect: write
      questions:
      - Can I add a new product to my Shopify catalog with the 2020-01 Admin API?
      - Which API version-2020-01 call creates a product listing?
      instructions:
      - text: Create a new product in my store using API 2020-01.
      - text: Add a product to the catalog through the 2020-01 products endpoint.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/products/{product_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one product (API 2020-01)
      effect: read
      questions:
      - What does API 2020-01 return when I look up one product by ID?
      - Can I fetch a single product with only a few fields on version 2020-01?
      instructions:
      - text: Get product {product_id} using API 2020-01.
        slots:
          product_id: path.product_id
      - text: Show {fields} for product {product_id} on version 2020-01.
        slots:
          fields: query.fields
          product_id: path.product_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/products.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a product (API 2020-04)
      effect: write
      questions:
      - Is there a 2020-04 endpoint for creating a new product?
      - Can version 2020-04 add products to my shop's catalog?
      instructions:
      - text: Create a product via the 2020-04 Admin API.
      - text: Publish a brand-new product record with API version 2020-04.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/products/{product_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one product (API 2020-04)
      effect: read
      questions:
      - Can I pull the full record of one product with API 2020-04?
      - Which fields can I limit a 2020-04 single-product lookup to?
      instructions:
      - text: Retrieve product {product_id} through the 2020-04 endpoint.
        slots:
          product_id: path.product_id
      - text: Fetch product {product_id} with fields {fields} via API 2020-04.
        slots:
          product_id: path.product_id
          fields: query.fields
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/products.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a product (API 2020-07)
      effect: write
      questions:
      - Can I create products in my store using version 2020-07?
      - Where does the 2020-07 API let me add a new item to my catalog?
      instructions:
      - text: Create a new product on API 2020-07.
      - text: Add one product to my shop with the 2020-07 products call.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/products/{product_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one product (API 2020-07)
      effect: read
      questions:
      - What details does version 2020-07 give me for a single product?
      - Can I look up one product by its ID on API 2020-07?
      instructions:
      - text: Get the product with ID {product_id} on version 2020-07.
        slots:
          product_id: path.product_id
      - text: Return only {fields} of product {product_id} from API 2020-07.
        slots:
          fields: query.fields
          product_id: path.product_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/products.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a product (API 2020-10)
      effect: write
      questions:
      - How do I create a new product in my Shopify store with API 2020-10?
      - Can the 2020-10 Admin API add products to my catalog?
      instructions:
      - text: Create a product using API version 2020-10.
      - text: Add a new product to my store through the 2020-10 endpoint.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/products/{product_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one product (API 2020-10)
      effect: read
      questions:
      - Can I retrieve a single product's details with API 2020-10?
      - Which fields does a 2020-10 single-product lookup return if I trim it?
      instructions:
      - text: Get product {product_id} using API version 2020-10.
        slots:
          product_id: path.product_id
      - text: Show product {product_id} from the 2020-10 endpoint with only {fields}.
        slots:
          product_id: path.product_id
          fields: query.fields
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/products.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a product (API 2021-01)
      effect: write
      questions:
      - Does the 2021-01 API still let me create products?
      - Can I add a product to my shop on version 2021-01?
      instructions:
      - text: Create a product via the 2021-01 API.
      - text: Add a new catalog item with API 2021-01.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/products/{product_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one product (API 2021-01)
      effect: read
      questions:
      - Does version 2021-01 let me fetch one product by ID?
      - What does the 2021-01 API show for a specific product?
      instructions:
      - text: Retrieve product {product_id} with the 2021-01 API.
        slots:
          product_id: path.product_id
      - text: Get 2021-01 details of product {product_id}, fields {fields}.
        slots:
          product_id: path.product_id
          fields: query.fields
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/products.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a product (unstable API)
      effect: write
      questions:
      - Can I create a product on the unstable API version?
      - Is product creation available on the unstable Admin API?
      instructions:
      - text: Create a product on the unstable API version.
      - text: Add a new product through the unstable products endpoint.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/products/{product_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one product (unstable API)
      effect: read
      questions:
      - Can I fetch a single product on the unstable API version?
      - What does the unstable API return for one product?
      instructions:
      - text: Get product {product_id} on the unstable version.
        slots:
          product_id: path.product_id
      - text: Fetch unstable-version product {product_id} showing {fields}.
        slots:
          product_id: path.product_id
          fields: query.fields
      method: generated
      generated: '2026-09-24'