Shopify · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Shopify Cancel API

7 actions 7 updates phrasing extends openapi/shopify-cancel-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/orders/{order_id}/fulfillments/{fulfillment_id}/cancel.json'].post
$.paths['/admin/api/2020-04/orders/{order_id}/fulfillments/{fulfillment_id}/cancel.json'].post
$.paths['/admin/api/2020-07/orders/{order_id}/fulfillments/{fulfillment_id}/cancel.json'].post
$.paths['/admin/api/2020-10/orders/{order_id}/fulfillments/{fulfillment_id}/cancel.json'].post
$.paths['/admin/api/2021-01/orders/{order_id}/fulfillments/{fulfillment_id}/cancel.json'].post
$.paths['/admin/api/unstable/orders/{order_id}/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 Cancel API
  version: 1.0.0
extends: openapi/shopify-cancel-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/orders/{order_id}/fulfillments/{fulfillment_id}/cancel.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel an order fulfillment (API 2020-01)
      effect: destructive
      questions:
      - How do I cancel a fulfillment on an order using the 2020-01 Admin API?
      - Can a shipment I already marked fulfilled be cancelled under API version 2020-01?
      instructions:
      - text: Cancel fulfillment {fulfillment_id} on order {order_id} via the 2020-01 API.
        slots:
          fulfillment_id: path.fulfillment_id
          order_id: path.order_id
      - text: Using version 2020-01, call off the fulfillment {fulfillment_id} for order {order_id}.
        slots:
          fulfillment_id: path.fulfillment_id
          order_id: path.order_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/orders/{order_id}/fulfillments/{fulfillment_id}/cancel.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel an order fulfillment (API 2020-04)
      effect: destructive
      questions:
      - Which April 2020 (2020-04) endpoint cancels a fulfillment that belongs to an order?
      - Is undoing a fulfillment supported in the 2020-04 release of the Admin API?
      instructions:
      - text: On the 2020-04 release, cancel the fulfillment {fulfillment_id} of order {order_id}.
        slots:
          fulfillment_id: path.fulfillment_id
          order_id: path.order_id
      - text: Undo fulfillment {fulfillment_id} for order {order_id} with the April 2020 endpoint.
        slots:
          fulfillment_id: path.fulfillment_id
          order_id: path.order_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/orders/{order_id}/fulfillments/{fulfillment_id}/cancel.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel an order fulfillment (API 2020-07)
      effect: destructive
      questions:
      - My app is pinned to 2020-07; what cancels a fulfillment there?
      - Can the July 2020 Admin API reverse a fulfillment I created by mistake?
      instructions:
      - text: Reverse the mistaken fulfillment {fulfillment_id} on order {order_id} using July 2020 (2020-07).
        slots:
          fulfillment_id: path.fulfillment_id
          order_id: path.order_id
      - text: With API 2020-07, cancel order {order_id}'s fulfillment {fulfillment_id}.
        slots:
          fulfillment_id: path.fulfillment_id
          order_id: path.order_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/orders/{order_id}/fulfillments/{fulfillment_id}/cancel.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel an order fulfillment (API 2020-10)
      effect: destructive
      questions:
      - What is the 2020-10 way to cancel a fulfillment on one of my orders?
      - Does the October 2020 Admin API let me take back a fulfillment on an order?
      instructions:
      - text: Take back fulfillment {fulfillment_id} from order {order_id} on the October 2020 version.
        slots:
          fulfillment_id: path.fulfillment_id
          order_id: path.order_id
      - text: Cancel the 2020-10 fulfillment {fulfillment_id} attached to order {order_id}.
        slots:
          fulfillment_id: path.fulfillment_id
          order_id: path.order_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/orders/{order_id}/fulfillments/{fulfillment_id}/cancel.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel an order fulfillment (API 2021-01)
      effect: destructive
      questions:
      - Under the 2021-01 Admin API, where do I cancel an order's fulfillment?
      - Can I stop a fulfillment on an order with the January 2021 API version?
      instructions:
      - text: Stop fulfillment {fulfillment_id} on order {order_id} through API version 2021-01.
        slots:
          fulfillment_id: path.fulfillment_id
          order_id: path.order_id
      - text: For order {order_id}, cancel fulfillment {fulfillment_id} against January 2021.
        slots:
          fulfillment_id: path.fulfillment_id
          order_id: path.order_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/orders/{order_id}/fulfillments/{fulfillment_id}/cancel.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel an order fulfillment (unstable API)
      effect: destructive
      questions:
      - Is there an unstable-channel endpoint for cancelling a fulfillment on an order?
      - Can I test fulfillment cancellation against the unstable Admin API version?
      instructions:
      - text: Cancel fulfillment {fulfillment_id} of order {order_id} on the unstable API.
        slots:
          fulfillment_id: path.fulfillment_id
          order_id: path.order_id
      - text: Against the unstable version, test cancelling order {order_id} fulfillment {fulfillment_id}.
        slots:
          fulfillment_id: path.fulfillment_id
          order_id: path.order_id
      method: generated
      generated: '2026-09-24'