Shopify · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Shopify All API

108 actions 108 updates phrasing extends openapi/shopify-all-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 108 · first 16 shown; the file carries all of them

$.info
$.paths['/admin/api/2020-01/application_credits.json'].get
$.paths['/admin/api/2020-04/application_credits.json'].get
$.paths['/admin/api/2020-07/application_credits.json'].get
$.paths['/admin/api/2020-10/application_credits.json'].get
$.paths['/admin/api/2021-01/application_credits.json'].get
$.paths['/admin/api/unstable/application_credits.json'].get
$.paths['/admin/api/2020-01/customers/count.json'].get
$.paths['/admin/api/2020-01/customers/{customer_id}/orders.json'].get
$.paths['/admin/api/2020-04/customers/count.json'].get
$.paths['/admin/api/2020-04/customers/{customer_id}/orders.json'].get
$.paths['/admin/api/2020-07/customers/count.json'].get
$.paths['/admin/api/2020-07/customers/{customer_id}/orders.json'].get
$.paths['/admin/api/2020-10/customers/count.json'].get
$.paths['/admin/api/2020-10/customers/{customer_id}/orders.json'].get
$.paths['/admin/api/2021-01/customers/count.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 All API
  version: 1.0.0
extends: openapi/shopify-all-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: 107
- target: $.paths['/admin/api/2020-01/application_credits.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List app credits issued (API 2020-01)
      effect: read
      questions:
      - Which application credits has my app granted to merchants on API version 2020-01?
      - Can the 2020-01 app credits list be trimmed to certain fields?
      instructions:
      - text: List all application credits using the 2020-01 API.
      - text: Fetch app credits via 2020-01, returning only {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/application_credits.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List app credits issued (API 2020-04)
      effect: read
      questions:
      - What credits have I given merchants toward my app fees, per release 2020-04?
      - Does version 2020-04 let me choose which app credit fields come back?
      instructions:
      - text: Pull every application credit through release 2020-04.
      - text: Get 2020-04 application credits showing just {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/application_credits.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List app credits issued (API 2020-07)
      effect: read
      questions:
      - How can I review the app credits my app has handed out with version 2020-07?
      - Is it possible to limit app credit fields when calling 2020-07?
      instructions:
      - text: Show the application credits my app issued, API 2020-07.
      - text: On 2020-07, list app credits with only the {fields} fields.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/application_credits.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List app credits issued (API 2020-10)
      effect: read
      questions:
      - What application credits has my Shopify app issued to shops?
      - Can I list app credits on the current 2020-10 API with selected fields only?
      instructions:
      - text: List my app's application credits with API version 2020-10.
      - text: Retrieve application credits on 2020-10 including only {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/application_credits.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List app credits issued (API 2021-01)
      effect: read
      questions:
      - Which credits toward future app charges exist, according to the 2021-01 release?
      - Can 2021-01 return a slimmed-down set of fields for each application credit?
      instructions:
      - text: Fetch application credits via the 2021-01 release.
      - text: Using API 2021-01, get app credits restricted to {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/application_credits.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List app credits issued (unstable API)
      effect: read
      questions:
      - What app credits does the unstable API version report for my app?
      - Can I request only some application credit fields from the unstable release?
      instructions:
      - text: List application credits from the unstable API.
      - text: Get app credits on the unstable version with fields {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/customers/count.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Count all customers (API 2020-01)
      effect: read
      questions:
      - How many customers does my store have, counted with API 2020-01?
      - Can version 2020-01 give me a total customer count without listing them?
      instructions:
      - text: Count every customer in the store using release 2020-01.
      - text: Give me the total number of customers via the 2020-01 API.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/customers/{customer_id}/orders.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List a customer's orders (API 2020-01)
      effect: read
      questions:
      - What orders has one specific customer placed, per API version 2020-01?
      - Can I see a single buyer's order history with the 2020-01 release?
      instructions:
      - text: List orders belonging to customer {customer_id} using 2020-01.
        slots:
          customer_id: path.customer_id
      - text: Show customer {customer_id}'s purchase history via API 2020-01.
        slots:
          customer_id: path.customer_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/customers/count.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Count all customers (API 2020-04)
      effect: read
      questions:
      - What's my shop's total customer count on release 2020-04?
      - Is there a quick customer tally endpoint in version 2020-04?
      instructions:
      - text: Get the customer count for my shop with 2020-04.
      - text: Tell me how many customer records exist, API version 2020-04.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/customers/{customer_id}/orders.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List a customer's orders (API 2020-04)
      effect: read
      questions:
      - Which purchases did a particular customer make, checked on release 2020-04?
      - How can I pull every order for one shopper with version 2020-04?
      instructions:
      - text: Get all orders for customer {customer_id} through 2020-04.
        slots:
          customer_id: path.customer_id
      - text: Fetch the orders placed by customer {customer_id} on API 2020-04.
        slots:
          customer_id: path.customer_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/customers/count.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Count all customers (API 2020-07)
      effect: read
      questions:
      - How big is my customer base according to the 2020-07 API?
      - Can I fetch just the number of customers under version 2020-07?
      instructions:
      - text: Return the store's customer total through 2020-07.
      - text: Count customers on API release 2020-07.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/customers/{customer_id}/orders.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List a customer's orders (API 2020-07)
      effect: read
      questions:
      - Can the 2020-07 API list everything one customer has ordered?
      - What does a given buyer's order list look like under version 2020-07?
      instructions:
      - text: Retrieve customer {customer_id}'s orders with release 2020-07.
        slots:
          customer_id: path.customer_id
      - text: On 2020-07, list every order tied to customer {customer_id}.
        slots:
          customer_id: path.customer_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/customers/count.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Count all customers (API 2020-10)
      effect: read
      questions:
      - How many customers are in my Shopify store in total?
      - Can the 2020-10 API count customers instead of paging through them?
      instructions:
      - text: Count all customers in my store with API 2020-10.
      - text: Get the total customer number from version 2020-10.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/customers/{customer_id}/orders.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List a customer's orders (API 2020-10)
      effect: read
      questions:
      - How do I see all the orders one customer has placed in my Shopify store?
      - Can the current 2020-10 API return a customer's full order history?
      instructions:
      - text: List all orders for customer {customer_id} with API 2020-10.
        slots:
          customer_id: path.customer_id
      - text: Show me what customer {customer_id} has bought, version 2020-10.
        slots:
          customer_id: path.customer_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/customers/count.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Count all customers (API 2021-01)
      effect: read
      questions:
      - What total number of customers does release 2021-01 report for my shop?
      - Is a customer headcount available from API version 2021-01?
      instructions:
      - text: Fetch my customer count through the 2021-01 release.
      - text: Using 2021-01, tell me how many customers the shop has.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/customers/{customer_id}/orders.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List a customer's orders (API 2021-01)
      effect: read
      questions:
      - Which orders belong to a certain customer according to release 2021-01?
      - Is a per-customer order list available in API version 2021-01?
      instructions:
      - text: Fetch orders placed by customer {customer_id} via 2021-01.
        slots:
          customer_id: path.customer_id
      - text: Using the 2021-01 release, get customer {customer_id}'s orders.
        slots:
          customer_id: path.customer_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/customers/count.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Count all customers (unstable API)
      effect: read
      questions:
      - How many customers does the unstable API say my store has?
      - Can I get a customer total from the unstable version?
      instructions:
      - text: Count customers using the unstable API.
      - text: Return the total customers from the unstable release.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/customers/{customer_id}/orders.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List a customer's orders (unstable API)
      effect: read
      questions:
      - What orders does the unstable API show for one customer?
      - Can I list a single shopper's purchases on the unstable version?
      instructions:
      - text: List customer {customer_id}'s orders from the unstable API.
        slots:
          customer_id: path.customer_id
      - text: Get every order for customer {customer_id} on the unstable release.
        slots:
          customer_id: path.customer_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/customer_saved_searches/count.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Count customer saved searches (API 2020-01)
      effect: read
      questions:
      - How many saved customer searches (segments) exist in my store on API 2020-01?
      - Can the 2020-01 count skip saved searches up to a given ID?
      instructions:
      - text: Count the customer saved searches using release 2020-01.
      - text: Count saved customer searches created after ID {since_id}, API 2020-01.
        slots:
          since_id: query.since_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/customer_saved_searches/{customer_saved_search_id}/customers.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List customers in a saved search (API 2020-01)
      effect: read
      questions:
      - Which customers match one of my saved customer searches on API 2020-01?
      - Can I sort or cap the customers a saved search returns with version 2020-01?
      instructions:
      - text: List the customers returned by saved search {search} using 2020-01.
        slots:
          search: path.customer_saved_search_id
      - text: Show up to {limit} customers from saved search {search}, sorted by {order}, API 2020-01.
        slots:
          search: path.customer_saved_search_id
          limit: query.limit
          order: query.order
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/customer_saved_searches/count.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Count customer saved searches (API 2020-04)
      effect: read
      questions:
      - What's the total number of saved customer filters under version 2020-04?
      - Is there a way to count only newer customer saved searches with 2020-04?
      instructions:
      - text: Get the number of customer saved searches via 2020-04.
      - text: Tally saved searches with IDs past {since_id} on release 2020-04.
        slots:
          since_id: query.since_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/customer_saved_searches/{customer_saved_search_id}/customers.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List customers in a saved search (API 2020-04)
      effect: read
      questions:
      - Who falls into a particular saved customer segment, per release 2020-04?
      - Can a 2020-04 saved search return just some customer fields?
      instructions:
      - text: Get customers matching saved search {search} via 2020-04.
        slots:
          search: path.customer_saved_search_id
      - text: Fetch {fields} for customers in saved search {search}, release 2020-04.
        slots:
          search: path.customer_saved_search_id
          fields: query.fields
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/customer_saved_searches/count.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Count customer saved searches (API 2020-07)
      effect: read
      questions:
      - How many customer saved searches does API version 2020-07 report?
      - Can I count saved customer searches beyond a certain ID in 2020-07?
      instructions:
      - text: Return a count of saved customer searches with 2020-07.
      - text: On 2020-07, count customer saved searches after {since_id}.
        slots:
          since_id: query.since_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/customer_saved_searches/{customer_saved_search_id}/customers.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List customers in a saved search (API 2020-07)
      effect: read
      questions:
      - How do I pull the members of a saved customer search with version 2020-07?
      - Can I order the customers from a saved search in 2020-07?
      instructions:
      - text: Retrieve customers in saved search {search} on 2020-07.
        slots:
          search: path.customer_saved_search_id
      - text: On API 2020-07, list saved search {search}'s customers ordered by {order}.
        slots:
          search: path.customer_saved_search_id
          order: query.order
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/customer_saved_searches/count.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Count customer saved searches (API 2020-10)
      effect: read
      questions:
      - How many saved customer searches have been set up in my Shopify admin?
      - Can the 2020-10 API count saved searches created after a known ID?
      instructions:
      - text: Count all customer saved searches with API 2020-10.
      - text: Count customer saved searches newer than ID {since_id}, version 2020-10.
        slots:
          since_id: query.since_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/customer_saved_searches/{customer_saved_search_id}/customers.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List customers in a saved search (API 2020-10)
      effect: read
      questions:
      - How do I get every customer that matches a saved search in my Shopify admin?
      - What's the most customers one saved search call returns on API 2020-10?
      instructions:
      - text: List customers returned by saved search {search} with API 2020-10.
        slots:
          search: path.customer_saved_search_id
      - text: Get the first {limit} customers from saved search {search}, version 2020-10.
        slots:
          search: path.customer_saved_search_id
          limit: query.limit
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/customer_saved_searches/count.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Count customer saved searches (API 2021-01)
      effect: read
      questions:
      - What number of customer saved searches exists according to release 2021-01?
      - Does 2021-01 let me count only saved searches after a starting ID?
      instructions:
      - text: Fetch the saved customer search count through 2021-01.
      - text: Using API 2021-01, count saved searches following ID {since_id}.
        slots:
          since_id: query.since_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/customer_saved_searches/{customer_saved_search_id}/customers.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List customers in a saved search (API 2021-01)
      effect: read
      questions:
      - Which shoppers belong to one saved customer search according to 2021-01?
      - Can release 2021-01 limit saved search results to certain customer fields?
      instructions:
      - text: Fetch the customers in saved search {search} through 2021-01.
        slots:
          search: path.customer_saved_search_id
      - text: Using 2021-01, return only {fields} for saved search {search}'s customers.
        slots:
          search: path.customer_saved_search_id
          fields: query.fields
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/customer_saved_searches/count.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Count customer saved searches (unstable API)
      effect: read
      questions:
      - How many customer saved searches does the unstable API count?
      - Can the unstable release count saved searches after a specific ID?
      instructions:
      - text: Count customer saved searches on the unstable API.
      - text: From the unstable version, count saved searches past ID {since_id}.
        slots:
          since_id: query.since_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/customer_saved_searches/{customer_saved_search_id}/customers.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List customers in a saved search (unstable API)
      effect: read
      questions:
      - What customers does a saved search return on the unstable API?
      - Can I cap how many customers come back from a saved search on the unstable release?
      instructions:
      - text: List customers from saved search {search} on the unstable API.
        slots:
          search: path.customer_saved_search_id
      - text: Return {limit} customers from saved search {search} using the unstable version.
        slots:
          search: path.customer_saved_search_id
          limit: query.limit
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/blogs/{blog_id}/articles.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List a blog's articles (API 2020-01)
      effect: read
      questions:
      - Which posts are in one of my store's blogs, per API version 2020-01?
      - Can I filter a blog's articles by tag using release 2020-01?
      instructions:
      - text: List articles in blog {blog_id} using the 2020-01 API.
        slots:
          blog_id: path.blog_id
      - text: Show articles tagged {tag} in blog {blog_id}, API 2020-01.
        slots:
          blog_id: path.blog_id
          tag: query.tag
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/blogs/{blog_id}/articles/count.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Count a blog's articles (API 2020-01)
      effect: read
      questions:
      - How many articles does one blog hold, counted with API 2020-01?
      - Can version 2020-01 count only the published posts in a blog?
      instructions:
      - text: Count the articles in blog {blog_id} using 2020-01.
        slots:
          blog_id: path.blog_id
      - text: Count blog {blog_id} articles whose status is {published_status}, API 2020-01.
        slots:
          blog_id: path.blog_id
          published_status: query.published_status
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/articles/authors.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List blog article authors (API 2020-01)
      effect: read
      questions:
      - Who has written articles on my store blogs, per API version 2020-01?
      - Can I get the names of all article authors with release 2020-01?
      instructions:
      - text: List every article author using the 2020-01 API.
      - text: Show the blog authors across my store via 2020-01.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/articles/tags.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List blog article tags (API 2020-01)
      effect: read
      questions:
      - Which tags are used on my store's blog articles, per API 2020-01?
      - Can version 2020-01 sort article tags by how popular they are?
      instructions:
      - text: List all article tags using the 2020-01 API.
      - text: Show the top {limit} article tags ordered by popularity, API 2020-01.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/blogs/{blog_id}/articles.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List a blog's articles (API 2020-04)
      effect: read
      questions:
      - How do I pull every article from a store blog with version 2020-04?
      - Can I see only unpublished drafts in a blog on 2020-04?
      instructions:
      - text: Get the articles of blog {blog_id} via 2020-04.
        slots:
          blog_id: path.blog_id
      - text: Fetch blog {blog_id} articles with published status {published_status}, release 2020-04.
        slots:
          blog_id: path.blog_id
          published_status: query.published_status
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/blogs/{blog_id}/articles/count.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Count a blog's articles (API 2020-04)
      effect: read
      questions:
      - What's the post total for a store blog on release 2020-04?
      - Can I count a blog's articles created in a date window with 2020-04?
      instructions:
      - text: Get the article count for blog {blog_id} via release 2020-04.
        slots:
          blog_id: path.blog_id
      - text: Tally articles in blog {blog_id} created since {created_at_min}, version 2020-04.
        slots:
          blog_id: path.blog_id
          created_at_min: query.created_at_min
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/articles/authors.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List blog article authors (API 2020-04)
      effect: read
      questions:
      - Which authors appear on my shop's blog posts under version 2020-04?
      - Is there a list of blog writers available in release 2020-04?
      instructions:
      - text: Get all article authors through release 2020-04.
      - text: Fetch the names of blog post authors, API 2020-04.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/articles/tags.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List blog article tags (API 2020-04)
      effect: read
      questions:
      - What tags have been applied to blog posts, checked on release 2020-04?
      - Can I cap how many article tags come back with 2020-04?
      instructions:
      - text: Get every blog article tag via 2020-04.
      - text: Fetch up to {limit} article tags on release 2020-04.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/blogs/{blog_id}/articles.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List a blog's articles (API 2020-07)
      effect: read
      questions:
      - What articles has a given blog published, checked on release 2020-07?
      - Can the 2020-07 API list only one author's articles in a blog?
      instructions:
      - text: Retrieve blog {blog_id}'s articles with version 2020-07.
        slots:
          blog_id: path.blog_id
      - text: On 2020-07, list articles in blog {blog_id} written by {author}.
        slots:
          blog_id: path.blog_id
          author: query.author
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/blogs/{blog_id}/articles/count.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Count a blog's articles (API 2020-07)
      effect: read
      questions:
      - How many posts has a given blog got, per the 2020-07 API?
      - Is it possible to count articles updated recently in one blog on 2020-07?
      instructions:
      - text: Return how many articles blog {blog_id} has on 2020-07.
        slots:
          blog_id: path.blog_id
      - text: On API 2020-07, count blog {blog_id} articles updated after {updated_at_min}.
        slots:
          blog_id: path.blog_id
          updated_at_min: query.updated_at_min
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/articles/authors.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List blog article authors (API 2020-07)
      effect: read
      questions:
      - How do I find out who authored my store's articles on 2020-07?
      - What author names does version 2020-07 return for blog content?
      instructions:
      - text: Retrieve the list of article authors with 2020-07.
      - text: On API 2020-07, list the people who wrote my blog articles.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/articles/tags.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List blog article tags (API 2020-07)
      effect: read
      questions:
      - How do I see the full set of article tags with version 2020-07?
      - Can the 2020-07 API rank blog tags from most to least used?
      instructions:
      - text: Retrieve the article tags in my store with 2020-07.
      - text: On 2020-07, list {limit} blog tags with the most popular first.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/blogs/{blog_id}/articles.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List a blog's articles (API 2020-10)
      effect: read
      questions:
      - How do I list all the articles in one of my Shopify store's blogs?
      - Can I get just the articles published within a date range on API 2020-10?
      - What's the maximum number of blog articles one page returns on 2020-10?
      instructions:
      - text: List every article in blog {blog_id} with API 2020-10.
        slots:
          blog_id: path.blog_id
      - text: Show blog {blog_id} articles published after {published_at_min}, version 2020-10.
        slots:
          blog_id: path.blog_id
          published_at_min: query.published_at_min
      - text: Find the article with handle {handle} in blog {blog_id} on 2020-10.
        slots:
          blog_id: path.blog_id
          handle: query.handle
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/blogs/{blog_id}/articles/count.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Count a blog's articles (API 2020-10)
      effect: read
      questions:
      - How many articles are in one of my Shopify blogs?
      - Can the 2020-10 API count only unpublished articles in a blog?
      instructions:
      - text: Count all articles in blog {blog_id} with API 2020-10.
        slots:
          blog_id: path.blog_id
      - text: Count blog {blog_id} articles published before {published_at_max}, version 2020-10.
        slots:
          blog_id: path.blog_id
          published_at_max: query.published_at_max
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/articles/authors.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List blog article authors (API 2020-10)
      effect: read
      questions:
      - Who are all the authors of articles on my Shopify store blogs?
      - Can the 2020-10 API give me every blog article author name?
      instructions:
      - text: List all article authors with API 2020-10.
      - text: Show me everyone who has authored a blog article, version 2020-10.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/articles/tags.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List blog article tags (API 2020-10)
      effect: read
      questions:
      - What tags are used across all the articles in my Shopify blogs?
      - Which blog article tags are the most popular on API 2020-10?
      instructions:
      - text: List all article tags with API 2020-10.
      - text: Show my {limit} most popular article tags, version 2020-10.
        slots:
          limit: query.limit
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/blogs/{blog_id}/articles.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List a blog's articles (API 2021-01)
      effect: read
      questions:
      - Which articles live in a particular blog, according to release 2021-01?
      - Can 2021-01 limit a blog's articles to ones updated after a date?
      instructions:
      - text: Fetch articles from blog {blog_id} through the 2021-01 release.
        slots:
          blog_id: path.blog_id
      - text: Using 2021-01, get blog {blog_id} articles updated since {updated_at_min}.
        slots:
          blog_id: path.blog_id
          updated_at_min: query.updated_at_min
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/blogs/{blog_id}/articles/count.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Count a blog's articles (API 2021-01)
      effect: read
      questions:
      - What number of articles does release 2021-01 report for a blog?
      - Can I count a blog's posts published after some date using 2021-01?
      instructions:
      - text: Fetch the article total for blog {blog_id} through 2021-01.
        slots:
          blog_id: path.blog_id
      - text: Using 2021-01, count articles in blog {blog_id} published since {published_at_min}.
        slots:
          blog_id: path.blog_id
          published_at_min: query.published_at_min
      method: generated
      generated: '2026-09-24'


# --- truncated at 32 KB (68 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/overlays/shopify-all-api-phrasing-overlay.yaml