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 Product Variants API
version: 1.0.0
extends: openapi/shopify-product-variants-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: 2
- target: $.paths['/products/{product_id}/variants.json'].get
update:
x-apievangelist-phrasing:
intent: List a product's variants
effect: read
questions:
- What sizes, colors and other variants does one of my Shopify products have?
- Can I page through a product's variants with a limit and a since_id cursor?
- Which fields can I restrict the variant list to so the response stays small?
instructions:
- text: List all variants of product {product_id}.
slots:
product_id: path.product_id
- text: Show the first {limit} variants of product {product_id}.
slots:
limit: query.limit
product_id: path.product_id
- text: Get variants of product {product_id} after variant {since_id}, returning only {fields}.
slots:
product_id: path.product_id
since_id: query.since_id
fields: query.fields
method: generated
generated: '2026-09-24'
- target: $.paths['/products/{product_id}/variants.json'].post
update:
x-apievangelist-phrasing:
intent: Add a new variant to a product
effect: write
questions:
- How do I add a new size or color option as a variant on an existing product?
- Can I create another variant for a product that is already listed?
instructions:
- text: Add variant {variant} to product {product_id}.
slots:
variant: requestBody.variant
product_id: path.product_id
- text: 'Create a new variant on product {product_id} using these details: {variant}.'
slots:
product_id: path.product_id
variant: requestBody.variant
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.