Shopify · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Shopify Complete API

7 actions 7 updates phrasing extends openapi/shopify-complete-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}/complete.json'].post
$.paths['/admin/api/2020-04/orders/{order_id}/fulfillments/{fulfillment_id}/complete.json'].post
$.paths['/admin/api/2020-07/orders/{order_id}/fulfillments/{fulfillment_id}/complete.json'].post
$.paths['/admin/api/2020-10/orders/{order_id}/fulfillments/{fulfillment_id}/complete.json'].post
$.paths['/admin/api/2021-01/orders/{order_id}/fulfillments/{fulfillment_id}/complete.json'].post
$.paths['/admin/api/unstable/orders/{order_id}/fulfillments/{fulfillment_id}/complete.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 Complete API
  version: 1.0.0
extends: openapi/shopify-complete-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}/complete.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Mark a fulfillment complete (2020-01)
      effect: write
      questions:
      - How do I mark an order's fulfillment as complete with the 2020-01 API?
      - Can I close out a pending fulfillment on version 2020-01?
      instructions:
      - text: Complete fulfillment {fulfillment} on order {order} using API version 2020-01.
        slots:
          fulfillment: path.fulfillment_id
          order: path.order_id
      - text: Mark fulfillment {fulfillment} of order {order} as done with the 2020-01 API.
        slots:
          fulfillment: path.fulfillment_id
          order: path.order_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/orders/{order_id}/fulfillments/{fulfillment_id}/complete.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Mark a fulfillment complete (2020-04)
      effect: write
      questions:
      - Which 2020-04 call sets a fulfillment's status to complete?
      - Is completing a shipment for an order supported on 2020-04?
      instructions:
      - text: Set fulfillment {fulfillment} for order {order} to complete through the 2020-04 API.
        slots:
          fulfillment: path.fulfillment_id
          order: path.order_id
      - text: Finish off fulfillment {fulfillment} on order {order} with version 2020-04.
        slots:
          fulfillment: path.fulfillment_id
          order: path.order_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/orders/{order_id}/fulfillments/{fulfillment_id}/complete.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Mark a fulfillment complete (2020-07)
      effect: write
      questions:
      - What 2020-07 endpoint completes a fulfillment on an order?
      - Can I flag an order's shipment as fulfilled using version 2020-07?
      instructions:
      - text: Mark order {order} fulfillment {fulfillment} complete via the 2020-07 Admin API.
        slots:
          fulfillment: path.fulfillment_id
          order: path.order_id
      - text: Close fulfillment {fulfillment} for order {order} using 2020-07.
        slots:
          fulfillment: path.fulfillment_id
          order: path.order_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/orders/{order_id}/fulfillments/{fulfillment_id}/complete.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Mark a fulfillment complete (2020-10)
      effect: write
      questions:
      - How can I complete a fulfillment for a Shopify order on 2020-10?
      - Which 2020-10 call marks a shipment on an order as finished?
      instructions:
      - text: Complete fulfillment {fulfillment} of order {order} on 2020-10.
        slots:
          fulfillment: path.fulfillment_id
          order: path.order_id
      - text: Mark the shipment {fulfillment} on order {order} as complete via version 2020-10.
        slots:
          fulfillment: path.fulfillment_id
          order: path.order_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/orders/{order_id}/fulfillments/{fulfillment_id}/complete.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Mark a fulfillment complete (2021-01)
      effect: write
      questions:
      - Is there a 2021-01 call to mark a fulfillment complete?
      - Can the 2021-01 API wrap up an in-progress fulfillment on an order?
      instructions:
      - text: Wrap up fulfillment {fulfillment} on order {order} with the 2021-01 release.
        slots:
          fulfillment: path.fulfillment_id
          order: path.order_id
      - text: Set order {order} fulfillment {fulfillment} to complete using 2021-01.
        slots:
          fulfillment: path.fulfillment_id
          order: path.order_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/orders/{order_id}/fulfillments/{fulfillment_id}/complete.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Mark a fulfillment complete (unstable)
      effect: write
      questions:
      - Does the unstable API let me mark a fulfillment as complete?
      - What's the unstable-version call for completing an order shipment?
      instructions:
      - text: Complete fulfillment {fulfillment} on order {order} using the unstable version.
        slots:
          fulfillment: path.fulfillment_id
          order: path.order_id
      - text: Mark fulfillment {fulfillment} for order {order} finished through the unstable Admin API.
        slots:
          fulfillment: path.fulfillment_id
          order: path.order_id
      method: generated
      generated: '2026-09-24'