Shopify · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Shopify Admin REST Shop API

2 actions 2 updates phrasing extends openapi/shopify-shop-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['/shop.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 Admin REST Shop API
  version: 1.0.0
extends: openapi/shopify-shop-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['/shop.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the store's settings and details
      effect: read
      questions:
      - What currency and timezone is my store set to?
      - Which plan is the shop on, and what domain does it use?
      - Can I fetch only a few store settings instead of the whole configuration?
      instructions:
      - text: Show my store's configuration.
      - text: Get only the store fields {fields}.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-24'