Shopify · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Shopify Admin REST Fulfillments API

4 actions 4 updates phrasing extends openapi/shopify-fulfillments-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['/fulfillments.json'].post

$.paths['/fulfillments/{fulfillment_id}/update_tracking.json'].post

$.paths['/fulfillments/{fulfillment_id}/cancel.json'].post

OpenAPI Overlay

# 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 Fulfillments API
  version: 1.0.0
extends: openapi/shopify-fulfillments-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['/fulfillments.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Fulfill one or more fulfillment orders
      effect: write
      questions:
      - How do I mark items as fulfilled across several fulfillment orders at once?
      - Can one fulfillment cover more than one fulfillment order in Shopify?
      - What do I send to create a new fulfillment for an order's line items?
      instructions:
      - text: 'Create a fulfillment with these details: {fulfillment}.'
        slots:
          fulfillment: requestBody.fulfillment
      - text: Fulfill the fulfillment orders described in {fulfillment}.
        slots:
          fulfillment: requestBody.fulfillment
      method: generated
      generated: '2026-09-24'
- target: $.paths['/fulfillments/{fulfillment_id}/update_tracking.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a fulfillment's tracking info
      effect: write
      questions:
      - How can I change the tracking number on a shipment that's already fulfilled?
      - Can I correct the carrier tracking details for an existing fulfillment?
      instructions:
      - text: Update tracking on fulfillment {fulfillment_id} to {fulfillment}.
        slots:
          fulfillment_id: path.fulfillment_id
          fulfillment: requestBody.fulfillment
      - text: Replace the tracking information for fulfillment {fulfillment_id}.
        slots:
          fulfillment_id: path.fulfillment_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/fulfillments/{fulfillment_id}/cancel.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Cancel a fulfillment
      effect: destructive
      questions:
      - How do I cancel a fulfillment that was created by mistake?
      - Can I cancel a fulfillment after it has already been created?
      instructions:
      - text: Cancel fulfillment {fulfillment_id}.
        slots:
          fulfillment_id: path.fulfillment_id
      - text: Undo fulfillment {fulfillment_id} by cancelling it.
        slots:
          fulfillment_id: path.fulfillment_id
      method: generated
      generated: '2026-09-24'