Shopify · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Shopify Create API
19 actions
19 updates
phrasing
extends
openapi/shopify-create-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.
What the actions change
x-apievangelist-phrasing
Targets 19 · first 16 shown; the file carries all of them
$.info
$.paths['/admin/api/2020-01/products/{product_id}/images.json'].post
$.paths['/admin/api/2020-04/products/{product_id}/images.json'].post
$.paths['/admin/api/2020-07/products/{product_id}/images.json'].post
$.paths['/admin/api/2020-10/products/{product_id}/images.json'].post
$.paths['/admin/api/2021-01/products/{product_id}/images.json'].post
$.paths['/admin/api/unstable/products/{product_id}/images.json'].post
$.paths['/admin/api/2020-01/orders/{order_id}/fulfillments.json'].post
$.paths['/admin/api/2020-04/orders/{order_id}/fulfillments.json'].post
$.paths['/admin/api/2020-07/orders/{order_id}/fulfillments.json'].post
$.paths['/admin/api/2020-10/orders/{order_id}/fulfillments.json'].post
$.paths['/admin/api/2021-01/orders/{order_id}/fulfillments.json'].post
$.paths['/admin/api/unstable/orders/{order_id}/fulfillments.json'].post
$.paths['/admin/api/2020-01/fulfillment_services.json'].post
$.paths['/admin/api/2020-04/fulfillment_services.json'].post
$.paths['/admin/api/2020-07/fulfillment_services.json'].post
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 Create API
version: 1.0.0
extends: openapi/shopify-create-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: 18
- target: $.paths['/admin/api/2020-01/products/{product_id}/images.json'].post
update:
x-apievangelist-phrasing:
intent: Add an image to a product (2020-01)
effect: write
questions:
- How do I add a new image to a product using API 2020-01?
- Can I upload product photos through the January 2020 Admin API?
instructions:
- text: Add an image to product {product} via 2020-01.
slots:
product: path.product_id
- text: On January 2020, create a new product image for {product}.
slots:
product: path.product_id
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/products/{product_id}/images.json'].post
update:
x-apievangelist-phrasing:
intent: Add an image to a product (2020-04)
effect: write
questions:
- Which 2020-04 endpoint creates a product image?
- In April 2020, can I attach another picture to an existing product?
instructions:
- text: Create an image on product {product} using 2020-04.
slots:
product: path.product_id
- text: Using April 2020, upload a new picture for product {product}.
slots:
product: path.product_id
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/products/{product_id}/images.json'].post
update:
x-apievangelist-phrasing:
intent: Add an image to a product (2020-07)
effect: write
questions:
- What call adds a product image in the 2020-07 API?
- Is adding images to a product supported by July 2020?
instructions:
- text: Upload a product image for {product} with 2020-07.
slots:
product: path.product_id
- text: Via July 2020, attach a new image to product {product}.
slots:
product: path.product_id
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/products/{product_id}/images.json'].post
update:
x-apievangelist-phrasing:
intent: Add an image to a product
effect: write
questions:
- My product needs another photo; where do I add it in version 2020-10?
- Where in October 2020 do I create a new image for a product?
instructions:
- text: Add a new image to product {product} (API 2020-10).
slots:
product: path.product_id
- text: With October 2020, create a product image on {product}.
slots:
product: path.product_id
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/products/{product_id}/images.json'].post
update:
x-apievangelist-phrasing:
intent: Add an image to a product (2021-01)
effect: write
questions:
- On 2021-01, how can I create a product image?
- Does January 2021 let me add pictures to a product?
instructions:
- text: Create a new image for product {product} using 2021-01.
slots:
product: path.product_id
- text: Using January 2021, upload an image to {product}.
slots:
product: path.product_id
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/products/{product_id}/images.json'].post
update:
x-apievangelist-phrasing:
intent: Add an image to a product (unstable)
effect: write
questions:
- Can I add a product image on the unstable API?
- Which unstable-version endpoint creates new product images?
instructions:
- text: Add an image to product {product} on unstable.
slots:
product: path.product_id
- text: Using the unstable endpoint, create a product image for {product}.
slots:
product: path.product_id
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/orders/{order_id}/fulfillments.json'].post
update:
x-apievangelist-phrasing:
intent: Create a fulfillment for an order (2020-01)
effect: write
questions:
- How do I fulfill line items on an order using API 2020-01?
- Can I create a fulfillment directly on an order in the January 2020 API?
instructions:
- text: Create a fulfillment for order {order} via 2020-01.
slots:
order: path.order_id
- text: On January 2020, fulfill the specified line items of order {order}.
slots:
order: path.order_id
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/orders/{order_id}/fulfillments.json'].post
update:
x-apievangelist-phrasing:
intent: Create a fulfillment for an order (2020-04)
effect: write
questions:
- Which 2020-04 endpoint creates a fulfillment for an order's line items?
- In April 2020, can I mark specific line items on an order as fulfilled?
instructions:
- text: Fulfill order {order} using 2020-04.
slots:
order: path.order_id
- text: Using April 2020, create a fulfillment for chosen line items on {order}.
slots:
order: path.order_id
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/orders/{order_id}/fulfillments.json'].post
update:
x-apievangelist-phrasing:
intent: Create a fulfillment for an order (2020-07)
effect: write
questions:
- What call fulfills an order's line items in the 2020-07 API?
- Is fulfilling specific items of one order possible with July 2020?
instructions:
- text: Record a fulfillment on order {order} with 2020-07.
slots:
order: path.order_id
- text: Via July 2020, fulfill certain line items of order {order}.
slots:
order: path.order_id
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/orders/{order_id}/fulfillments.json'].post
update:
x-apievangelist-phrasing:
intent: Create a fulfillment for an order
effect: write
questions:
- An order is ready to ship; how do I create its fulfillment on 2020-10?
- Where in October 2020 do I fulfill specified line items for an order?
instructions:
- text: Create a fulfillment on order {order} for its line items (API 2020-10).
slots:
order: path.order_id
- text: With October 2020, mark order {order}'s items as fulfilled.
slots:
order: path.order_id
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/orders/{order_id}/fulfillments.json'].post
update:
x-apievangelist-phrasing:
intent: Create a fulfillment for an order (2021-01)
effect: write
questions:
- On 2021-01, how can I create a fulfillment for an order?
- Does January 2021 let me fulfill selected line items on an order?
instructions:
- text: Fulfill line items on order {order} using 2021-01.
slots:
order: path.order_id
- text: Using January 2021, create an order fulfillment for {order}.
slots:
order: path.order_id
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/orders/{order_id}/fulfillments.json'].post
update:
x-apievangelist-phrasing:
intent: Create a fulfillment for an order (unstable)
effect: write
questions:
- Can I create a fulfillment for an order on the unstable API?
- Which unstable-version endpoint fulfills specified line items of an order?
instructions:
- text: Create a fulfillment for order {order} on unstable.
slots:
order: path.order_id
- text: Using the unstable endpoint, fulfill line items of {order}.
slots:
order: path.order_id
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/fulfillment_services.json'].post
update:
x-apievangelist-phrasing:
intent: Create a fulfillment service (2020-01)
effect: write
questions:
- How do I register my warehouse as a fulfillment service with API 2020-01?
- Can an app create a fulfillment service through the January 2020 Admin API?
instructions:
- text: Create a fulfillment service via 2020-01.
- text: On January 2020, register a new fulfillment service for this store.
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/fulfillment_services.json'].post
update:
x-apievangelist-phrasing:
intent: Create a fulfillment service (2020-04)
effect: write
questions:
- Which 2020-04 endpoint creates a fulfillment service?
- In April 2020, can my app set itself up as a fulfillment service?
instructions:
- text: Register a fulfillment service using 2020-04.
- text: Using April 2020, add a new fulfillment service.
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/fulfillment_services.json'].post
update:
x-apievangelist-phrasing:
intent: Create a fulfillment service (2020-07)
effect: write
questions:
- What call sets up a fulfillment service in the 2020-07 API?
- Is creating a fulfillment service for my logistics app possible with July 2020?
instructions:
- text: Set up a fulfillment service with 2020-07.
- text: Via July 2020, create a new fulfillment service for my app.
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/fulfillment_services.json'].post
update:
x-apievangelist-phrasing:
intent: Create a fulfillment service
effect: write
questions:
- I run a 3PL warehouse; how do I create a fulfillment service on 2020-10?
- Where in October 2020 do I register a new fulfillment service?
instructions:
- text: Create a new fulfillment service (API 2020-10).
- text: With October 2020, register my app as a fulfillment service.
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/fulfillment_services.json'].post
update:
x-apievangelist-phrasing:
intent: Create a fulfillment service (2021-01)
effect: write
questions:
- On 2021-01, how can I create a fulfillment service?
- Does January 2021 support registering a fulfillment service?
instructions:
- text: Add a fulfillment service using 2021-01.
- text: Using January 2021, create a fulfillment service for the shop.
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/fulfillment_services.json'].post
update:
x-apievangelist-phrasing:
intent: Create a fulfillment service (unstable)
effect: write
questions:
- Can I create a fulfillment service on the unstable API?
- Which unstable-version endpoint registers a fulfillment service?
instructions:
- text: Create a fulfillment service on unstable.
- text: Using the unstable endpoint, set up a new fulfillment service.
method: generated
generated: '2026-09-24'