API Evangelist conversational phrasing for Shopify Checkout API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Shopify Checkout API
  version: 1.0.0
extends: openapi/shopify-checkout-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: 36
- target: $.paths['/admin/api/2020-01/checkouts.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a new sales-channel checkout (API 2020-01)
      effect: write
      questions:
      - How does my sales channel app open a new checkout for a buyer on API 2020-01?
      - Can a sales channel create checkouts through version 2020-01?
      instructions:
      - text: Create a new checkout for my sales channel using 2020-01.
      - text: Open a fresh buyer checkout via release 2020-01.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/checkouts.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a new sales-channel checkout (API 2020-04)
      effect: write
      questions:
      - Which 2020-04 call begins a checkout session from my sales channel?
      - Is creating a checkout supported on release 2020-04?
      instructions:
      - text: Start a checkout for a shopper with API 2020-04.
      - text: Begin a new sales-channel checkout on version 2020-04.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/checkouts.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a new sales-channel checkout (API 2020-07)
      effect: write
      questions:
      - Can my channel app spin up a checkout for a customer using 2020-07?
      - What 2020-07 request creates a checkout before payment?
      instructions:
      - text: Create a checkout through the 2020-07 release.
      - text: Set up a new checkout for my buyer, version 2020-07.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/checkouts.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a new sales-channel checkout (API 2020-10)
      effect: write
      questions:
      - How do I create a checkout from a sales channel on 2020-10?
      - Which 2020-10 endpoint kicks off a checkout for my channel's shopper?
      instructions:
      - text: Open a new checkout via API 2020-10.
      - text: Create a sales channel checkout for a customer on 2020-10.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/checkouts.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a new sales-channel checkout (API 2021-01)
      effect: write
      questions:
      - Can I start a checkout for a buyer through version 2021-01?
      - What request creates a checkout on release 2021-01?
      instructions:
      - text: Create a checkout for my sales channel with 2021-01.
      - text: Kick off a new shopper checkout on version 2021-01.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/checkouts.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Start a new sales-channel checkout (unstable API)
      effect: write
      questions:
      - Can the unstable API create a checkout for my sales channel?
      - Is starting a buyer checkout available on the unstable release?
      instructions:
      - text: Create a checkout using the unstable API version.
      - text: Begin a sales-channel checkout on the unstable release.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/checkouts/{token}/complete.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Complete a checkout without payment (API 2020-01)
      effect: write
      questions:
      - How do I finish a checkout that needs no payment, like a free order, on 2020-01?
      - Can I turn a checkout into an order with API 2020-01?
      instructions:
      - text: Complete checkout {token} using version 2020-01.
        slots:
          token: path.token
      - text: Finalize the checkout {token} into an order via 2020-01.
        slots:
          token: path.token
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/checkouts/{token}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a checkout by token (API 2020-01)
      effect: read
      questions:
      - What's in a buyer's checkout right now, like line items and totals, on 2020-01?
      - Can I check whether a checkout is ready to complete with release 2020-01?
      instructions:
      - text: Get checkout {token} with API 2020-01.
        slots:
          token: path.token
      - text: Show the current state of checkout {token}, version 2020-01.
        slots:
          token: path.token
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/checkouts/{token}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Change an existing checkout (API 2020-01)
      effect: write
      questions:
      - Can I modify a checkout the buyer already started on API 2020-01?
      - Which 2020-01 call edits an open checkout before it's completed?
      instructions:
      - text: Update checkout {token} on release 2020-01.
        slots:
          token: path.token
      - text: Modify the in-progress checkout {token} via 2020-01.
        slots:
          token: path.token
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/checkouts/{token}/complete.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Complete a checkout without payment (API 2020-04)
      effect: write
      questions:
      - Can I close out a zero-cost checkout into an order through 2020-04?
      - Which 2020-04 request completes a checkout?
      instructions:
      - text: Complete the checkout {token} with 2020-04.
        slots:
          token: path.token
      - text: Convert checkout {token} into an order on release 2020-04.
        slots:
          token: path.token
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/checkouts/{token}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a checkout by token (API 2020-04)
      effect: read
      questions:
      - Can I read back a checkout's details using its token on 2020-04?
      - What does version 2020-04 show for one buyer's checkout?
      instructions:
      - text: Retrieve checkout {token} via release 2020-04.
        slots:
          token: path.token
      - text: Look up buyer checkout {token} on API 2020-04.
        slots:
          token: path.token
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/checkouts/{token}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Change an existing checkout (API 2020-04)
      effect: write
      questions:
      - Is editing an existing checkout supported on version 2020-04?
      - Can my sales channel revise a checkout mid-purchase with 2020-04?
      instructions:
      - text: Modify checkout {token} using API 2020-04.
        slots:
          token: path.token
      - text: Save changes to the open checkout {token}, 2020-04.
        slots:
          token: path.token
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/checkouts/{token}/complete.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Complete a checkout without payment (API 2020-07)
      effect: write
      questions:
      - How can a checkout that requires no payment be completed on 2020-07?
      - Can release 2020-07 place the order for a finished checkout?
      instructions:
      - text: Complete checkout {token} through version 2020-07.
        slots:
          token: path.token
      - text: Place the order for checkout {token} on API 2020-07.
        slots:
          token: path.token
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/checkouts/{token}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a checkout by token (API 2020-07)
      effect: read
      questions:
      - Where can I see a checkout's line items and totals on API 2020-07?
      - Can 2020-07 tell me the status of one checkout by token?
      instructions:
      - text: Fetch checkout {token} with version 2020-07.
        slots:
          token: path.token
      - text: Show me checkout {token} as it stands, release 2020-07.
        slots:
          token: path.token
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/checkouts/{token}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Change an existing checkout (API 2020-07)
      effect: write
      questions:
      - Can I amend a checkout that's still open with 2020-07?
      - What 2020-07 call updates an existing checkout by token?
      instructions:
      - text: Edit checkout {token} via 2020-07.
        slots:
          token: path.token
      - text: Update the buyer's open checkout {token} on version 2020-07.
        slots:
          token: path.token
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/checkouts/{token}/complete.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Complete a checkout without payment (API 2020-10)
      effect: write
      questions:
      - Can I complete a free checkout and create the order on 2020-10?
      - Which 2020-10 endpoint finalizes a checkout?
      instructions:
      - text: Complete checkout {token} on API 2020-10.
        slots:
          token: path.token
      - text: Wrap up checkout {token} as an order using 2020-10.
        slots:
          token: path.token
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/checkouts/{token}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a checkout by token (API 2020-10)
      effect: read
      questions:
      - How do I view one checkout's contents by its token on 2020-10?
      - Can version 2020-10 show if a checkout has been completed yet?
      instructions:
      - text: Get the checkout {token} using API 2020-10.
        slots:
          token: path.token
      - text: Read checkout {token} details on 2020-10.
        slots:
          token: path.token
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/checkouts/{token}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Change an existing checkout (API 2020-10)
      effect: write
      questions:
      - Can I update a buyer's existing checkout through 2020-10?
      - Which 2020-10 request changes a checkout before it's paid?
      instructions:
      - text: Update checkout {token} with version 2020-10.
        slots:
          token: path.token
      - text: Change the in-progress checkout {token}, API 2020-10.
        slots:
          token: path.token
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/checkouts/{token}/complete.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Complete a checkout without payment (API 2021-01)
      effect: write
      questions:
      - Can I finish a no-payment checkout using release 2021-01?
      - What 2021-01 call completes a checkout into an order?
      instructions:
      - text: Complete checkout {token} via release 2021-01.
        slots:
          token: path.token
      - text: Finalize checkout {token} and create its order on 2021-01.
        slots:
          token: path.token
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/checkouts/{token}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a checkout by token (API 2021-01)
      effect: read
      questions:
      - Can I retrieve a checkout by its token on version 2021-01?
      - What does 2021-01 return for a single buyer checkout?
      instructions:
      - text: Get checkout {token} through 2021-01.
        slots:
          token: path.token
      - text: Pull up buyer checkout {token} on API 2021-01.
        slots:
          token: path.token
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/checkouts/{token}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Change an existing checkout (API 2021-01)
      effect: write
      questions:
      - Can I alter an open checkout with API 2021-01?
      - Which 2021-01 endpoint modifies an existing checkout?
      instructions:
      - text: Update checkout {token} on release 2021-01.
        slots:
          token: path.token
      - text: Revise the open checkout {token} using 2021-01.
        slots:
          token: path.token
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/checkouts/{token}/complete.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Complete a checkout without payment (unstable API)
      effect: write
      questions:
      - Can the unstable API complete a checkout that needs no payment?
      - Is finalizing a checkout into an order available on the unstable release?
      instructions:
      - text: Complete checkout {token} with the unstable API.
        slots:
          token: path.token
      - text: Turn checkout {token} into an order on the unstable version.
        slots:
          token: path.token
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/checkouts/{token}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up a checkout by token (unstable API)
      effect: read
      questions:
      - Can I read a checkout by token through the unstable API?
      - What does the unstable release show for one checkout?
      instructions:
      - text: Get checkout {token} from the unstable API.
        slots:
          token: path.token
      - text: Show checkout {token} on the unstable release.
        slots:
          token: path.token
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/checkouts/{token}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Change an existing checkout (unstable API)
      effect: write
      questions:
      - Can I modify an existing checkout using the unstable version?
      - Is updating an open checkout supported on the unstable API?
      instructions:
      - text: Update checkout {token} via the unstable API.
        slots:
          token: path.token
      - text: Edit open checkout {token} on the unstable release.
        slots:
          token: path.token
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/checkouts/{token}/payments.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List payments on a checkout (API 2020-01)
      effect: read
      questions:
      - Which payment attempts were made on a buyer's checkout, per API 2020-01?
      - Can I see failed and successful payments for one checkout on 2020-01?
      instructions:
      - text: List payments on checkout {token} using 2020-01.
        slots:
          token: path.token
      - text: Show every payment attempt for checkout {token}, release 2020-01.
        slots:
          token: path.token
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/checkouts/{token}/payments/count.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Count payment attempts on a checkout (API 2020-01)
      effect: read
      questions:
      - How many times has a buyer tried to pay on one checkout, on version 2020-01?
      - Can I get just a number of payment attempts for a checkout with 2020-01?
      instructions:
      - text: Count payment attempts on checkout {token} with 2020-01.
        slots:
          token: path.token
      - text: Tell me how many payments were tried on checkout {token}, API 2020-01.
        slots:
          token: path.token
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/checkouts/{token}/payments.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List payments on a checkout (API 2020-04)
      effect: read
      questions:
      - What payments has a checkout received so far when read through 2020-04?
      - Can release 2020-04 list the payment records attached to a checkout?
      instructions:
      - text: Get the payments made against checkout {token} on 2020-04.
        slots:
          token: path.token
      - text: List payment records for checkout {token} via version 2020-04.
        slots:
          token: path.token
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/checkouts/{token}/payments/count.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Count payment attempts on a checkout (API 2020-04)
      effect: read
      questions:
      - What's the total number of payment tries on a checkout under 2020-04?
      - Is there a count-only call for checkout payments in release 2020-04?
      instructions:
      - text: Count the payments attempted on checkout {token} via 2020-04.
        slots:
          token: path.token
      - text: Give me the payment attempt total for checkout {token}, 2020-04.
        slots:
          token: path.token
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/checkouts/{token}/payments.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List payments on a checkout (API 2020-07)
      effect: read
      questions:
      - Can I review each payment a shopper submitted on a checkout with 2020-07?
      - Which payments belong to one checkout according to version 2020-07?
      instructions:
      - text: Show payments for checkout {token} with API 2020-07.
        slots:
          token: path.token
      - text: List the payment attempts recorded on checkout {token}, 2020-07.
        slots:
          token: path.token
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/checkouts/{token}/payments/count.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Count payment attempts on a checkout (API 2020-07)
      effect: read
      questions:
      - How many payment attempts sit on a checkout per API 2020-07?
      - Can 2020-07 count checkout payments without listing them?
      instructions:
      - text: Count payments on checkout {token}, version 2020-07.
        slots:
          token: path.token
      - text: Return the number of payment tries for checkout {token} on 2020-07.
        slots:
          token: path.token
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/checkouts/{token}/payments.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List payments on a checkout (API 2020-10)
      effect: read
      questions:
      - Can I see the payment history of one checkout on 2020-10?
      - Which payments were attempted on a checkout, per version 2020-10?
      instructions:
      - text: List all payments for checkout {token} on API 2020-10.
        slots:
          token: path.token
      - text: Get each payment attempt on checkout {token} with 2020-10.
        slots:
          token: path.token
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/checkouts/{token}/payments/count.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Count payment attempts on a checkout (API 2020-10)
      effect: read
      questions:
      - How many payment attempts has one checkout had on API 2020-10?
      - Can I get a quick payment count for a checkout with version 2020-10?
      instructions:
      - text: Count payment attempts for checkout {token} on 2020-10.
        slots:
          token: path.token
      - text: Tally the payments tried on checkout {token}, API 2020-10.
        slots:
          token: path.token
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/checkouts/{token}/payments.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List payments on a checkout (API 2021-01)
      effect: read
      questions:
      - What payment records exist for a checkout when I use release 2021-01?
      - Can 2021-01 list payment attempts for a given checkout?
      instructions:
      - text: List checkout {token} payments using version 2021-01.
        slots:
          token: path.token
      - text: Show the payment attempts on checkout {token} via 2021-01.
        slots:
          token: path.token
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/checkouts/{token}/payments/count.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Count payment attempts on a checkout (API 2021-01)
      effect: read
      questions:
      - How many payments were tried on a checkout according to 2021-01?
      - Can I count one checkout's payment attempts with release 2021-01?
      instructions:
      - text: Count checkout {token} payment attempts via 2021-01.
        slots:
          token: path.token
      - text: Get the number of payments on checkout {token}, version 2021-01.
        slots:
          token: path.token
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/checkouts/{token}/payments.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List payments on a checkout (unstable API)
      effect: read
      questions:
      - Can the unstable API list payments attempted on a checkout?
      - What payment attempts does the unstable release show for one checkout?
      instructions:
      - text: List payments for checkout {token} from the unstable API.
        slots:
          token: path.token
      - text: Show checkout {token} payment attempts on the unstable release.
        slots:
          token: path.token
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/checkouts/{token}/payments/count.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Count payment attempts on a checkout (unstable API)
      effect: read
      questions:
      - Can I count payment attempts on a checkout through the unstable API?
      - Does the unstable release offer a payment count for checkouts?
      instructions:
      - text: Count payment attempts on checkout {token} with the unstable version.
        slots:
          token: path.token
      - text: Return the payment total tried on checkout {token}, unstable API.
        slots:
          token: path.token
      method: generated
      generated: '2026-09-24'