Shopify · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Shopify Admin REST Locations API

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

$.info
$.paths['/locations.json'].get
$.paths['/locations/count.json'].get
$.paths['/locations/{location_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 Admin REST Locations API
  version: 1.0.0
extends: openapi/shopify-locations-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: 3
- target: $.paths['/locations.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List a shop's locations
      effect: read
      questions:
      - What locations does my store have, like warehouses and retail stores?
      - Can I pull every location for a shop in one call?
      instructions:
      - text: List all locations for my shop.
      - text: Show me every warehouse and store location we have set up.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/locations/count.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Count a shop's locations
      effect: read
      questions:
      - How many locations does my shop have?
      - Is there a quick way to get the location total without listing them?
      instructions:
      - text: Count the locations on my shop.
      - text: Tell me the total number of store locations.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/locations/{location_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a single location
      effect: read
      questions:
      - How do I look up the details of one location by its ID in Shopify?
      - What does the store record about one specific location, such as its address?
      instructions:
      - text: Get location {location_id}.
        slots:
          location_id: path.location_id
      - text: Show the details for location {location_id}.
        slots:
          location_id: path.location_id
      method: generated
      generated: '2026-09-24'

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this
  • find_overlaysBrowse and filter every overlay in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This overlay
curl "https://apis.io/api/v1/overlays/shopify-locations-api-phrasing-overlay"
All openapi overlays
curl "https://apis.io/api/v1/overlays?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.