Shopify · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Shopify Versions API
19 actions
19 updates
phrasing
extends
openapi/shopify-versions-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/countries.json'].post
$.paths['/admin/api/2020-01/countries/{country_id}.json'].put
$.paths['/admin/api/2020-04/countries.json'].post
$.paths['/admin/api/2020-04/countries/{country_id}.json'].put
$.paths['/admin/api/2020-07/countries.json'].post
$.paths['/admin/api/2020-07/countries/{country_id}.json'].put
$.paths['/admin/api/2020-10/countries.json'].post
$.paths['/admin/api/2020-10/countries/{country_id}.json'].put
$.paths['/admin/api/2021-01/countries.json'].post
$.paths['/admin/api/2021-01/countries/{country_id}.json'].put
$.paths['/admin/api/unstable/countries.json'].post
$.paths['/admin/api/unstable/countries/{country_id}.json'].put
$.paths['/admin/api/2020-01/countries/{country_id}/provinces/{province_id}.json'].put
$.paths['/admin/api/2020-04/countries/{country_id}/provinces/{province_id}.json'].put
$.paths['/admin/api/2020-07/countries/{country_id}/provinces/{province_id}.json'].put
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 Versions API
version: 1.0.0
extends: openapi/shopify-versions-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/countries.json'].post
update:
x-apievangelist-phrasing:
intent: Add a country to the store (2020-01)
effect: write
questions:
- Can I add a new country to my store settings with the 2020-01 Admin API?
- What 2020-01 call creates a country record for the shop?
instructions:
- text: Add a country to my store using API version 2020-01.
- text: Create a country entry through the 2020-01 countries endpoint.
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/countries/{country_id}.json'].put
update:
x-apievangelist-phrasing:
intent: Update a store country (2020-01)
effect: write
questions:
- How do I edit one of my store's countries on 2020-01?
- Which 2020-01 endpoint changes an existing country's settings?
instructions:
- text: Update country {country} using API version 2020-01.
slots:
country: path.country_id
- text: Save changes to the store's country {country} via the 2020-01 API.
slots:
country: path.country_id
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/countries.json'].post
update:
x-apievangelist-phrasing:
intent: Add a country to the store (2020-04)
effect: write
questions:
- Which 2020-04 endpoint adds a country to the shop?
- Is creating a country still possible on version 2020-04?
instructions:
- text: Create a new country for the store through the 2020-04 API.
- text: Register another country in my shop with version 2020-04.
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/countries/{country_id}.json'].put
update:
x-apievangelist-phrasing:
intent: Update a store country (2020-04)
effect: write
questions:
- What 2020-04 call modifies a country I already set up?
- Can I change a country record by its ID on version 2020-04?
instructions:
- text: Modify country {country} through the 2020-04 API.
slots:
country: path.country_id
- text: Edit store country {country} with version 2020-04.
slots:
country: path.country_id
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/countries.json'].post
update:
x-apievangelist-phrasing:
intent: Add a country to the store (2020-07)
effect: write
questions:
- What 2020-07 endpoint creates a country for my shop?
- Does the 2020-07 release let me add countries to the store?
instructions:
- text: Add a country with the 2020-07 Admin API.
- text: Set up a new store country via version 2020-07.
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/countries/{country_id}.json'].put
update:
x-apievangelist-phrasing:
intent: Update a store country (2020-07)
effect: write
questions:
- Is updating a country supported in 2020-07?
- Which endpoint in 2020-07 edits a country by ID?
instructions:
- text: Edit country {country} using version 2020-07.
slots:
country: path.country_id
- text: Apply updates to the shop's country {country} via the 2020-07 Admin API.
slots:
country: path.country_id
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/countries.json'].post
update:
x-apievangelist-phrasing:
intent: Add a country to the store (2020-10)
effect: write
questions:
- How can I add a country to my Shopify store on version 2020-10?
- Which 2020-10 call creates a new country record?
instructions:
- text: Create a country on 2020-10.
- text: Add a new country to the shop using the 2020-10 endpoint.
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/countries/{country_id}.json'].put
update:
x-apievangelist-phrasing:
intent: Update a store country (2020-10)
effect: write
questions:
- How can I update a country in the 2020-10 release?
- What 2020-10 endpoint rewrites an existing country's details?
instructions:
- text: Update country {country} on 2020-10.
slots:
country: path.country_id
- text: Change the details of store country {country} via version 2020-10.
slots:
country: path.country_id
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/countries.json'].post
update:
x-apievangelist-phrasing:
intent: Add a country to the store (2021-01)
effect: write
questions:
- Can I create a country through the 2021-01 API?
- Where do I add a store country in version 2021-01?
instructions:
- text: Set up a country with the 2021-01 release.
- text: Create a store country on API version 2021-01.
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/countries/{country_id}.json'].put
update:
x-apievangelist-phrasing:
intent: Update a store country (2021-01)
effect: write
questions:
- Can the 2021-01 API change an existing country?
- Where do I update a country record in version 2021-01?
instructions:
- text: Modify country {country} with the 2021-01 release.
slots:
country: path.country_id
- text: Push edits to store country {country} using 2021-01.
slots:
country: path.country_id
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/countries.json'].post
update:
x-apievangelist-phrasing:
intent: Add a country to the store (unstable)
effect: write
questions:
- Does the unstable API let me add a country?
- What's the unstable-version call for creating a country?
instructions:
- text: Create a country using the unstable version.
- text: Add a store country through the unstable Admin API.
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/countries/{country_id}.json'].put
update:
x-apievangelist-phrasing:
intent: Update a store country (unstable)
effect: write
questions:
- Does the unstable version support editing a country?
- What's the unstable call for updating a country by ID?
instructions:
- text: Update country {country} on the unstable API.
slots:
country: path.country_id
- text: Edit the existing store country {country} via the unstable version.
slots:
country: path.country_id
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/countries/{country_id}/provinces/{province_id}.json'].put
update:
x-apievangelist-phrasing:
intent: Update a province of a country (2020-01)
effect: write
questions:
- Can I edit a province or state within a country using the 2020-01 API?
- What 2020-01 call changes a single province's settings?
instructions:
- text: Update province {province} of country {country} using API version 2020-01.
slots:
province: path.province_id
country: path.country_id
- text: Save changes to region {province} under country {country} with the 2020-01 API.
slots:
province: path.province_id
country: path.country_id
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/countries/{country_id}/provinces/{province_id}.json'].put
update:
x-apievangelist-phrasing:
intent: Update a province of a country (2020-04)
effect: write
questions:
- Which 2020-04 endpoint modifies a province of a country?
- Is updating a state or province possible on version 2020-04?
instructions:
- text: Modify province {province} in country {country} through the 2020-04 API.
slots:
province: path.province_id
country: path.country_id
- text: Edit the {province} province of country {country} with 2020-04.
slots:
province: path.province_id
country: path.country_id
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/countries/{country_id}/provinces/{province_id}.json'].put
update:
x-apievangelist-phrasing:
intent: Update a province of a country (2020-07)
effect: write
questions:
- What 2020-07 call edits a province belonging to a country?
- Can I change one state's record within a country on 2020-07?
instructions:
- text: Edit province {province} of country {country} using version 2020-07.
slots:
province: path.province_id
country: path.country_id
- text: Apply updates to province {province} in country {country} via the 2020-07 Admin API.
slots:
province: path.province_id
country: path.country_id
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/countries/{country_id}/provinces/{province_id}.json'].put
update:
x-apievangelist-phrasing:
intent: Update a province of a country (2020-10)
effect: write
questions:
- How can I update a province in one of my countries on 2020-10?
- Which 2020-10 endpoint rewrites a state or province record?
instructions:
- text: Update province {province} of country {country} on 2020-10.
slots:
province: path.province_id
country: path.country_id
- text: Change the settings of province {province} within country {country} via version 2020-10.
slots:
province: path.province_id
country: path.country_id
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/countries/{country_id}/provinces/{province_id}.json'].put
update:
x-apievangelist-phrasing:
intent: Update a province of a country (2021-01)
effect: write
questions:
- Can the 2021-01 API change a province inside a country?
- Where do I edit a state or province in version 2021-01?
instructions:
- text: Modify province {province} of country {country} with the 2021-01 release.
slots:
province: path.province_id
country: path.country_id
- text: Push edits to province {province} in country {country} using 2021-01.
slots:
province: path.province_id
country: path.country_id
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/countries/{country_id}/provinces/{province_id}.json'].put
update:
x-apievangelist-phrasing:
intent: Update a province of a country (unstable)
effect: write
questions:
- Does the unstable version support editing a province?
- What's the unstable call for updating a state within a country?
instructions:
- text: Update province {province} of country {country} on the unstable API.
slots:
province: path.province_id
country: path.country_id
- text: Edit province {province} under country {country} via the unstable version.
slots:
province: path.province_id
country: path.country_id
method: generated
generated: '2026-09-24'