Shopify · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Shopify Dispute API

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

$.info
$.paths['/admin/api/2020-01/shopify_payments/disputes/{dispute_id}.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 Dispute API
  version: 1.0.0
extends: openapi/shopify-dispute-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: 1
- target: $.paths['/admin/api/2020-01/shopify_payments/disputes/{dispute_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Shopify Payments dispute
      effect: read
      questions:
      - How do I look up a chargeback dispute from Shopify Payments by its ID?
      - Can I check the details of one payment dispute a customer opened?
      - Where do I see a single dispute's record using the 2020-01 API?
      instructions:
      - text: Get dispute {dispute}.
        slots:
          dispute: path.dispute_id
      - text: Show me the details of Shopify Payments dispute {dispute}.
        slots:
          dispute: path.dispute_id
      method: generated
      generated: '2026-09-24'