Shopify · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Shopify Collect API

7 actions 7 updates phrasing extends openapi/shopify-collect-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/collects/{collect_id}.json'].get
$.paths['/admin/api/2020-04/collects/{collect_id}.json'].get
$.paths['/admin/api/2020-07/collects/{collect_id}.json'].get
$.paths['/admin/api/2020-10/collects/{collect_id}.json'].get
$.paths['/admin/api/2021-01/collects/{collect_id}.json'].get
$.paths['/admin/api/unstable/collects/{collect_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 Collect API
  version: 1.0.0
extends: openapi/shopify-collect-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/collects/{collect_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a product-to-collection link (API 2020-01)
      effect: read
      questions:
      - How do I look up one collect, the link between a product and a custom collection, on API 2020-01?
      - Can a January 2020 collect lookup return only chosen fields?
      instructions:
      - text: Get collect {collect_id} via Admin API 2020-01.
        slots:
          collect_id: path.collect_id
      - text: Show {fields} of collect {collect_id}, January 2020 release.
        slots:
          fields: query.fields
          collect_id: path.collect_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/collects/{collect_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a product-to-collection link (API 2020-04)
      effect: read
      questions:
      - Which April 2020 call tells me which product and collection a collect ties together?
      - Is there a fields option on the 2020-04 single collect endpoint?
      instructions:
      - text: Retrieve collect {collect_id} using 2020-04.
        slots:
          collect_id: path.collect_id
      - text: 'April 2020 API: return only {fields} for collect {collect_id}.'
        slots:
          fields: query.fields
          collect_id: path.collect_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/collects/{collect_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a product-to-collection link (API 2020-07)
      effect: read
      questions:
      - Where do I fetch a specific collect by ID on the July 2020 Admin API?
      - Can I trim a 2020-07 collect response to particular fields?
      instructions:
      - text: Fetch collect {collect_id} with version 2020-07.
        slots:
          collect_id: path.collect_id
      - text: Using July 2020, give me the {fields} of collect {collect_id}.
        slots:
          fields: query.fields
          collect_id: path.collect_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/collects/{collect_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a product-to-collection link (API 2020-10)
      effect: read
      questions:
      - What's the current 2020-10 way to read a single collect?
      - Does the October 2020 collect lookup accept a fields list?
      instructions:
      - text: Get collect {collect_id} on API 2020-10.
        slots:
          collect_id: path.collect_id
      - text: 'October 2020 release: show fields {fields} of collect {collect_id}.'
        slots:
          fields: query.fields
          collect_id: path.collect_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/collects/{collect_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a product-to-collection link (API 2021-01)
      effect: read
      questions:
      - How can I see which collection a product sits in via one collect on 2021-01?
      - Will the January 2021 collect endpoint return a subset of fields?
      instructions:
      - text: Look up collect {collect_id} from 2021-01.
        slots:
          collect_id: path.collect_id
      - text: 'January 2021 API: read {fields} for collect {collect_id}.'
        slots:
          fields: query.fields
          collect_id: path.collect_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/collects/{collect_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a product-to-collection link (unstable API)
      effect: read
      questions:
      - Can I retrieve a single collect through the unstable Admin API?
      - Does the unstable collect lookup support restricting fields?
      instructions:
      - text: Get collect {collect_id} on the unstable channel.
        slots:
          collect_id: path.collect_id
      - text: Via unstable, fetch only {fields} of collect {collect_id}.
        slots:
          fields: query.fields
          collect_id: path.collect_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-collect-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.

GitHub Google LinkedIn

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