Shopify · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Shopify Checkouts API

7 actions 7 updates phrasing extends openapi/shopify-checkouts-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 7

$.info
$.paths['/admin/api/2020-01/checkouts/count.json'].get
$.paths['/admin/api/2020-04/checkouts/count.json'].get
$.paths['/admin/api/2020-07/checkouts/count.json'].get
$.paths['/admin/api/2020-10/checkouts/count.json'].get
$.paths['/admin/api/2021-01/checkouts/count.json'].get
$.paths['/admin/api/unstable/checkouts/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 Checkouts API
  version: 1.0.0
extends: openapi/shopify-checkouts-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: 6
- target: $.paths['/admin/api/2020-01/checkouts/count.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Count abandoned checkouts, last 90 days (API 2020-01)
      effect: read
      questions:
      - How many abandoned checkouts has my store had in the past 90 days on API 2020-01?
      - Can I count only closed abandoned checkouts with version 2020-01?
      instructions:
      - text: Count open abandoned checkouts using 2020-01.
      - text: Count abandoned checkouts with status {status} created after {created_at_min}, API 2020-01.
        slots:
          status: query.status
          created_at_min: query.created_at_min
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/checkouts/count.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Count abandoned checkouts, last 90 days (API 2020-04)
      effect: read
      questions:
      - What's the number of carts customers left unfinished recently, per release 2020-04?
      - Is it possible to count checkouts updated within a date window on 2020-04?
      instructions:
      - text: Give me a tally of abandoned checkouts from the last 90 days via 2020-04.
      - text: Count checkouts last updated between {updated_at_min} and {updated_at_max} on 2020-04.
        slots:
          updated_at_min: query.updated_at_min
          updated_at_max: query.updated_at_max
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/checkouts/count.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Count abandoned checkouts, last 90 days (API 2020-07)
      effect: read
      questions:
      - How big is my abandoned-cart backlog this quarter, according to version 2020-07?
      - Does 2020-07 let me count checkouts created before a certain date?
      instructions:
      - text: Tell me how many abandoned checkouts are still open, 2020-07.
      - text: Count 2020-07 abandoned checkouts created before {created_at_max}.
        slots:
          created_at_max: query.created_at_max
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/checkouts/count.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Count abandoned checkouts, last 90 days (API 2020-10)
      effect: read
      questions:
      - What number of shoppers abandoned checkout over the past 90 days in 2020-10?
      - Which statuses can I count abandoned checkouts by on version 2020-10?
      instructions:
      - text: Return the abandoned checkout count for my store, API 2020-10.
      - text: Count {status} abandoned checkouts on 2020-10.
        slots:
          status: query.status
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/checkouts/count.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Count abandoned checkouts, last 90 days (API 2021-01)
      effect: read
      questions:
      - How many checkouts went unpaid in the last three months, per 2021-01?
      - Can release 2021-01 count abandoned checkouts after a known checkout ID?
      instructions:
      - text: Get the 90-day abandoned checkout total with 2021-01.
      - text: Count abandoned checkouts newer than ID {since_id}, version 2021-01.
        slots:
          since_id: query.since_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/checkouts/count.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Count abandoned checkouts, last 90 days (unstable API)
      effect: read
      questions:
      - What does the unstable API report as my abandoned checkout count?
      - Can I narrow the unstable checkout count to a creation date range?
      instructions:
      - text: Count recent abandoned carts through the unstable release.
      - text: Count unstable-API checkouts created from {created_at_min} to {created_at_max}.
        slots:
          created_at_min: query.created_at_min
          created_at_max: query.created_at_max
      method: generated
      generated: '2026-09-24'