Shopify · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Shopify Redirect API
13 actions
13 updates
phrasing
extends
openapi/shopify-redirect-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 13
$.info
$.paths['/admin/api/2020-01/redirects.json'].post
$.paths['/admin/api/2020-01/redirects/{redirect_id}.json'].get
$.paths['/admin/api/2020-04/redirects.json'].post
$.paths['/admin/api/2020-04/redirects/{redirect_id}.json'].get
$.paths['/admin/api/2020-07/redirects.json'].post
$.paths['/admin/api/2020-07/redirects/{redirect_id}.json'].get
$.paths['/admin/api/2020-10/redirects.json'].post
$.paths['/admin/api/2020-10/redirects/{redirect_id}.json'].get
$.paths['/admin/api/2021-01/redirects.json'].post
$.paths['/admin/api/2021-01/redirects/{redirect_id}.json'].get
$.paths['/admin/api/unstable/redirects.json'].post
$.paths['/admin/api/unstable/redirects/{redirect_id}.json'].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 Redirect API
version: 1.0.0
extends: openapi/shopify-redirect-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/redirects.json'].post
update:
x-apievangelist-phrasing:
intent: Create a URL redirect (API 2020-01)
effect: write
questions:
- Can I send shoppers from an old store URL to a new one using the 2020-01 API?
- What does creating a redirect look like on version 2020-01?
instructions:
- text: Create a store URL redirect through the 2020-01 API version.
- text: Add a new path redirect using release 2020-01.
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/redirects/{redirect_id}.json'].get
update:
x-apievangelist-phrasing:
intent: Get one redirect (API 2020-01)
effect: read
questions:
- Where does a given redirect point, checked on API version 2020-01?
- Can the 2020-01 single-redirect lookup return just some fields?
instructions:
- text: Show redirect {redirect_id} from the 2020-01 API.
slots:
redirect_id: path.redirect_id
- text: Look up redirect {redirect_id} on 2020-01 returning only {fields}.
slots:
redirect_id: path.redirect_id
fields: query.fields
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/redirects.json'].post
update:
x-apievangelist-phrasing:
intent: Create a URL redirect (API 2020-04)
effect: write
questions:
- How do I forward a retired product URL to a new page with the 2020-04 release?
- Is creating store redirects supported in API version 2020-04?
instructions:
- text: Set up a new URL redirect via version 2020-04.
- text: Using the 2020-04 release, add a redirect for my online store.
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/redirects/{redirect_id}.json'].get
update:
x-apievangelist-phrasing:
intent: Get one redirect (API 2020-04)
effect: read
questions:
- What target path is a specific redirect sending traffic to under 2020-04?
- Which fields can I limit a single redirect to in release 2020-04?
instructions:
- text: Fetch redirect {redirect_id} through version 2020-04.
slots:
redirect_id: path.redirect_id
- text: Retrieve only {fields} of redirect {redirect_id} on the 2020-04 API.
slots:
redirect_id: path.redirect_id
fields: query.fields
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/redirects.json'].post
update:
x-apievangelist-phrasing:
intent: Create a URL redirect (API 2020-07)
effect: write
questions:
- Can I add a storefront redirect when my app is pinned to 2020-07?
- What's needed to make a new redirect with API version 2020-07?
instructions:
- text: Make a redirect for a moved page with the 2020-07 API.
- text: Create one online store redirect on release 2020-07.
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/redirects/{redirect_id}.json'].get
update:
x-apievangelist-phrasing:
intent: Get one redirect (API 2020-07)
effect: read
questions:
- How can I inspect one redirect's path and target on the 2020-07 release?
- Does 2020-07 let me request selected fields for a single redirect?
instructions:
- text: Get redirect {redirect_id} using API version 2020-07.
slots:
redirect_id: path.redirect_id
- text: On 2020-07, return the {fields} of redirect {redirect_id}.
slots:
redirect_id: path.redirect_id
fields: query.fields
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/redirects.json'].post
update:
x-apievangelist-phrasing:
intent: Create a URL redirect (API 2020-10)
effect: write
questions:
- How do I redirect an old storefront URL to a new location in Shopify?
- Can the current 2020-10 API create a redirect for my online store?
instructions:
- text: Create a URL redirect in my store with the 2020-10 API.
- text: Add a redirect so an outdated link lands on a new page, version 2020-10.
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/redirects/{redirect_id}.json'].get
update:
x-apievangelist-phrasing:
intent: Get one redirect (API 2020-10)
effect: read
questions:
- What does an existing redirect point to, using the 2020-10 API?
- Can I fetch only certain fields of one redirect on version 2020-10?
instructions:
- text: Retrieve redirect {redirect_id} with API 2020-10.
slots:
redirect_id: path.redirect_id
- text: Show just {fields} for redirect {redirect_id} on release 2020-10.
slots:
redirect_id: path.redirect_id
fields: query.fields
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/redirects.json'].post
update:
x-apievangelist-phrasing:
intent: Create a URL redirect (API 2021-01)
effect: write
questions:
- Is it possible to set up a new redirect via the 2021-01 release?
- What happens when I create a redirect with API version 2021-01?
instructions:
- text: Create a storefront redirect through release 2021-01.
- text: Register a new URL redirect with the 2021-01 API version.
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/redirects/{redirect_id}.json'].get
update:
x-apievangelist-phrasing:
intent: Get one redirect (API 2021-01)
effect: read
questions:
- Where is one particular redirect sending visitors, per the 2021-01 API?
- Can a 2021-01 redirect lookup be narrowed to specific fields?
instructions:
- text: Look up redirect {redirect_id} via the 2021-01 release.
slots:
redirect_id: path.redirect_id
- text: Fetch {fields} only from redirect {redirect_id}, API 2021-01.
slots:
redirect_id: path.redirect_id
fields: query.fields
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/redirects.json'].post
update:
x-apievangelist-phrasing:
intent: Create a URL redirect (unstable API)
effect: write
questions:
- Can I create a redirect against the unstable API version?
- What does the unstable release expect when adding a URL redirect?
instructions:
- text: Create a redirect using the unstable API.
- text: Add an online store redirect on the unstable version.
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/redirects/{redirect_id}.json'].get
update:
x-apievangelist-phrasing:
intent: Get one redirect (unstable API)
effect: read
questions:
- How do I read a single redirect from the unstable API version?
- Which fields of one redirect can the unstable release return on request?
instructions:
- text: Get redirect {redirect_id} from the unstable API.
slots:
redirect_id: path.redirect_id
- text: Using the unstable version, show {fields} of redirect {redirect_id}.
slots:
redirect_id: path.redirect_id
fields: query.fields
method: generated
generated: '2026-09-24'