Shopify · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Shopify Fulfillment API

96 actions 96 updates phrasing extends openapi/shopify-fulfillment-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 96 · first 16 shown; the file carries all of them

$.info
$.paths['/admin/api/2020-01/fulfillment_orders/{fulfillment_order_id}/cancellation_request.json'].post
$.paths['/admin/api/2020-01/fulfillment_orders/{fulfillment_order_id}/cancellation_request/accept.json'].post
$.paths['/admin/api/2020-01/fulfillment_orders/{fulfillment_order_id}/cancellation_request/reject.json'].post
$.paths['/admin/api/2020-04/fulfillment_orders/{fulfillment_order_id}/cancellation_request.json'].post
$.paths['/admin/api/2020-04/fulfillment_orders/{fulfillment_order_id}/cancellation_request/accept.json'].post
$.paths['/admin/api/2020-04/fulfillment_orders/{fulfillment_order_id}/cancellation_request/reject.json'].post
$.paths['/admin/api/2020-07/fulfillment_orders/{fulfillment_order_id}/cancellation_request.json'].post
$.paths['/admin/api/2020-07/fulfillment_orders/{fulfillment_order_id}/cancellation_request/accept.json'].post
$.paths['/admin/api/2020-07/fulfillment_orders/{fulfillment_order_id}/cancellation_request/reject.json'].post
$.paths['/admin/api/2020-10/fulfillment_orders/{fulfillment_order_id}/cancellation_request.json'].post
$.paths['/admin/api/2020-10/fulfillment_orders/{fulfillment_order_id}/cancellation_request/accept.json'].post
$.paths['/admin/api/2020-10/fulfillment_orders/{fulfillment_order_id}/cancellation_request/reject.json'].post
$.paths['/admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}/cancellation_request.json'].post
$.paths['/admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}/cancellation_request/accept.json'].post
$.paths['/admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}/cancellation_request/reject.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 Fulfillment API
  version: 1.0.0
extends: openapi/shopify-fulfillment-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: 95
- target: $.paths['/admin/api/2020-01/fulfillment_orders/{fulfillment_order_id}/cancellation_request.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Request cancellation of a fulfillment order (2020-01)
      effect: write
      questions:
      - Using the 2020-01 API, how do I ask a fulfillment service to cancel an order it holds?
      - Can a cancellation request sent through the January 2020 API include a reason?
      instructions:
      - text: Send a cancellation request for fulfillment order {fulfillment_order} using 2020-01.
        slots:
          fulfillment_order: path.fulfillment_order_id
      - text: On the January 2020 API, ask the fulfillment service to cancel {fulfillment_order} because {message}.
        slots:
          fulfillment_order: path.fulfillment_order_id
          message: query.message
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/fulfillment_orders/{fulfillment_order_id}/cancellation_request/accept.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Accept a cancellation request (2020-01)
      effect: destructive
      questions:
      - As a fulfillment service on 2020-01, how do I agree to a merchant's cancellation request?
      - Can I leave a note when accepting a cancellation in the January 2020 API?
      instructions:
      - text: Accept the pending cancellation request on fulfillment order {fulfillment_order} using 2020-01.
        slots:
          fulfillment_order: path.fulfillment_order_id
      - text: On January 2020, approve the merchant's request to cancel {fulfillment_order}, noting {message}.
        slots:
          fulfillment_order: path.fulfillment_order_id
          message: query.message
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/fulfillment_orders/{fulfillment_order_id}/cancellation_request/reject.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Reject a cancellation request (2020-01)
      effect: write
      questions:
      - How does a fulfillment service decline a cancellation request on 2020-01?
      - Can I give the merchant a reason for refusing to cancel in the January 2020 API?
      instructions:
      - text: Reject the cancellation request on fulfillment order {fulfillment_order} with 2020-01.
        slots:
          fulfillment_order: path.fulfillment_order_id
      - text: Via January 2020, refuse to cancel {fulfillment_order} and explain {message}.
        slots:
          fulfillment_order: path.fulfillment_order_id
          message: query.message
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/fulfillment_orders/{fulfillment_order_id}/cancellation_request.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Request cancellation of a fulfillment order (2020-04)
      effect: write
      questions:
      - In the 2020-04 Admin API, what call asks a fulfillment service to stop work on a fulfillment order?
      - Is a message optional when requesting cancellation under the April 2020 version?
      instructions:
      - text: Request cancellation of fulfillment order {fulfillment_order} from its service with the 2020-04 endpoint.
        slots:
          fulfillment_order: path.fulfillment_order_id
      - text: 'Using April 2020, tell the fulfillment service we want {fulfillment_order} cancelled: {message}.'
        slots:
          fulfillment_order: path.fulfillment_order_id
          message: query.message
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/fulfillment_orders/{fulfillment_order_id}/cancellation_request/accept.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Accept a cancellation request (2020-04)
      effect: destructive
      questions:
      - Which April 2020 call lets my fulfillment service accept a cancellation request?
      - Under 2020-04, is a reason optional when I approve a merchant's cancellation?
      instructions:
      - text: Approve the cancellation request for {fulfillment_order} via the 2020-04 endpoint.
        slots:
          fulfillment_order: path.fulfillment_order_id
      - text: Agree to cancel fulfillment order {fulfillment_order} in API April 2020 and tell the merchant {message}.
        slots:
          fulfillment_order: path.fulfillment_order_id
          message: query.message
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/fulfillment_orders/{fulfillment_order_id}/cancellation_request/reject.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Reject a cancellation request (2020-04)
      effect: write
      questions:
      - Which 2020-04 endpoint lets my service turn down a merchant's cancellation request?
      - Under April 2020, is there a field for why a cancellation was rejected?
      instructions:
      - text: Decline the cancellation request for {fulfillment_order} using the 2020-04 API.
        slots:
          fulfillment_order: path.fulfillment_order_id
      - text: On April 2020, reject cancelling fulfillment order {fulfillment_order}, telling the merchant {message}.
        slots:
          fulfillment_order: path.fulfillment_order_id
          message: query.message
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/fulfillment_orders/{fulfillment_order_id}/cancellation_request.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Request cancellation of a fulfillment order (2020-07)
      effect: write
      questions:
      - Which 2020-07 endpoint sends a fulfillment service a request to cancel?
      - Can I explain why I'm cancelling when I send the July 2020 cancellation request?
      instructions:
      - text: File a 2020-07 cancellation request against fulfillment order {fulfillment_order}.
        slots:
          fulfillment_order: path.fulfillment_order_id
      - text: Through the July 2020 version, request that {fulfillment_order} be cancelled, with the note {message}.
        slots:
          fulfillment_order: path.fulfillment_order_id
          message: query.message
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/fulfillment_orders/{fulfillment_order_id}/cancellation_request/accept.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Accept a cancellation request (2020-07)
      effect: destructive
      questions:
      - What does a fulfillment service call to confirm a cancellation request in the 2020-07 version?
      - In July 2020, can my service explain its acceptance of a cancellation?
      instructions:
      - text: Confirm the 2020-07 cancellation request on fulfillment order {fulfillment_order}.
        slots:
          fulfillment_order: path.fulfillment_order_id
      - text: Using July 2020, accept cancelling {fulfillment_order} with the message {message}.
        slots:
          fulfillment_order: path.fulfillment_order_id
          message: query.message
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/fulfillment_orders/{fulfillment_order_id}/cancellation_request/reject.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Reject a cancellation request (2020-07)
      effect: write
      questions:
      - What lets a fulfillment service say no to cancelling a fulfillment order in 2020-07?
      - In July 2020, can a rejected cancellation include a message?
      instructions:
      - text: Turn down the 2020-07 cancellation request on fulfillment order {fulfillment_order}.
        slots:
          fulfillment_order: path.fulfillment_order_id
      - text: Using July 2020, decline to cancel {fulfillment_order} and reply {message}.
        slots:
          fulfillment_order: path.fulfillment_order_id
          message: query.message
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/fulfillment_orders/{fulfillment_order_id}/cancellation_request.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Request cancellation of a fulfillment order
      effect: write
      questions:
      - My app needs the warehouse service to stop fulfilling an order; what do I call on 2020-10?
      - Where do I send a cancellation request to a fulfillment service in the October 2020 API?
      instructions:
      - text: Ask the fulfillment service to cancel fulfillment order {fulfillment_order} (API 2020-10).
        slots:
          fulfillment_order: path.fulfillment_order_id
      - text: Send an October 2020 cancellation request for {fulfillment_order} with the reason {message}.
        slots:
          fulfillment_order: path.fulfillment_order_id
          message: query.message
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/fulfillment_orders/{fulfillment_order_id}/cancellation_request/accept.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Accept a cancellation request
      effect: destructive
      questions:
      - My fulfillment service got a cancellation request; how do I accept it on 2020-10?
      - What endpoint in the October 2020 API approves a merchant's request to cancel?
      instructions:
      - text: Accept the merchant's cancellation request for fulfillment order {fulfillment_order} (2020-10).
        slots:
          fulfillment_order: path.fulfillment_order_id
      - text: With October 2020, agree to the cancellation of {fulfillment_order} and reply {message}.
        slots:
          fulfillment_order: path.fulfillment_order_id
          message: query.message
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/fulfillment_orders/{fulfillment_order_id}/cancellation_request/reject.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Reject a cancellation request
      effect: write
      questions:
      - How do I refuse a cancellation request as a fulfillment service on 2020-10?
      - Where in the October 2020 API does a service reject a merchant's request to cancel?
      instructions:
      - text: Reject the merchant's cancellation request for fulfillment order {fulfillment_order} (2020-10).
        slots:
          fulfillment_order: path.fulfillment_order_id
      - text: 'With October 2020, refuse cancellation of {fulfillment_order}; reason: {message}.'
        slots:
          fulfillment_order: path.fulfillment_order_id
          message: query.message
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}/cancellation_request.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Request cancellation of a fulfillment order (2021-01)
      effect: write
      questions:
      - With API version 2021-01, can I request that a fulfillment service cancel a fulfillment order?
      - Does the January 2021 cancellation request accept a free-text reason?
      instructions:
      - text: Submit a cancellation request to the service fulfilling {fulfillment_order} on 2021-01.
        slots:
          fulfillment_order: path.fulfillment_order_id
      - text: Via January 2021, request cancellation for fulfillment order {fulfillment_order} and say {message}.
        slots:
          fulfillment_order: path.fulfillment_order_id
          message: query.message
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}/cancellation_request/accept.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Accept a cancellation request (2021-01)
      effect: destructive
      questions:
      - On API 2021-01, how does a fulfillment service say yes to a cancellation request?
      - Can a January 2021 cancellation acceptance carry a message back to the merchant?
      instructions:
      - text: Say yes to the cancellation request on {fulfillment_order} using version 2021-01.
        slots:
          fulfillment_order: path.fulfillment_order_id
      - text: 'Accept, via January 2021, the request to cancel fulfillment order {fulfillment_order}; message: {message}.'
        slots:
          fulfillment_order: path.fulfillment_order_id
          message: query.message
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}/cancellation_request/reject.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Reject a cancellation request (2021-01)
      effect: write
      questions:
      - On version 2021-01, how does my fulfillment service reject a cancellation request?
      - Does the January 2021 rejection of a cancellation let me explain why?
      instructions:
      - text: Say no to the cancellation request on {fulfillment_order} using 2021-01.
        slots:
          fulfillment_order: path.fulfillment_order_id
      - text: Via January 2021, decline cancelling fulfillment order {fulfillment_order} with the note {message}.
        slots:
          fulfillment_order: path.fulfillment_order_id
          message: query.message
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/fulfillment_orders/{fulfillment_order_id}/cancellation_request.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Request cancellation of a fulfillment order (unstable)
      effect: write
      questions:
      - On the unstable API, which call sends a fulfillment service a cancellation request?
      - Can I include a message with a cancellation request on the unstable version?
      instructions:
      - text: Send an unstable-version cancellation request for fulfillment order {fulfillment_order}.
        slots:
          fulfillment_order: path.fulfillment_order_id
      - text: 'Using the unstable endpoint, ask the fulfillment service to cancel {fulfillment_order}; reason: {message}.'
        slots:
          fulfillment_order: path.fulfillment_order_id
          message: query.message
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/fulfillment_orders/{fulfillment_order_id}/cancellation_request/accept.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Accept a cancellation request (unstable)
      effect: destructive
      questions:
      - As a fulfillment service on the unstable API, can I accept a merchant's cancellation request?
      - Does the unstable version let me add a note when approving a cancellation?
      instructions:
      - text: Accept the cancellation request for fulfillment order {fulfillment_order} on the unstable version.
        slots:
          fulfillment_order: path.fulfillment_order_id
      - text: Using unstable, approve cancelling {fulfillment_order} and send {message}.
        slots:
          fulfillment_order: path.fulfillment_order_id
          message: query.message
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/fulfillment_orders/{fulfillment_order_id}/cancellation_request/reject.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Reject a cancellation request (unstable)
      effect: write
      questions:
      - On the unstable API, what's the call to reject a cancellation request?
      - Can the unstable version's cancellation rejection carry a reason for the merchant?
      instructions:
      - text: Reject the cancellation request for fulfillment order {fulfillment_order} on unstable.
        slots:
          fulfillment_order: path.fulfillment_order_id
      - text: Using the unstable endpoint, refuse to cancel {fulfillment_order} and say {message}.
        slots:
          fulfillment_order: path.fulfillment_order_id
          message: query.message
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/orders/{order_id}/fulfillments/{fulfillment_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a fulfillment on an order (2020-01)
      effect: read
      questions:
      - How do I look up one fulfillment on an order using API 2020-01?
      - Can I limit which fields come back when fetching a fulfillment in January 2020?
      instructions:
      - text: Get fulfillment {fulfillment} on order {order} from the 2020-01 API.
        slots:
          fulfillment: path.fulfillment_id
          order: path.order_id
      - text: Using January 2020, show only {fields} for fulfillment {fulfillment} of order {order}.
        slots:
          fields: query.fields
          fulfillment: path.fulfillment_id
          order: path.order_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/fulfillments.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Fulfill one or many fulfillment orders (2020-01)
      effect: write
      questions:
      - How do I create a fulfillment covering one or more fulfillment orders in 2020-01?
      - Can a single January 2020 fulfillment span several fulfillment orders?
      instructions:
      - text: Create a fulfillment for my fulfillment orders using the 2020-01 API.
      - text: On January 2020, fulfill several fulfillment orders in one fulfillment.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/fulfillments/{fulfillment_id}/update_tracking.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a fulfillment's tracking (2020-01)
      effect: write
      questions:
      - How do I change the tracking info on a fulfillment using 2020-01?
      - Can I update shipment tracking after a fulfillment is created, in January 2020?
      instructions:
      - text: Update the tracking information for fulfillment {fulfillment} via 2020-01.
        slots:
          fulfillment: path.fulfillment_id
      - text: On January 2020, correct tracking details on fulfillment {fulfillment}.
        slots:
          fulfillment: path.fulfillment_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/orders/{order_id}/fulfillments/{fulfillment_id}/open.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Mark a fulfillment as open (2020-01)
      effect: write
      questions:
      - How do I mark a fulfillment as open on an order using 2020-01?
      - Can I set a fulfillment's status to open in the January 2020 API?
      instructions:
      - text: Mark fulfillment {fulfillment} on order {order} as open via 2020-01.
        slots:
          fulfillment: path.fulfillment_id
          order: path.order_id
      - text: On January 2020, open fulfillment {fulfillment} for order {order}.
        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}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a fulfillment on an order (2020-04)
      effect: read
      questions:
      - Which 2020-04 call returns the details of a specific fulfillment?
      - In April 2020, can I fetch just certain fields of an order's fulfillment?
      instructions:
      - text: Retrieve fulfillment {fulfillment} for order {order} via 2020-04.
        slots:
          fulfillment: path.fulfillment_id
          order: path.order_id
      - text: On April 2020, fetch fields {fields} of fulfillment {fulfillment} on order {order}.
        slots:
          fields: query.fields
          fulfillment: path.fulfillment_id
          order: path.order_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/fulfillments.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Fulfill one or many fulfillment orders (2020-04)
      effect: write
      questions:
      - Which 2020-04 endpoint fulfills items across multiple fulfillment orders at once?
      - In April 2020, can one fulfillment cover more than one fulfillment order?
      instructions:
      - text: Make a fulfillment from fulfillment orders via 2020-04.
      - text: Using April 2020, create one fulfillment that spans multiple fulfillment orders.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/fulfillments/{fulfillment_id}/update_tracking.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a fulfillment's tracking (2020-04)
      effect: write
      questions:
      - Which 2020-04 endpoint updates a fulfillment's tracking info?
      - In April 2020, can I fix the carrier tracking on an existing fulfillment?
      instructions:
      - text: Change tracking info on fulfillment {fulfillment} using 2020-04.
        slots:
          fulfillment: path.fulfillment_id
      - text: Using April 2020, refresh the tracking for fulfillment {fulfillment}.
        slots:
          fulfillment: path.fulfillment_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/orders/{order_id}/fulfillments/{fulfillment_id}/open.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Mark a fulfillment as open (2020-04)
      effect: write
      questions:
      - Which 2020-04 call sets a fulfillment to open?
      - In April 2020, is there a way to flag an order's fulfillment as open?
      instructions:
      - text: Set fulfillment {fulfillment} of order {order} to open using 2020-04.
        slots:
          fulfillment: path.fulfillment_id
          order: path.order_id
      - text: Using April 2020, flag order {order}'s fulfillment {fulfillment} as open.
        slots:
          order: path.order_id
          fulfillment: path.fulfillment_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/orders/{order_id}/fulfillments/{fulfillment_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a fulfillment on an order (2020-07)
      effect: read
      questions:
      - What does the 2020-07 API return for a single fulfillment on an order?
      - Is there a fields filter when I retrieve one fulfillment in July 2020?
      instructions:
      - text: Show me fulfillment {fulfillment} from order {order} using 2020-07.
        slots:
          fulfillment: path.fulfillment_id
          order: path.order_id
      - text: Via July 2020, return {fields} for order {order}'s fulfillment {fulfillment}.
        slots:
          fields: query.fields
          order: path.order_id
          fulfillment: path.fulfillment_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/fulfillments.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Fulfill one or many fulfillment orders (2020-07)
      effect: write
      questions:
      - What 2020-07 call marks fulfillment orders fulfilled by creating a new fulfillment?
      - Is it possible in July 2020 to fulfill many fulfillment orders together?
      instructions:
      - text: Record a new fulfillment against fulfillment orders with 2020-07.
      - text: Via July 2020, bundle multiple fulfillment orders into a single fulfillment.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/fulfillments/{fulfillment_id}/update_tracking.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a fulfillment's tracking (2020-07)
      effect: write
      questions:
      - What does the 2020-07 API offer for editing tracking on a fulfillment?
      - Is tracking editable on a fulfillment through July 2020?
      instructions:
      - text: Edit fulfillment {fulfillment}'s tracking with the 2020-07 endpoint.
        slots:
          fulfillment: path.fulfillment_id
      - text: Via July 2020, set new tracking information on fulfillment {fulfillment}.
        slots:
          fulfillment: path.fulfillment_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/orders/{order_id}/fulfillments/{fulfillment_id}/open.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Mark a fulfillment as open (2020-07)
      effect: write
      questions:
      - What 2020-07 endpoint marks an order's fulfillment open?
      - Is there a July 2020 endpoint to put a fulfillment in the open state?
      instructions:
      - text: Open fulfillment {fulfillment} on order {order} with 2020-07.
        slots:
          fulfillment: path.fulfillment_id
          order: path.order_id
      - text: Via July 2020, move fulfillment {fulfillment} of order {order} to open.
        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}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a fulfillment on an order
      effect: read
      questions:
      - Where can I check one shipment (fulfillment) on an order with the 2020-10 API?
      - Can I trim the response to a few fields when reading a fulfillment in October 2020?
      instructions:
      - text: Look up fulfillment {fulfillment} on order {order} (API 2020-10).
        slots:
          fulfillment: path.fulfillment_id
          order: path.order_id
      - text: With October 2020, pull only {fields} from fulfillment {fulfillment} of order {order}.
        slots:
          fields: query.fields
          fulfillment: path.fulfillment_id
          order: path.order_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/fulfillments.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Fulfill one or many fulfillment orders
      effect: write
      questions:
      - What's the October 2020 way to create a fulfillment for fulfillment orders?
      - Can I fulfill one or many fulfillment orders in a single call on 2020-10?
      instructions:
      - text: Create a fulfillment for one or more fulfillment orders (API 2020-10).
      - text: With October 2020, ship several fulfillment orders as one fulfillment.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/fulfillments/{fulfillment_id}/update_tracking.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a fulfillment's tracking information
      effect: write
      questions:
      - My tracking number was wrong; how do I update it on a fulfillment in 2020-10?
      - Where does October 2020 let me change a fulfillment's tracking information?
      instructions:
      - text: Update tracking for fulfillment {fulfillment} (API 2020-10).
        slots:
          fulfillment: path.fulfillment_id
      - text: With October 2020, replace the tracking details on fulfillment {fulfillment}.
        slots:
          fulfillment: path.fulfillment_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/orders/{order_id}/fulfillments/{fulfillment_id}/open.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Mark a fulfillment as open
      effect: write
      questions:
      - How can I mark an order's fulfillment as open in version 2020-10?
      - Where in the October 2020 API do I set a fulfillment's status to open?
      instructions:
      - text: Mark order {order}'s fulfillment {fulfillment} as open (API 2020-10).
        slots:
          order: path.order_id
          fulfillment: path.fulfillment_id
      - text: With October 2020, put fulfillment {fulfillment} on order {order} into open status.
        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}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a fulfillment on an order (2021-01)
      effect: read
      questions:
      - On version 2021-01, what retrieves a specific fulfillment by its ID?
      - Does January 2021 let me pick which fulfillment fields to return?
      instructions:
      - text: Fetch order {order}'s fulfillment {fulfillment} with 2021-01.
        slots:
          order: path.order_id
          fulfillment: path.fulfillment_id
      - text: Using January 2021, get fulfillment {fulfillment} on order {order}, fields {fields} only.
        slots:
          fulfillment: path.fulfillment_id
          order: path.order_id
          fields: query.fields
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/fulfillments.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Fulfill one or many fulfillment orders (2021-01)
      effect: write
      questions:
      - On 2021-01, which endpoint creates a fulfillment from fulfillment orders?
      - Does January 2021 support fulfilling multiple fulfillment orders together?
      instructions:
      - text: Fulfill my fulfillment orders by creating a fulfillment on 2021-01.
      - text: Using January 2021, make a single fulfillment for many fulfillment orders.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/fulfillments/{fulfillment_id}/update_tracking.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Update a fulfillment's tracking (2021-01)
      effect: write
      questions:
      - On version 2021-01, which call updates tracking for a fulfillment?
      - Can I revise fulfillment tracking using January 2021?
      instructions:
      - text: Revise the tracking information of fulfillment {fulfillment} on 2021-01.
        slots:
          fulfillment: path.fulfillment_id
      - text: Using January 2021, update fulfillment {fulfillment} with corrected tracking.
        slots:
          fulfillment: path.fulfillment_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/orders/{order_id}/fulfillments/{fulfillment_id}/open.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Mark a fulfillment as open (2021-01)
      effect: write
      questions:
      - On 2021-01, what marks a fulfillment open?
      - Can January 2021 flag a specific fulfillment on an order as open?
      instructions:
      - text: Open order {order}'s fulfillment {fulfillment} using 2021-01.
        slots:
          order: path.order_id
          fulfillment: path.fulfillment_id
      - text: Using January 2021, set fulfillment {fulfillment} for order {order} to open.
        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}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Retrieve a fulfillment on an order (unstable)
      effect: read
      questions:
      - Can I read a single fulfillment from an order on the unstable API?
      - Is it possible to request selected fields for a fulfillment on the unstable version?
      instructions:
      - text: Get fulfillment {fulfillment} of order {order} on unstable.
        slots:
          fulfillment: path.fulfillment_id
          order: path.order_id
      - text: Using the unstable endpoint, return {fields} for fulfillment {fulfillment} on order {order}.
        slots:
          fields: query.fields
          fulfillment: path.fulfillment_id
          order: path.order_id
      method: generated
      generated: '2026-09-24'


# --- truncated at 32 KB (75 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/shopify/refs/heads/main/overlays/shopify-fulfillment-api-phrasing-overlay.yaml