Shopify · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Shopify Country API

13 actions 13 updates phrasing extends openapi/shopify-country-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/countries/{country_id}.json'].delete
$.paths['/admin/api/2020-04/countries/{country_id}.json'].delete
$.paths['/admin/api/2020-07/countries/{country_id}.json'].delete
$.paths['/admin/api/2020-10/countries/{country_id}.json'].delete
$.paths['/admin/api/2021-01/countries/{country_id}.json'].delete
$.paths['/admin/api/unstable/countries/{country_id}.json'].delete
$.paths['/admin/api/2020-01/countries/{country_id}/provinces/{province_id}.json'].get
$.paths['/admin/api/2020-04/countries/{country_id}/provinces/{province_id}.json'].get
$.paths['/admin/api/2020-07/countries/{country_id}/provinces/{province_id}.json'].get
$.paths['/admin/api/2020-10/countries/{country_id}/provinces/{province_id}.json'].get
$.paths['/admin/api/2021-01/countries/{country_id}/provinces/{province_id}.json'].get
$.paths['/admin/api/unstable/countries/{country_id}/provinces/{province_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 Country API
  version: 1.0.0
extends: openapi/shopify-country-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/countries/{country_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a shipping country (2020-01 API)
      effect: destructive
      questions:
      - How do I remove a country from my store's shipping countries on the 2020-01 API?
      - Can I delete a country I no longer sell to with the 2020-01 version?
      instructions:
      - text: Delete country {country} using the 2020-01 API.
        slots:
          country: path.country_id
      - text: Remove country {country} from the store's country list, version 2020-01.
        slots:
          country: path.country_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/countries/{country_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a shipping country (2020-04 API)
      effect: destructive
      questions:
      - Which 2020-04 endpoint deletes a country from the shop?
      - Is deleting a store country supported in the 2020-04 release?
      instructions:
      - text: Remove country {country} on 2020-04.
        slots:
          country: path.country_id
      - text: Drop country {country} from my shop settings via the 2020-04 release.
        slots:
          country: path.country_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/countries/{country_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a shipping country (2020-07 API)
      effect: destructive
      questions:
      - Where do I delete a country record in version 2020-07?
      - What happens to its provinces when I remove a store country in 2020-07?
      instructions:
      - text: Delete country {country} through the 2020-07 version.
        slots:
          country: path.country_id
      - text: Erase the country entry {country} with 2020-07.
        slots:
          country: path.country_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/countries/{country_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a shipping country (2020-10 API)
      effect: destructive
      questions:
      - How can I stop offering a country by deleting it with the 2020-10 API?
      - Does the 2020-10 Admin API let me delete a country from my store?
      instructions:
      - text: Remove country {country} with the 2020-10 Admin API.
        slots:
          country: path.country_id
      - text: Delete the store country {country}, API version 2020-10.
        slots:
          country: path.country_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/countries/{country_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a shipping country (2021-01 API)
      effect: destructive
      questions:
      - Can I delete a country using the 2021-01 release?
      - Which 2021-01 call permanently removes a country from the shop?
      instructions:
      - text: Using 2021-01, delete country {country}.
        slots:
          country: path.country_id
      - text: Take country {country} out of the store on the 2021-01 release.
        slots:
          country: path.country_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/countries/{country_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a shipping country (unstable API)
      effect: destructive
      questions:
      - Is removing a store country possible on the unstable API version?
      - How would I delete a country against the unstable release?
      instructions:
      - text: Delete country {country} on the unstable API.
        slots:
          country: path.country_id
      - text: On the unstable version, remove country {country} from the shop.
        slots:
          country: path.country_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/countries/{country_id}/provinces/{province_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one province of a country (2020-01 API)
      effect: read
      questions:
      - How do I fetch a single province or state for a country on the 2020-01 API?
      - Can I return only certain fields for a province lookup in 2020-01?
      instructions:
      - text: Show province {province} of country {country} using the 2020-01 API.
        slots:
          country: path.country_id
          province: path.province_id
      - text: Get only {fields} for province {province} in country {country}, version 2020-01.
        slots:
          country: path.country_id
          province: path.province_id
          fields: query.fields
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/countries/{country_id}/provinces/{province_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one province of a country (2020-04 API)
      effect: read
      questions:
      - Which 2020-04 call returns one province by ID within a country?
      - What does a single province record contain in the 2020-04 release?
      instructions:
      - text: Retrieve province {province} for country {country} on 2020-04.
        slots:
          country: path.country_id
          province: path.province_id
      - text: Fetch {fields} of province {province} under country {country} via the 2020-04 release.
        slots:
          country: path.country_id
          province: path.province_id
          fields: query.fields
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/countries/{country_id}/provinces/{province_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one province of a country (2020-07 API)
      effect: read
      questions:
      - Where do I read one state or province of a store country in version 2020-07?
      - Does 2020-07 support getting a province by its ID?
      instructions:
      - text: Get province {province} in country {country} through the 2020-07 version.
        slots:
          country: path.country_id
          province: path.province_id
      - text: Look up just {fields} on province {province} of country {country} with 2020-07.
        slots:
          country: path.country_id
          province: path.province_id
          fields: query.fields
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/countries/{country_id}/provinces/{province_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one province of a country (2020-10 API)
      effect: read
      questions:
      - How can I check the settings for one province in a country using the 2020-10 API?
      - Does the 2020-10 Admin API let me trim a province response to chosen fields?
      instructions:
      - text: Show me province {province} of country {country} on the 2020-10 API.
        slots:
          country: path.country_id
          province: path.province_id
      - text: Return {fields} for country {country}'s province {province}, API 2020-10.
        slots:
          country: path.country_id
          province: path.province_id
          fields: query.fields
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/countries/{country_id}/provinces/{province_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one province of a country (2021-01 API)
      effect: read
      questions:
      - Can I retrieve a single province of a country in the 2021-01 release?
      - Which endpoint in 2021-01 gives me one province by ID?
      instructions:
      - text: Using 2021-01, fetch province {province} of country {country}.
        slots:
          country: path.country_id
          province: path.province_id
      - text: Display {fields} of province {province} in country {country} on the 2021-01 release.
        slots:
          country: path.country_id
          province: path.province_id
          fields: query.fields
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/countries/{country_id}/provinces/{province_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one province of a country (unstable API)
      effect: read
      questions:
      - Is reading a single province available on the unstable API?
      - How would I get one province of a country from the unstable version?
      instructions:
      - text: Retrieve province {province} of country {country} from the unstable API.
        slots:
          country: path.country_id
          province: path.province_id
      - text: On the unstable version, look up {fields} for province {province} in country {country}.
        slots:
          country: path.country_id
          province: path.province_id
          fields: query.fields
      method: generated
      generated: '2026-09-24'