Shopify · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Shopify Admin REST Fulfillment Orders API

2 actions 2 updates phrasing extends openapi/shopify-fulfillment-orders-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 2

$.info
$.paths['/orders/{order_id}/fulfillment_orders.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 Admin REST Fulfillment Orders API
  version: 1.0.0
extends: openapi/shopify-fulfillment-orders-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: 1
- target: $.paths['/orders/{order_id}/fulfillment_orders.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List an order's fulfillment orders
      effect: read
      questions:
      - How do I see the fulfillment orders created for a customer's order?
      - Which locations will ship an order, based on its fulfillment orders?
      instructions:
      - text: List fulfillment orders for order {order_id}.
        slots:
          order_id: path.order_id
      - text: Show how order {order_id} is split across fulfillment orders.
        slots:
          order_id: path.order_id
      method: generated
      generated: '2026-09-24'