Shopify · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Shopify Associated API

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

$.info
$.paths['/admin/api/2020-01/orders/{order_id}/fulfillments.json'].get
$.paths['/admin/api/2020-01/fulfillment_orders/{fulfillment_order_id}/fulfillments.json'].get
$.paths['/admin/api/2020-01/orders/{order_id}/fulfillments/count.json'].get
$.paths['/admin/api/2020-01/orders/{order_id}/fulfillments/{fulfillment_id}.json'].put
$.paths['/admin/api/2020-04/orders/{order_id}/fulfillments.json'].get
$.paths['/admin/api/2020-04/fulfillment_orders/{fulfillment_order_id}/fulfillments.json'].get
$.paths['/admin/api/2020-04/orders/{order_id}/fulfillments/count.json'].get
$.paths['/admin/api/2020-04/orders/{order_id}/fulfillments/{fulfillment_id}.json'].put
$.paths['/admin/api/2020-07/orders/{order_id}/fulfillments.json'].get
$.paths['/admin/api/2020-07/fulfillment_orders/{fulfillment_order_id}/fulfillments.json'].get
$.paths['/admin/api/2020-07/orders/{order_id}/fulfillments/count.json'].get
$.paths['/admin/api/2020-07/orders/{order_id}/fulfillments/{fulfillment_id}.json'].put
$.paths['/admin/api/2020-10/orders/{order_id}/fulfillments.json'].get
$.paths['/admin/api/2020-10/fulfillment_orders/{fulfillment_order_id}/fulfillments.json'].get
$.paths['/admin/api/2020-10/orders/{order_id}/fulfillments/count.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 Associated API
  version: 1.0.0
extends: openapi/shopify-associated-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: 24
- target: $.paths['/admin/api/2020-01/orders/{order_id}/fulfillments.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List an order's fulfillments (2020-01 API)
      effect: read
      questions:
      - How do I see every shipment made against an order on the 2020-01 API?
      - Can I limit an order's fulfillment list to ones created after a date, in 2020-01?
      instructions:
      - text: List the fulfillments on order {order} using the 2020-01 API.
        slots:
          order: path.order_id
      - text: Show up to {limit} fulfillments for order {order}, version 2020-01.
        slots:
          order: path.order_id
          limit: query.limit
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/fulfillment_orders/{fulfillment_order_id}/fulfillments.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List a fulfillment order's fulfillments (2020-01)
      effect: read
      questions:
      - How do I see the fulfillments created from one fulfillment order on 2020-01?
      - Can I look up fulfillments by fulfillment order instead of by order in 2020-01?
      instructions:
      - text: List fulfillments for fulfillment order {fo} using the 2020-01 API.
        slots:
          fo: path.fulfillment_order_id
      - text: Show what was shipped from fulfillment order {fo}, version 2020-01.
        slots:
          fo: path.fulfillment_order_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/orders/{order_id}/fulfillments/count.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Count an order's fulfillments (2020-01 API)
      effect: read
      questions:
      - How do I find out how many fulfillments an order has on the 2020-01 API?
      - Can I count only the fulfillments created in a date range for an order, in 2020-01?
      instructions:
      - text: Count the fulfillments on order {order} using the 2020-01 API.
        slots:
          order: path.order_id
      - text: Tell me how many fulfillments order {order} got since {created_min}, version 2020-01.
        slots:
          order: path.order_id
          created_min: query.created_at_min
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/orders/{order_id}/fulfillments/{fulfillment_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a fulfillment on an order (2020-01 API)
      effect: write
      questions:
      - How do I change the information on a fulfillment I already created, on 2020-01?
      - Can I edit an existing fulfillment of an order with the 2020-01 API?
      instructions:
      - text: Update fulfillment {fulfillment} on order {order} using the 2020-01 API.
        slots:
          order: path.order_id
          fulfillment: path.fulfillment_id
      - text: Edit the details of order {order}'s fulfillment {fulfillment}, version 2020-01.
        slots:
          order: path.order_id
          fulfillment: path.fulfillment_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/orders/{order_id}/fulfillments.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List an order's fulfillments (2020-04 API)
      effect: read
      questions:
      - Which fulfillments has an order had so far, per the 2020-04 release?
      - Is there a way to page through an order's fulfillments by since_id on 2020-04?
      instructions:
      - text: Get all fulfillments for order {order} on 2020-04.
        slots:
          order: path.order_id
      - text: List fulfillments of order {order} after ID {since_id} via the 2020-04 release.
        slots:
          order: path.order_id
          since_id: query.since_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/fulfillment_orders/{fulfillment_order_id}/fulfillments.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List a fulfillment order's fulfillments (2020-04)
      effect: read
      questions:
      - Which fulfillments belong to a specific fulfillment order under the 2020-04 release?
      - Is there a 2020-04 endpoint for fulfillments of a fulfillment order?
      instructions:
      - text: Get the fulfillments of fulfillment order {fo} on 2020-04.
        slots:
          fo: path.fulfillment_order_id
      - text: Pull shipments tied to fulfillment order {fo} via the 2020-04 release.
        slots:
          fo: path.fulfillment_order_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/orders/{order_id}/fulfillments/count.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Count an order's fulfillments (2020-04 API)
      effect: read
      questions:
      - What's the number of fulfillments on a given order, per the 2020-04 release?
      - Is a fulfillment count for one order available in 2020-04?
      instructions:
      - text: Get the fulfillment count for order {order} on 2020-04.
        slots:
          order: path.order_id
      - text: Count order {order}'s fulfillments updated after {updated_min} via the 2020-04 release.
        slots:
          order: path.order_id
          updated_min: query.updated_at_min
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/orders/{order_id}/fulfillments/{fulfillment_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a fulfillment on an order (2020-04 API)
      effect: write
      questions:
      - Which 2020-04 call modifies an existing fulfillment on an order?
      - Is editing a fulfillment supported in the 2020-04 release?
      instructions:
      - text: Change fulfillment {fulfillment} of order {order} on 2020-04.
        slots:
          order: path.order_id
          fulfillment: path.fulfillment_id
      - text: Revise order {order}'s existing fulfillment {fulfillment} via the 2020-04 release.
        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.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List an order's fulfillments (2020-07 API)
      effect: read
      questions:
      - Where do I read the fulfillments attached to an order in version 2020-07?
      - Can I filter an order's fulfillments by when they were last updated, using 2020-07?
      instructions:
      - text: Retrieve order {order}'s fulfillments through the 2020-07 version.
        slots:
          order: path.order_id
      - text: Show fulfillments on order {order} updated since {updated_min}, with 2020-07.
        slots:
          order: path.order_id
          updated_min: query.updated_at_min
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/fulfillment_orders/{fulfillment_order_id}/fulfillments.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List a fulfillment order's fulfillments (2020-07)
      effect: read
      questions:
      - Where do I read fulfillments for one fulfillment order in version 2020-07?
      - What fulfillments has a single fulfillment order produced, per 2020-07?
      instructions:
      - text: Retrieve fulfillment order {fo}'s fulfillments through 2020-07.
        slots:
          fo: path.fulfillment_order_id
      - text: Show the fulfillments generated by fulfillment order {fo} with 2020-07.
        slots:
          fo: path.fulfillment_order_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/orders/{order_id}/fulfillments/count.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Count an order's fulfillments (2020-07 API)
      effect: read
      questions:
      - Where do I get a total of an order's fulfillments in version 2020-07?
      - Can I tally fulfillments for an order created before a certain date, using 2020-07?
      instructions:
      - text: Return how many fulfillments order {order} has through the 2020-07 version.
        slots:
          order: path.order_id
      - text: Count fulfillments on order {order} created before {created_max} with 2020-07.
        slots:
          order: path.order_id
          created_max: query.created_at_max
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/orders/{order_id}/fulfillments/{fulfillment_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a fulfillment on an order (2020-07 API)
      effect: write
      questions:
      - Where do I update a fulfillment's information in version 2020-07?
      - What endpoint in 2020-07 edits a fulfillment that's already on an order?
      instructions:
      - text: Modify fulfillment {fulfillment} for order {order} through the 2020-07 version.
        slots:
          order: path.order_id
          fulfillment: path.fulfillment_id
      - text: Adjust the info on fulfillment {fulfillment} of order {order} with 2020-07.
        slots:
          order: path.order_id
          fulfillment: path.fulfillment_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/orders/{order_id}/fulfillments.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List an order's fulfillments (2020-10 API)
      effect: read
      questions:
      - What shipments have gone out for a given order, according to the 2020-10 API?
      - Does the 2020-10 Admin API let me return only certain fields for an order's fulfillments?
      instructions:
      - text: List every fulfillment for order {order} with the 2020-10 Admin API.
        slots:
          order: path.order_id
      - text: Return fulfillments on order {order} created before {created_max}, API 2020-10.
        slots:
          order: path.order_id
          created_max: query.created_at_max
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/fulfillment_orders/{fulfillment_order_id}/fulfillments.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List a fulfillment order's fulfillments (2020-10)
      effect: read
      questions:
      - How can I check what has been fulfilled on one fulfillment order with the 2020-10 API?
      - Does the 2020-10 Admin API list fulfillments grouped under a fulfillment order?
      instructions:
      - text: List fulfillments associated with fulfillment order {fo} on the 2020-10 API.
        slots:
          fo: path.fulfillment_order_id
      - text: Fetch every fulfillment made from fulfillment order {fo}, API 2020-10.
        slots:
          fo: path.fulfillment_order_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/orders/{order_id}/fulfillments/count.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Count an order's fulfillments (2020-10 API)
      effect: read
      questions:
      - How many separate shipments has an order been split into, according to the 2020-10 API?
      - Does the 2020-10 Admin API give a fulfillment count without listing them?
      instructions:
      - text: Count fulfillments for order {order} with the 2020-10 Admin API.
        slots:
          order: path.order_id
      - text: Number of fulfillments on order {order} last updated before {updated_max}, API 2020-10.
        slots:
          order: path.order_id
          updated_max: query.updated_at_max
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/orders/{order_id}/fulfillments/{fulfillment_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a fulfillment on an order (2020-10 API)
      effect: write
      questions:
      - How can I correct details on an order's existing fulfillment using the 2020-10 API?
      - Does the 2020-10 Admin API allow updating a fulfillment after it's created?
      instructions:
      - text: Update order {order}'s fulfillment {fulfillment} on the 2020-10 API.
        slots:
          order: path.order_id
          fulfillment: path.fulfillment_id
      - text: Fix the information stored on fulfillment {fulfillment} of order {order}, API 2020-10.
        slots:
          order: path.order_id
          fulfillment: path.fulfillment_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/orders/{order_id}/fulfillments.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List an order's fulfillments (2021-01 API)
      effect: read
      questions:
      - Can I pull all fulfillments for one order using the 2021-01 release?
      - Which 2021-01 call lists an order's fulfillments with date filters?
      instructions:
      - text: Using 2021-01, list the fulfillments of order {order}.
        slots:
          order: path.order_id
      - text: Fetch order {order}'s fulfillments created on or after {created_min}, 2021-01 release.
        slots:
          order: path.order_id
          created_min: query.created_at_min
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/fulfillment_orders/{fulfillment_order_id}/fulfillments.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List a fulfillment order's fulfillments (2021-01)
      effect: read
      questions:
      - Can I list fulfillments for a fulfillment order using the 2021-01 release?
      - Which 2021-01 endpoint returns fulfillments by fulfillment order ID?
      instructions:
      - text: Using 2021-01, list fulfillments of fulfillment order {fo}.
        slots:
          fo: path.fulfillment_order_id
      - text: Display shipments recorded against fulfillment order {fo} on the 2021-01 release.
        slots:
          fo: path.fulfillment_order_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/orders/{order_id}/fulfillments/count.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Count an order's fulfillments (2021-01 API)
      effect: read
      questions:
      - Can I count an order's fulfillments using the 2021-01 release?
      - Which 2021-01 call returns just the fulfillment total for one order?
      instructions:
      - text: Using 2021-01, count the fulfillments of order {order}.
        slots:
          order: path.order_id
      - text: Give the fulfillment tally for order {order} on the 2021-01 release.
        slots:
          order: path.order_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/orders/{order_id}/fulfillments/{fulfillment_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a fulfillment on an order (2021-01 API)
      effect: write
      questions:
      - Can I change an existing fulfillment with the 2021-01 release?
      - Which 2021-01 endpoint updates a fulfillment on an order?
      instructions:
      - text: With the 2021-01 release, edit fulfillment {fulfillment} on order {order}.
        slots:
          order: path.order_id
          fulfillment: path.fulfillment_id
      - text: Overwrite fulfillment {fulfillment} details for order {order} using 2021-01.
        slots:
          order: path.order_id
          fulfillment: path.fulfillment_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/orders/{order_id}/fulfillments.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List an order's fulfillments (unstable API)
      effect: read
      questions:
      - Is listing an order's fulfillments available on the unstable API?
      - How would I list fulfillments for an order against the unstable version?
      instructions:
      - text: List fulfillments for order {order} on the unstable API version.
        slots:
          order: path.order_id
      - text: On the unstable release, show order {order}'s fulfillments updated before {updated_max}.
        slots:
          order: path.order_id
          updated_max: query.updated_at_max
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/fulfillment_orders/{fulfillment_order_id}/fulfillments.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List a fulfillment order's fulfillments (unstable)
      effect: read
      questions:
      - Is listing a fulfillment order's fulfillments available on the unstable API?
      - How would I read fulfillments for a fulfillment order on the unstable version?
      instructions:
      - text: List fulfillments for fulfillment order {fo} on the unstable API.
        slots:
          fo: path.fulfillment_order_id
      - text: On the unstable release, show fulfillments from fulfillment order {fo}.
        slots:
          fo: path.fulfillment_order_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/orders/{order_id}/fulfillments/count.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Count an order's fulfillments (unstable API)
      effect: read
      questions:
      - Is a fulfillment count for an order available on the unstable API?
      - How would I count an order's fulfillments against the unstable version?
      instructions:
      - text: Count fulfillments on order {order} on the unstable API version.
        slots:
          order: path.order_id
      - text: On the unstable release, report how many fulfillments order {order} has.
        slots:
          order: path.order_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/orders/{order_id}/fulfillments/{fulfillment_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a fulfillment on an order (unstable API)
      effect: write
      questions:
      - Is there an unstable-version call to update an order's fulfillment?
      - How would I edit an existing fulfillment on the unstable Admin API?
      instructions:
      - text: Update fulfillment {fulfillment} on order {order} on the unstable version.
        slots:
          order: path.order_id
          fulfillment: path.fulfillment_id
      - text: Via the unstable API, change order {order}'s fulfillment {fulfillment}.
        slots:
          order: path.order_id
          fulfillment: path.fulfillment_id
      method: generated
      generated: '2026-09-24'