API Evangelist conversational phrasing for Shopify Events API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Shopify Events API
  version: 1.0.0
extends: openapi/shopify-events-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: 30
- target: $.paths['/admin/api/2020-01/events.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List store activity events (API 2020-01)
      effect: read
      questions:
      - What has happened in my store recently, like products created or orders placed, on API 2020-01?
      - Can I list only store events of a certain verb, such as destroy, with 2020-01?
      instructions:
      - text: List the latest {limit} store activity events on 2020-01.
        slots:
          limit: query.limit
      - text: Show store events with verb {verb} created after {created_at_min}, version 2020-01.
        slots:
          verb: query.verb
          created_at_min: query.created_at_min
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/events/{event_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one store activity event (API 2020-01)
      effect: read
      questions:
      - Can I look up the details of one store activity event by its ID on 2020-01?
      - Which fields of a single shop event can API 2020-01 return?
      instructions:
      - text: Get store event {event_id} using API 2020-01.
        slots:
          event_id: path.event_id
      - text: Show {fields} for shop activity event {event_id}, release 2020-01.
        slots:
          fields: query.fields
          event_id: path.event_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/events.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List store activity events (API 2020-04)
      effect: read
      questions:
      - Which changes to products, orders and collections were logged in my shop per 2020-04?
      - Is it possible to page store events from a known event ID on release 2020-04?
      instructions:
      - text: Pull my shop's activity log through release 2020-04.
      - text: List store events after ID {since_id} matching filter {filter}, 2020-04.
        slots:
          since_id: query.since_id
          filter: query.filter
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/events/{event_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one store activity event (API 2020-04)
      effect: read
      questions:
      - What exactly happened in one logged store event, fetched with 2020-04?
      - Can release 2020-04 return just a couple of fields for a single shop event?
      instructions:
      - text: Fetch activity event {event_id} from my store on 2020-04.
        slots:
          event_id: path.event_id
      - text: Read shop event {event_id} limited to {fields} with 2020-04.
        slots:
          event_id: path.event_id
          fields: query.fields
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/events.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List store activity events (API 2020-07)
      effect: read
      questions:
      - Can I audit what staff and apps changed in my store during a date range using 2020-07?
      - How many store events can one 2020-07 request return at most?
      instructions:
      - text: List store events between {created_at_min} and {created_at_max} on 2020-07.
        slots:
          created_at_min: query.created_at_min
          created_at_max: query.created_at_max
      - text: Show recent shop activity with only {fields}, version 2020-07.
        slots:
          fields: query.fields
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/events/{event_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one store activity event (API 2020-07)
      effect: read
      questions:
      - Where do I read the full record of one store event on 2020-07?
      - Does version 2020-07 allow selecting fields when fetching one activity event?
      instructions:
      - text: Look up store activity event {event_id} with 2020-07.
        slots:
          event_id: path.event_id
      - text: Return {fields} of event {event_id} from the shop log, API 2020-07.
        slots:
          fields: query.fields
          event_id: path.event_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/events.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List store activity events (API 2020-10)
      effect: read
      questions:
      - Which products or orders were deleted from my store lately, according to 2020-10 events?
      - Can I filter the store activity feed by resource type on version 2020-10?
      instructions:
      - text: List store events filtered to {filter} with API 2020-10.
        slots:
          filter: query.filter
      - text: Show {limit} shop activity events of verb {verb} on 2020-10.
        slots:
          limit: query.limit
          verb: query.verb
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/events/{event_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one store activity event (API 2020-10)
      effect: read
      questions:
      - Can I see who or what triggered one particular store event on 2020-10?
      - What does a single activity event look like in the 2020-10 API?
      instructions:
      - text: Retrieve store event {event_id} on version 2020-10.
        slots:
          event_id: path.event_id
      - text: Get just {fields} of activity event {event_id}, 2020-10.
        slots:
          fields: query.fields
          event_id: path.event_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/events.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List store activity events (API 2021-01)
      effect: read
      questions:
      - What is in my store's recent activity history when read through 2021-01?
      - Can I cap the number of shop events returned by release 2021-01?
      instructions:
      - text: List the store's activity events using version 2021-01.
      - text: Show store events created before {created_at_max}, capped at {limit}, 2021-01.
        slots:
          created_at_max: query.created_at_max
          limit: query.limit
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/events/{event_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one store activity event (API 2021-01)
      effect: read
      questions:
      - Can I open a single entry in my shop's activity log with API 2021-01?
      - Which fields may I request for one store event in 2021-01?
      instructions:
      - text: Get the store activity record {event_id} via 2021-01.
        slots:
          event_id: path.event_id
      - text: Fetch {fields} from shop event {event_id} on release 2021-01.
        slots:
          fields: query.fields
          event_id: path.event_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/events.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List store activity events (unstable API)
      effect: read
      questions:
      - What store activity does the unstable API report for my shop?
      - Can the unstable events listing be filtered by action type?
      instructions:
      - text: List shop activity events from the unstable release.
      - text: Show unstable-API store events with verb {verb} after ID {since_id}.
        slots:
          verb: query.verb
          since_id: query.since_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/events/{event_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one store activity event (unstable API)
      effect: read
      questions:
      - Can I fetch a single shop activity event through the unstable version?
      - Does the unstable API let me pick fields when reading one store event?
      instructions:
      - text: Get activity event {event_id} using the unstable API.
        slots:
          event_id: path.event_id
      - text: Return only {fields} for store event {event_id}, unstable release.
        slots:
          fields: query.fields
          event_id: path.event_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/orders/{order_id}/fulfillments/{fulfillment_id}/events.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List tracking events for a fulfillment (API 2020-01)
      effect: read
      questions:
      - Where is a shipment in transit, based on its fulfillment events on API 2020-01?
      - Can I see every delivery status update logged on one fulfillment with 2020-01?
      instructions:
      - text: List tracking events for fulfillment {fulfillment} on order {order}, 2020-01.
        slots:
          fulfillment: path.fulfillment_id
          order: path.order_id
      - text: Show the delivery history of order {order} shipment {fulfillment} via 2020-01.
        slots:
          order: path.order_id
          fulfillment: path.fulfillment_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/orders/{order_id}/fulfillments/{fulfillment_id}/events.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a shipment status event (API 2020-01)
      effect: write
      questions:
      - How do I post a new delivery status like out for delivery on a fulfillment with 2020-01?
      - Can my app add a tracking update to an order's shipment through release 2020-01?
      instructions:
      - text: Add a fulfillment event to shipment {fulfillment} of order {order}, API 2020-01.
        slots:
          fulfillment: path.fulfillment_id
          order: path.order_id
      - text: Log a new tracking status on order {order} fulfillment {fulfillment} using 2020-01.
        slots:
          order: path.order_id
          fulfillment: path.fulfillment_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/orders/{order_id}/fulfillments/{fulfillment_id}/events/{event_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one fulfillment tracking event (API 2020-01)
      effect: read
      questions:
      - Can I pull up a single shipment status update by its ID on version 2020-01?
      - What detail does 2020-01 give about one specific fulfillment event?
      instructions:
      - text: Get fulfillment event {event} on shipment {fulfillment} of order {order}, 2020-01.
        slots:
          event: path.event_id
          fulfillment: path.fulfillment_id
          order: path.order_id
      - text: Retrieve tracking update {event} for order {order} fulfillment {fulfillment} via 2020-01.
        slots:
          event: path.event_id
          order: path.order_id
          fulfillment: path.fulfillment_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/orders/{order_id}/fulfillments/{fulfillment_id}/events.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List tracking events for a fulfillment (API 2020-04)
      effect: read
      questions:
      - Which carrier status updates exist on an order's fulfillment in 2020-04?
      - Can I trace the delivery progress of a package with version 2020-04?
      instructions:
      - text: Show all shipment events on fulfillment {fulfillment} for order {order}, release 2020-04.
        slots:
          fulfillment: path.fulfillment_id
          order: path.order_id
      - text: List delivery updates on order {order} package {fulfillment} with API 2020-04.
        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/{fulfillment_id}/events.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a shipment status event (API 2020-04)
      effect: write
      questions:
      - Can I mark a package as delivered by creating a fulfillment event on 2020-04?
      - Which 2020-04 call pushes a carrier status update onto a fulfillment?
      instructions:
      - text: Create a shipment status event on fulfillment {fulfillment} of order {order} via 2020-04.
        slots:
          fulfillment: path.fulfillment_id
          order: path.order_id
      - text: Record a delivery update for order {order} package {fulfillment}, version 2020-04.
        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/{fulfillment_id}/events/{event_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one fulfillment tracking event (API 2020-04)
      effect: read
      questions:
      - Can I inspect one tracking event on a shipment with release 2020-04?
      - What does a single fulfillment event record contain in version 2020-04?
      instructions:
      - text: Fetch shipment event {event} on fulfillment {fulfillment} of order {order}, 2020-04.
        slots:
          event: path.event_id
          fulfillment: path.fulfillment_id
          order: path.order_id
      - text: Show delivery status record {event} from order {order} package {fulfillment} via 2020-04.
        slots:
          event: path.event_id
          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}/events.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List tracking events for a fulfillment (API 2020-07)
      effect: read
      questions:
      - What delivery milestones has a shipment reached, per fulfillment events on 2020-07?
      - Can version 2020-07 list every status update recorded for one fulfillment?
      instructions:
      - text: Get tracking events for fulfillment {fulfillment} on order {order} using 2020-07.
        slots:
          fulfillment: path.fulfillment_id
          order: path.order_id
      - text: List the shipment timeline of order {order} fulfillment {fulfillment}, release 2020-07.
        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}/events.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a shipment status event (API 2020-07)
      effect: write
      questions:
      - Can a fulfillment app report in-transit progress on a package with 2020-07?
      - What does API 2020-07 need to add a status event to a shipment?
      instructions:
      - text: Post a fulfillment event to order {order} shipment {fulfillment}, version 2020-07.
        slots:
          order: path.order_id
          fulfillment: path.fulfillment_id
      - text: Add a carrier status update to fulfillment {fulfillment} of order {order} with 2020-07.
        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}/events/{event_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one fulfillment tracking event (API 2020-07)
      effect: read
      questions:
      - Can I retrieve one shipment status update by ID through 2020-07?
      - Which details of a lone fulfillment event are exposed on version 2020-07?
      instructions:
      - text: Get tracking event {event} for fulfillment {fulfillment} on order {order}, API 2020-07.
        slots:
          event: path.event_id
          fulfillment: path.fulfillment_id
          order: path.order_id
      - text: Open fulfillment event {event} on order {order} shipment {fulfillment} with 2020-07.
        slots:
          event: path.event_id
          order: path.order_id
          fulfillment: path.fulfillment_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/orders/{order_id}/fulfillments/{fulfillment_id}/events.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List tracking events for a fulfillment (API 2020-10)
      effect: read
      questions:
      - How can I show a customer the delivery updates for their order shipment on 2020-10?
      - Which status events has a fulfillment accumulated under version 2020-10?
      instructions:
      - text: List fulfillment events for order {order} fulfillment {fulfillment} on 2020-10.
        slots:
          order: path.order_id
          fulfillment: path.fulfillment_id
      - text: Show the carrier updates on shipment {fulfillment} from order {order}, API 2020-10.
        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}/events.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a shipment status event (API 2020-10)
      effect: write
      questions:
      - Can I tell the store a package failed delivery by adding a fulfillment event on 2020-10?
      - Which 2020-10 endpoint records a new status against an order's shipment?
      instructions:
      - text: Create a tracking event on fulfillment {fulfillment} for order {order}, 2020-10.
        slots:
          fulfillment: path.fulfillment_id
          order: path.order_id
      - text: Report a new delivery status on order {order} shipment {fulfillment} via API 2020-10.
        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/{fulfillment_id}/events/{event_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one fulfillment tracking event (API 2020-10)
      effect: read
      questions:
      - Can I fetch a specific delivery status event on a shipment with 2020-10?
      - What is recorded in one fulfillment event when read through version 2020-10?
      instructions:
      - text: Retrieve fulfillment event {event} on order {order} fulfillment {fulfillment}, 2020-10.
        slots:
          event: path.event_id
          order: path.order_id
          fulfillment: path.fulfillment_id
      - text: Show shipment status {event} of package {fulfillment} in order {order} with API 2020-10.
        slots:
          event: path.event_id
          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}/events.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List tracking events for a fulfillment (API 2021-01)
      effect: read
      questions:
      - Can I follow a parcel's journey through its fulfillment events on 2021-01?
      - What status history does release 2021-01 return for one order shipment?
      instructions:
      - text: List shipment status events for fulfillment {fulfillment} of order {order}, 2021-01.
        slots:
          fulfillment: path.fulfillment_id
          order: path.order_id
      - text: Pull delivery tracking history for order {order} package {fulfillment} on 2021-01.
        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/{fulfillment_id}/events.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a shipment status event (API 2021-01)
      effect: write
      questions:
      - Can I note that a shipment was picked up by the carrier using API 2021-01?
      - Which 2021-01 request adds a tracking event to one order fulfillment?
      instructions:
      - text: Add a status event to order {order} fulfillment {fulfillment} with version 2021-01.
        slots:
          order: path.order_id
          fulfillment: path.fulfillment_id
      - text: Record a shipping update on fulfillment {fulfillment} of order {order}, 2021-01.
        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}/events/{event_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one fulfillment tracking event (API 2021-01)
      effect: read
      questions:
      - Can I load one specific tracking update from a fulfillment on 2021-01?
      - What does release 2021-01 show for a single shipment event ID?
      instructions:
      - text: Get delivery event {event} on shipment {fulfillment} of order {order} via 2021-01.
        slots:
          event: path.event_id
          fulfillment: path.fulfillment_id
          order: path.order_id
      - text: Read fulfillment status {event} for order {order} fulfillment {fulfillment}, release 2021-01.
        slots:
          event: path.event_id
          order: path.order_id
          fulfillment: path.fulfillment_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/orders/{order_id}/fulfillments/{fulfillment_id}/events.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List tracking events for a fulfillment (unstable API)
      effect: read
      questions:
      - Which delivery updates does the unstable API list for a fulfillment?
      - Can I read a shipment's status history on the unstable release?
      instructions:
      - text: List tracking events on fulfillment {fulfillment} of order {order} with the unstable API.
        slots:
          fulfillment: path.fulfillment_id
          order: path.order_id
      - text: Show order {order} shipment {fulfillment} status updates from the unstable version.
        slots:
          order: path.order_id
          fulfillment: path.fulfillment_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/orders/{order_id}/fulfillments/{fulfillment_id}/events.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a shipment status event (unstable API)
      effect: write
      questions:
      - Can I add a fulfillment tracking event through the unstable API?
      - Is posting delivery status to a shipment supported on the unstable release?
      instructions:
      - text: Create a fulfillment event for order {order} shipment {fulfillment} on the unstable API.
        slots:
          order: path.order_id
          fulfillment: path.fulfillment_id
      - text: Log a carrier status on fulfillment {fulfillment} of order {order}, unstable version.
        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}/events/{event_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one fulfillment tracking event (unstable API)
      effect: read
      questions:
      - Can I read one shipment tracking event by ID via the unstable API?
      - What does the unstable release return for a specific fulfillment event?
      instructions:
      - text: Get tracking event {event} of fulfillment {fulfillment} on order {order}, unstable API.
        slots:
          event: path.event_id
          fulfillment: path.fulfillment_id
          order: path.order_id
      - text: Fetch shipment status record {event} for order {order} package {fulfillment} from the unstable version.
        slots:
          event: path.event_id
          order: path.order_id
          fulfillment: path.fulfillment_id
      method: generated
      generated: '2026-09-24'