Shopify · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Shopify Cancels API

7 actions 7 updates phrasing extends openapi/shopify-cancels-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/fulfillments/{fulfillment_id}/cancel.json'].post
$.paths['/admin/api/2020-04/fulfillments/{fulfillment_id}/cancel.json'].post
$.paths['/admin/api/2020-07/fulfillments/{fulfillment_id}/cancel.json'].post
$.paths['/admin/api/2020-10/fulfillments/{fulfillment_id}/cancel.json'].post
$.paths['/admin/api/2021-01/fulfillments/{fulfillment_id}/cancel.json'].post
$.paths['/admin/api/unstable/fulfillments/{fulfillment_id}/cancel.json'].post

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 Cancels API
  version: 1.0.0
extends: openapi/shopify-cancels-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/fulfillments/{fulfillment_id}/cancel.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a fulfillment (2020-01 API)
      effect: destructive
      questions:
      - How do I cancel a shipment I fulfilled by mistake on the 2020-01 API?
      - Can I undo a fulfillment with the 2020-01 version?
      instructions:
      - text: Cancel fulfillment {fulfillment} using the 2020-01 API.
        slots:
          fulfillment: path.fulfillment_id
      - text: Void the mistaken fulfillment {fulfillment}, version 2020-01.
        slots:
          fulfillment: path.fulfillment_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/fulfillments/{fulfillment_id}/cancel.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a fulfillment (2020-04 API)
      effect: destructive
      questions:
      - Which 2020-04 endpoint cancels a fulfillment?
      - Is cancelling a fulfillment supported in the 2020-04 release?
      instructions:
      - text: Cancel fulfillment {fulfillment} on 2020-04.
        slots:
          fulfillment: path.fulfillment_id
      - text: Call off shipment {fulfillment} via the 2020-04 release.
        slots:
          fulfillment: path.fulfillment_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/fulfillments/{fulfillment_id}/cancel.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a fulfillment (2020-07 API)
      effect: destructive
      questions:
      - Where do I cancel a fulfillment in version 2020-07?
      - What happens to a fulfillment once it's cancelled under 2020-07?
      instructions:
      - text: Cancel the fulfillment {fulfillment} through the 2020-07 version.
        slots:
          fulfillment: path.fulfillment_id
      - text: Reverse fulfillment {fulfillment} with 2020-07.
        slots:
          fulfillment: path.fulfillment_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/fulfillments/{fulfillment_id}/cancel.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a fulfillment (2020-10 API)
      effect: destructive
      questions:
      - How can I cancel a fulfillment that shouldn't have been created, using the 2020-10 API?
      - Does the 2020-10 Admin API let me cancel a fulfillment by its ID?
      instructions:
      - text: Cancel fulfillment {fulfillment} with the 2020-10 Admin API.
        slots:
          fulfillment: path.fulfillment_id
      - text: Undo the fulfillment {fulfillment}, API version 2020-10.
        slots:
          fulfillment: path.fulfillment_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/fulfillments/{fulfillment_id}/cancel.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a fulfillment (2021-01 API)
      effect: destructive
      questions:
      - Can I cancel a fulfillment using the 2021-01 release?
      - Which 2021-01 call cancels a single fulfillment?
      instructions:
      - text: Using 2021-01, cancel fulfillment {fulfillment}.
        slots:
          fulfillment: path.fulfillment_id
      - text: Revoke fulfillment {fulfillment} on the 2021-01 release.
        slots:
          fulfillment: path.fulfillment_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/fulfillments/{fulfillment_id}/cancel.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a fulfillment (unstable API)
      effect: destructive
      questions:
      - Is cancelling a fulfillment possible on the unstable API version?
      - How would I cancel a fulfillment against the unstable release?
      instructions:
      - text: Cancel fulfillment {fulfillment} on the unstable API.
        slots:
          fulfillment: path.fulfillment_id
      - text: On the unstable version, cancel shipment {fulfillment}.
        slots:
          fulfillment: path.fulfillment_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-cancels-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.