Shopify · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Shopify Lists API
70 actions
70 updates
phrasing
extends
openapi/shopify-lists-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 70 · first 16 shown; the file carries all of them
$.info
$.paths['/admin/api/2020-01/reports.json'].get
$.paths['/admin/api/2020-04/reports.json'].get
$.paths['/admin/api/2020-07/reports.json'].get
$.paths['/admin/api/2020-10/reports.json'].get
$.paths['/admin/api/2021-01/reports.json'].get
$.paths['/admin/api/unstable/reports.json'].get
$.paths['/admin/api/2020-01/webhooks.json'].get
$.paths['/admin/api/2020-04/webhooks.json'].get
$.paths['/admin/api/2020-07/webhooks.json'].get
$.paths['/admin/api/2020-10/webhooks.json'].get
$.paths['/admin/api/2021-01/webhooks.json'].get
$.paths['/admin/api/unstable/webhooks.json'].get
$.paths['/admin/api/2020-01/locations.json'].get
$.paths['/admin/api/2020-04/locations.json'].get
$.paths['/admin/api/2020-07/locations.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 Lists API
version: 1.0.0
extends: openapi/shopify-lists-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: 69
- target: $.paths['/admin/api/2020-01/reports.json'].get
update:
x-apievangelist-phrasing:
intent: List reports (API 2020-01)
effect: read
questions:
- Which custom reports exist in my Shopify store under the 2020-01 Admin API?
- Can the 2020-01 reports endpoint return only reports updated after a certain date?
instructions:
- text: List reports via the 2020-01 API updated since {updated_at_min}.
slots:
updated_at_min: query.updated_at_min
- text: Fetch reports {ids} using API version 2020-01.
slots:
ids: query.ids
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/reports.json'].get
update:
x-apievangelist-phrasing:
intent: List reports (API 2020-04)
effect: read
questions:
- What analytics reports can I list on API version 2020-04?
- Is there a page size cap when pulling reports with the 2020-04 version?
instructions:
- text: Get up to {limit} reports from the 2020-04 reports endpoint.
slots:
limit: query.limit
- text: Page through 2020-04 reports after report {since_id}.
slots:
since_id: query.since_id
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/reports.json'].get
update:
x-apievangelist-phrasing:
intent: List reports (API 2020-07)
effect: read
questions:
- What reports has my app created, according to the 2020-07 API?
- Can I pull only certain report fields from the 2020-07 reports list?
instructions:
- text: Show only {fields} for each report on API 2020-07.
slots:
fields: query.fields
- text: List reports changed before {updated_at_max} with version 2020-07.
slots:
updated_at_max: query.updated_at_max
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/reports.json'].get
update:
x-apievangelist-phrasing:
intent: List reports (API 2020-10)
effect: read
questions:
- Where do I see all the reports in my shop on the 2020-10 Admin API?
- Can I fetch specific reports by ID from the 2020-10 reports list?
instructions:
- text: List every report in my shop with API version 2020-10.
- text: Pull reports {ids} from the 2020-10 endpoint, {limit} at a time.
slots:
ids: query.ids
limit: query.limit
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/reports.json'].get
update:
x-apievangelist-phrasing:
intent: List reports (API 2021-01)
effect: read
questions:
- Does the 2021-01 API still let me list store reports?
- Can I filter the 2021-01 report list to a window of update dates?
instructions:
- text: List 2021-01 reports updated between {updated_at_min} and {updated_at_max}.
slots:
updated_at_min: query.updated_at_min
updated_at_max: query.updated_at_max
- text: Give me report IDs after {since_id} on API 2021-01.
slots:
since_id: query.since_id
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/reports.json'].get
update:
x-apievangelist-phrasing:
intent: List reports (unstable API)
effect: read
questions:
- Can I list reports on the unstable Admin API version?
- What does the unstable reports endpoint return if I limit the fields?
instructions:
- text: List reports on the unstable API version.
- text: Fetch {limit} reports from the unstable version showing {fields}.
slots:
limit: query.limit
fields: query.fields
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/webhooks.json'].get
update:
x-apievangelist-phrasing:
intent: List webhook subscriptions (API 2020-01)
effect: read
questions:
- Which webhook subscriptions does my app have on API version 2020-01?
- Can I find 2020-01 webhooks pointed at a particular callback URL?
instructions:
- text: List 2020-01 webhooks delivering to {address}.
slots:
address: query.address
- text: Show webhooks created after {created_at_min} using version 2020-01.
slots:
created_at_min: query.created_at_min
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/webhooks.json'].get
update:
x-apievangelist-phrasing:
intent: List webhook subscriptions (API 2020-04)
effect: read
questions:
- Can I list only the webhooks for one topic, like orders/create, on the 2020-04 API?
- What webhooks were registered before a given date under 2020-04?
instructions:
- text: List webhook subscriptions for topic {topic} on API 2020-04.
slots:
topic: query.topic
- text: Get webhooks created before {created_at_max} via the 2020-04 version.
slots:
created_at_max: query.created_at_max
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/webhooks.json'].get
update:
x-apievangelist-phrasing:
intent: List webhook subscriptions (API 2020-07)
effect: read
questions:
- Which webhooks changed recently according to the 2020-07 Admin API?
- Is there a limit on how many webhooks the 2020-07 list returns per page?
instructions:
- text: Show webhooks updated since {updated_at_min} with API 2020-07.
slots:
updated_at_min: query.updated_at_min
- text: Return {limit} webhooks per page from the 2020-07 endpoint.
slots:
limit: query.limit
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/webhooks.json'].get
update:
x-apievangelist-phrasing:
intent: List webhook subscriptions (API 2020-10)
effect: read
questions:
- What webhook subscriptions are active on my store under the 2020-10 API?
- Can I page through a long webhook list on 2020-10 using the last ID I saw?
instructions:
- text: List all my webhook subscriptions using API version 2020-10.
- text: Continue listing 2020-10 webhooks after {since_id}.
slots:
since_id: query.since_id
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/webhooks.json'].get
update:
x-apievangelist-phrasing:
intent: List webhook subscriptions (API 2021-01)
effect: read
questions:
- Does the 2021-01 API let me see which webhooks point at my server?
- Can I trim the 2021-01 webhook list down to a few fields?
instructions:
- text: List 2021-01 webhooks for topic {topic} sending to {address}.
slots:
topic: query.topic
address: query.address
- text: Return only {fields} for each webhook on API 2021-01.
slots:
fields: query.fields
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/webhooks.json'].get
update:
x-apievangelist-phrasing:
intent: List webhook subscriptions (unstable API)
effect: read
questions:
- Can I list webhooks on the unstable version of the Admin API?
- Which webhooks were last modified before a date, per the unstable API?
instructions:
- text: List webhooks on the unstable API version.
- text: Get unstable-version webhooks updated before {updated_at_max}.
slots:
updated_at_max: query.updated_at_max
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/locations.json'].get
update:
x-apievangelist-phrasing:
intent: List store locations (API 2020-01)
effect: read
questions:
- What store locations does my shop have under the 2020-01 API?
- Can the 2020-01 API show me all the places my shop stocks inventory?
instructions:
- text: List all locations with API version 2020-01.
- text: Show my shop's warehouses and retail locations from the 2020-01 endpoint.
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/locations.json'].get
update:
x-apievangelist-phrasing:
intent: List store locations (API 2020-04)
effect: read
questions:
- Which warehouses and retail stores are set up for my shop in version 2020-04?
- Is there a 2020-04 endpoint that lists every location at once?
instructions:
- text: Get my store locations through the 2020-04 API.
- text: Pull the full location list on version 2020-04.
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/locations.json'].get
update:
x-apievangelist-phrasing:
intent: List store locations (API 2020-07)
effect: read
questions:
- Where can I see my shop's physical locations using API 2020-07?
- Does listing locations on 2020-07 take any filters?
instructions:
- text: List locations via the 2020-07 Admin API.
- text: Fetch every location my shop has, version 2020-07.
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/locations.json'].get
update:
x-apievangelist-phrasing:
intent: List store locations (API 2020-10)
effect: read
questions:
- What locations are configured for my Shopify store on API 2020-10?
- Can I get all fulfillment and retail locations in one call with 2020-10?
instructions:
- text: List my shop's locations using API version 2020-10.
- text: Show every location on the 2020-10 endpoint.
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/locations.json'].get
update:
x-apievangelist-phrasing:
intent: List store locations (API 2021-01)
effect: read
questions:
- Does the 2021-01 API list my shop's locations?
- Which locations exist in my store according to version 2021-01?
instructions:
- text: Retrieve locations with the 2021-01 API.
- text: Give me my store's location list from 2021-01.
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/locations.json'].get
update:
x-apievangelist-phrasing:
intent: List store locations (unstable API)
effect: read
questions:
- Can I list locations on the unstable Admin API?
- What does the unstable version return for my shop's locations?
instructions:
- text: List locations on the unstable API version.
- text: Fetch shop locations from the unstable endpoint.
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/redirects.json'].get
update:
x-apievangelist-phrasing:
intent: List URL redirects (API 2020-01)
effect: read
questions:
- Which URL redirects are set up in my online store under API 2020-01?
- Can I find the 2020-01 redirect for a specific old path?
instructions:
- text: List 2020-01 redirects from path {path}.
slots:
path: query.path
- text: Show {limit} URL redirects using version 2020-01.
slots:
limit: query.limit
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/redirects.json'].get
update:
x-apievangelist-phrasing:
intent: List URL redirects (API 2020-04)
effect: read
questions:
- Is there a way to see every redirect pointing at one target URL with API 2020-04?
- Which old URLs forward visitors elsewhere, per the 2020-04 API?
instructions:
- text: List 2020-04 redirects that send traffic to {target}.
slots:
target: query.target
- text: Get URL redirects via API 2020-04.
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/redirects.json'].get
update:
x-apievangelist-phrasing:
intent: List URL redirects (API 2020-07)
effect: read
questions:
- Can I page through my store's URL redirects using the 2020-07 version?
- Which fields can I limit the 2020-07 redirect list to?
instructions:
- text: List URL redirects after {since_id} on version 2020-07.
slots:
since_id: query.since_id
- text: Return only {fields} for each redirect with the 2020-07 API.
slots:
fields: query.fields
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/redirects.json'].get
update:
x-apievangelist-phrasing:
intent: List URL redirects (API 2020-10)
effect: read
questions:
- What URL redirects does my online store have on API 2020-10?
- Can I check whether a 2020-10 redirect already exists for a path?
instructions:
- text: List all URL redirects with API version 2020-10.
- text: Find the 2020-10 redirect whose old path is {path}.
slots:
path: query.path
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/redirects.json'].get
update:
x-apievangelist-phrasing:
intent: List URL redirects (API 2021-01)
effect: read
questions:
- Does API 2021-01 let me list redirects by destination?
- How many redirects can the 2021-01 list return in one page?
instructions:
- text: List 2021-01 redirects pointing at {target}.
slots:
target: query.target
- text: Get {limit} redirects per page from the 2021-01 endpoint.
slots:
limit: query.limit
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/redirects.json'].get
update:
x-apievangelist-phrasing:
intent: List URL redirects (unstable API)
effect: read
questions:
- Can I list URL redirects on the unstable API version?
- Which redirects start from a given path on the unstable API?
instructions:
- text: List redirects on the unstable API version.
- text: Show unstable-version redirects from {path} to {target}.
slots:
path: query.path
target: query.target
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/themes.json'].get
update:
x-apievangelist-phrasing:
intent: List themes (API 2020-01)
effect: read
questions:
- Which themes are installed on my online store under API 2020-01?
- Can I get just a few theme fields from the 2020-01 themes list?
instructions:
- text: List my store's themes with API 2020-01.
- text: Show {fields} for each theme on version 2020-01.
slots:
fields: query.fields
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/themes.json'].get
update:
x-apievangelist-phrasing:
intent: List themes (API 2020-04)
effect: read
questions:
- What themes does my shop have per the 2020-04 Admin API?
- Is there a 2020-04 call to see all installed themes?
instructions:
- text: Get themes through the 2020-04 endpoint.
- text: List themes on 2020-04 returning only {fields}.
slots:
fields: query.fields
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/themes.json'].get
update:
x-apievangelist-phrasing:
intent: List themes (API 2020-07)
effect: read
questions:
- Can I see every theme on my store with the 2020-07 API?
- Which themes are uploaded to my shop according to version 2020-07?
instructions:
- text: List installed themes via API version 2020-07.
- text: Pull theme {fields} from the 2020-07 themes list.
slots:
fields: query.fields
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/themes.json'].get
update:
x-apievangelist-phrasing:
intent: List themes (API 2020-10)
effect: read
questions:
- What themes are on my Shopify online store using API 2020-10?
- Can I narrow the 2020-10 theme list to a few fields?
instructions:
- text: List all themes with API version 2020-10.
- text: Fetch the 2020-10 theme list with fields {fields}.
slots:
fields: query.fields
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/themes.json'].get
update:
x-apievangelist-phrasing:
intent: List themes (API 2021-01)
effect: read
questions:
- Does version 2021-01 still list my store's themes?
- Which themes does the 2021-01 API report for my shop?
instructions:
- text: Retrieve themes using the 2021-01 API.
- text: Return {fields} for my themes on 2021-01.
slots:
fields: query.fields
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/themes.json'].get
update:
x-apievangelist-phrasing:
intent: List themes (unstable API)
effect: read
questions:
- Can I list themes on the unstable API version?
- What does the unstable themes endpoint return for my store?
instructions:
- text: List themes on the unstable API version.
- text: Show theme {fields} from the unstable endpoint.
slots:
fields: query.fields
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/orders.json'].get
update:
x-apievangelist-phrasing:
intent: List orders (API 2020-01)
effect: read
questions:
- How do I list unpaid orders using the 2020-01 Admin API?
- Can the 2020-01 orders list show only unfulfilled orders?
instructions:
- text: List 2020-01 orders with financial status {financial_status}.
slots:
financial_status: query.financial_status
- text: Show orders created after {created_at_min} via API 2020-01.
slots:
created_at_min: query.created_at_min
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/orders.json'].get
update:
x-apievangelist-phrasing:
intent: List orders (API 2020-04)
effect: read
questions:
- Which orders were placed in a date range, per the 2020-04 API?
- Can I list closed or cancelled orders with version 2020-04?
instructions:
- text: List orders created between {created_at_min} and {created_at_max} on API 2020-04.
slots:
created_at_min: query.created_at_min
created_at_max: query.created_at_max
- text: Get 2020-04 orders with status {status}.
slots:
status: query.status
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/orders.json'].get
update:
x-apievangelist-phrasing:
intent: List orders (API 2020-07)
effect: read
questions:
- Can I list orders that came in through a specific app using API 2020-07?
- Which orders were processed after a given date under 2020-07?
instructions:
- text: List 2020-07 orders attributed to app {attribution_app_id}.
slots:
attribution_app_id: query.attribution_app_id
- text: Show orders with fulfillment status {fulfillment_status} using version 2020-07.
slots:
fulfillment_status: query.fulfillment_status
- text: Get 2020-07 orders processed after {processed_at_min}.
slots:
processed_at_min: query.processed_at_min
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/orders/{order_id}/refunds.json'].get
update:
x-apievangelist-phrasing:
intent: List an order's refunds (API 2020-01)
effect: read
questions:
- Which refunds were issued on an order, per the 2020-01 API?
- Can I see an order's refunds in my shop's currency with 2020-01?
instructions:
- text: List refunds for order {order_id} using API 2020-01.
slots:
order_id: path.order_id
- text: Show 2020-01 refunds on order {order_id} with shop-currency amounts set to {in_shop_currency}.
slots:
order_id: path.order_id
in_shop_currency: query.in_shop_currency
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/orders/{order_id}/refunds.json'].get
update:
x-apievangelist-phrasing:
intent: List an order's refunds (API 2020-04)
effect: read
questions:
- What refunds has an order received according to version 2020-04?
- Is there a cap on refunds returned per order in the 2020-04 list?
instructions:
- text: Get refunds on order {order_id} via the 2020-04 endpoint.
slots:
order_id: path.order_id
- text: List {limit} refunds for order {order_id} with version 2020-04.
slots:
limit: query.limit
order_id: path.order_id
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/orders/{order_id}/refunds.json'].get
update:
x-apievangelist-phrasing:
intent: List an order's refunds (API 2020-07)
effect: read
questions:
- Can I list an order's refunds with API 2020-07?
- Can the 2020-07 refunds list return just some fields per refund?
instructions:
- text: List refunds for order {order_id} on API 2020-07.
slots:
order_id: path.order_id
- text: Return {fields} for each refund on order {order_id}, version 2020-07.
slots:
fields: query.fields
order_id: path.order_id
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/orders/{order_id}/refunds.json'].get
update:
x-apievangelist-phrasing:
intent: List an order's refunds (API 2020-10)
effect: read
questions:
- Where do I find every refund on a customer's order with API 2020-10?
- Can the 2020-10 refunds list show amounts in my shop currency?
instructions:
- text: List all refunds on order {order_id} using version 2020-10.
slots:
order_id: path.order_id
- text: Get 2020-10 refunds for order {order_id}, limited to {limit}.
slots:
order_id: path.order_id
limit: query.limit
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/orders/{order_id}/refunds.json'].get
update:
x-apievangelist-phrasing:
intent: List an order's refunds (API 2021-01)
effect: read
questions:
- Does the 2021-01 API list refunds for an order?
- Which refunds were made on an order under version 2021-01?
instructions:
- text: Retrieve order {order_id} refunds with API 2021-01.
slots:
order_id: path.order_id
- text: List 2021-01 refunds for order {order_id} showing only {fields}.
slots:
order_id: path.order_id
fields: query.fields
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/orders/{order_id}/refunds.json'].get
update:
x-apievangelist-phrasing:
intent: List an order's refunds (unstable API)
effect: read
questions:
- Can I list an order's refunds on the unstable API version?
- What refunds does the unstable API show for an order?
instructions:
- text: List refunds for order {order_id} on the unstable version.
slots:
order_id: path.order_id
- text: Fetch order {order_id} refunds from the unstable endpoint with shop currency {in_shop_currency}.
slots:
order_id: path.order_id
in_shop_currency: query.in_shop_currency
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/collects.json'].get
update:
x-apievangelist-phrasing:
intent: List collects (API 2020-01)
effect: read
questions:
- Which product-to-collection links (collects) exist in my shop under API 2020-01?
- Can I page through collects with the 2020-01 version?
instructions:
- text: List collects with API 2020-01.
- text: Get collects after {since_id} on version 2020-01.
slots:
since_id: query.since_id
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/collects.json'].get
update:
x-apievangelist-phrasing:
intent: List collects (API 2020-04)
effect: read
questions:
- What collects does version 2020-04 return for my store?
- Is there a page size limit on the 2020-04 collects list?
instructions:
- text: List {limit} collects via the 2020-04 endpoint.
slots:
limit: query.limit
- text: Retrieve collects using API 2020-04.
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/collects.json'].get
update:
x-apievangelist-phrasing:
intent: List collects (API 2020-07)
effect: read
questions:
- Can I see which products sit in which collections via collects on API 2020-07?
- Can I return only some fields from the 2020-07 collects list?
instructions:
- text: List collects on version 2020-07.
- text: Return {fields} for each collect with API 2020-07.
slots:
fields: query.fields
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/collects.json'].get
update:
x-apievangelist-phrasing:
intent: List collects (API 2020-10)
effect: read
questions:
- How do I list all collects in my shop with API 2020-10?
- Can I continue a 2020-10 collects listing from the last ID I saw?
instructions:
- text: List every collect using API version 2020-10.
- text: Page 2020-10 collects starting after {since_id}, {limit} at a time.
slots:
since_id: query.since_id
limit: query.limit
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/collects.json'].get
update:
x-apievangelist-phrasing:
intent: List collects (API 2021-01)
effect: read
questions:
- Does the 2021-01 API still list collects?
- Which collects link products to collections per version 2021-01?
instructions:
- text: Retrieve collects through the 2021-01 API.
- text: List 2021-01 collects with only {fields}.
slots:
fields: query.fields
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/collects.json'].get
update:
x-apievangelist-phrasing:
intent: List collects (unstable API)
effect: read
questions:
- Can I list collects on the unstable API version?
- What collects does the unstable endpoint return?
instructions:
- text: List collects on the unstable API version.
- text: Get {limit} collects from the unstable endpoint.
slots:
limit: query.limit
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/products.json'].get
update:
x-apievangelist-phrasing:
intent: List products (API 2020-01)
effect: read
questions:
- Can I list products from a single vendor with the 2020-01 API?
- Which products are in a given collection according to version 2020-01?
instructions:
- text: List 2020-01 products from vendor {vendor}.
slots:
vendor: query.vendor
- text: Show products in collection {collection_id} on API 2020-01.
slots:
collection_id: query.collection_id
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/products.json'].get
update:
x-apievangelist-phrasing:
intent: List products (API 2020-04)
effect: read
questions:
- Which products have a certain product type under API 2020-04?
- Can I list only draft or archived products with version 2020-04?
instructions:
- text: List products of type {product_type} via API 2020-04.
slots:
product_type: query.product_type
- text: Get 2020-04 products with status {status}.
slots:
status: query.status
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/products.json'].get
update:
x-apievangelist-phrasing:
intent: List products (API 2020-07)
effect: read
questions:
- Can I find a product by its handle using the 2020-07 products list?
- Which products were published within a date range per 2020-07?
instructions:
- text: Find 2020-07 products with handle {handle}.
slots:
handle: query.handle
- text: List products published between {published_at_min} and {published_at_max} on version 2020-07.
slots:
published_at_min: query.published_at_min
published_at_max: query.published_at_max
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/products.json'].get
update:
x-apievangelist-phrasing:
intent: List products (API 2020-10)
effect: read
questions:
- How do I list all products in my Shopify store with API 2020-10?
- Can the 2020-10 product list show prices in other presentment currencies?
instructions:
- text: List products titled {title} using API version 2020-10.
slots:
title: query.title
- text: Get 2020-10 products with prices in {presentment_currencies}.
slots:
presentment_currencies: query.presentment_currencies
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/products.json'].get
update:
x-apievangelist-phrasing:
intent: List products (API 2021-01)
effect: read
questions:
- Does version 2021-01 let me list only unpublished products?
- Which products changed since a certain date according to 2021-01?
instructions:
- text: List 2021-01 products with published status {published_status}.
slots:
published_status: query.published_status
- text: Show products updated after {updated_at_min} via API 2021-01.
slots:
updated_at_min: query.updated_at_min
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/products.json'].get
update:
x-apievangelist-phrasing:
intent: List products (unstable API)
effect: read
questions:
- Can I list products on the unstable API version?
- Which products were created recently according to the unstable API?
instructions:
- text: List products on the unstable API version.
- text: Get unstable-version products created after {created_at_min}, {limit} per page.
slots:
created_at_min: query.created_at_min
limit: query.limit
method: generated
generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/policies.json'].get
update:
x-apievangelist-phrasing:
intent: List shop policies (API 2020-01)
effect: read
questions:
- What store policies has my shop set up under API 2020-01?
- Can I read my shop's policies with the 2020-01 version?
instructions:
- text: List my shop's policies with API 2020-01.
- text: Show the store policies from version 2020-01.
method: generated
generated: '2026-09-24'
# --- truncated at 32 KB (42 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/overlays/shopify-lists-api-phrasing-overlay.yaml