Shopify · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Shopify Available API

7 actions 7 updates phrasing extends openapi/shopify-available-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/{token}/shipping_rates.json'].get
$.paths['/admin/api/2020-04/checkouts/{token}/shipping_rates.json'].get
$.paths['/admin/api/2020-07/checkouts/{token}/shipping_rates.json'].get
$.paths['/admin/api/2020-10/checkouts/{token}/shipping_rates.json'].get
$.paths['/admin/api/2021-01/checkouts/{token}/shipping_rates.json'].get
$.paths['/admin/api/unstable/checkouts/{token}/shipping_rates.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 Available API
  version: 1.0.0
extends: openapi/shopify-available-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/{token}/shipping_rates.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List shipping rates for a checkout (API 2020-01)
      effect: read
      questions:
      - How do I see which shipping rates are available for a checkout on the 2020-01 API?
      - Can I fetch delivery options for a buyer's checkout with API version 2020-01?
      instructions:
      - text: List available shipping rates for checkout {token} via the 2020-01 API.
        slots:
          token: path.token
      - text: Using version 2020-01, show delivery options offered on checkout {token}.
        slots:
          token: path.token
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/checkouts/{token}/shipping_rates.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List shipping rates for a checkout (API 2020-04)
      effect: read
      questions:
      - Which April 2020 (2020-04) endpoint returns the shipping rates for a checkout?
      - Are shipping rate lookups for a checkout token supported in the 2020-04 release?
      instructions:
      - text: On the 2020-04 release, get shipping rates for checkout {token}.
        slots:
          token: path.token
      - text: Fetch what shipping costs checkout {token} can choose from with the April 2020 endpoint.
        slots:
          token: path.token
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/checkouts/{token}/shipping_rates.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List shipping rates for a checkout (API 2020-07)
      effect: read
      questions:
      - My sales channel targets 2020-07; what lists shipping rates for a checkout there?
      - Can the July 2020 API tell me the shipping methods a checkout qualifies for?
      instructions:
      - text: Show the shipping methods checkout {token} qualifies for using July 2020 (2020-07).
        slots:
          token: path.token
      - text: With API 2020-07, retrieve rates available to checkout {token}.
        slots:
          token: path.token
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/checkouts/{token}/shipping_rates.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List shipping rates for a checkout (API 2020-10)
      effect: read
      questions:
      - What is the 2020-10 call for getting available shipping rates on a checkout?
      - Does the October 2020 API return shipping prices for a specific checkout?
      instructions:
      - text: Return shipping prices for checkout {token} on the October 2020 version.
        slots:
          token: path.token
      - text: List the 2020-10 shipping rate options for checkout {token}.
        slots:
          token: path.token
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/checkouts/{token}/shipping_rates.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List shipping rates for a checkout (API 2021-01)
      effect: read
      questions:
      - Under the 2021-01 API, where do I look up shipping rates for a checkout?
      - Can I quote shipping for a checkout with the January 2021 API version?
      instructions:
      - text: Quote shipping for checkout {token} through API version 2021-01.
        slots:
          token: path.token
      - text: Look up available rates on checkout {token} against January 2021.
        slots:
          token: path.token
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/checkouts/{token}/shipping_rates.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List shipping rates for a checkout (unstable API)
      effect: read
      questions:
      - Is there an unstable-channel endpoint for a checkout's shipping rates?
      - Can I test shipping rate retrieval against the unstable API version?
      instructions:
      - text: Get shipping rates for checkout {token} on the unstable API.
        slots:
          token: path.token
      - text: Against the unstable version, test listing checkout {token} delivery rates.
        slots:
          token: path.token
      method: generated
      generated: '2026-09-24'