Shopify · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Shopify Summaries API

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

$.info
$.paths['/admin/api/2020-01/products/{product_id}/images/{image_id}.json'].delete
$.paths['/admin/api/2020-04/products/{product_id}/images/{image_id}.json'].delete
$.paths['/admin/api/2020-07/products/{product_id}/images/{image_id}.json'].delete
$.paths['/admin/api/2020-10/products/{product_id}/images/{image_id}.json'].delete
$.paths['/admin/api/2021-01/products/{product_id}/images/{image_id}.json'].delete
$.paths['/admin/api/unstable/products/{product_id}/images/{image_id}.json'].delete
$.paths['/admin/api/2020-01/fulfillment_services.json'].get
$.paths['/admin/api/2020-01/fulfillment_services/{fulfillment_service_id}.json'].get
$.paths['/admin/api/2020-01/fulfillment_services/{fulfillment_service_id}.json'].put
$.paths['/admin/api/2020-01/fulfillment_services/{fulfillment_service_id}.json'].delete
$.paths['/admin/api/2020-04/fulfillment_services.json'].get
$.paths['/admin/api/2020-04/fulfillment_services/{fulfillment_service_id}.json'].get
$.paths['/admin/api/2020-04/fulfillment_services/{fulfillment_service_id}.json'].put
$.paths['/admin/api/2020-04/fulfillment_services/{fulfillment_service_id}.json'].delete
$.paths['/admin/api/2020-07/fulfillment_services.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 Summaries API
  version: 1.0.0
extends: openapi/shopify-summaries-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/products/{product_id}/images/{image_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an image from a product (API 2020-01)
      effect: destructive
      questions:
      - How do I take a photo off a product listing with API 2020-01?
      - Is removing a product image through version 2020-01 permanent?
      instructions:
      - text: Delete image {image} from product {product} using 2020-01.
        slots:
          image: path.image_id
          product: path.product_id
      - text: Remove picture {image} on product {product}, release 2020-01.
        slots:
          image: path.image_id
          product: path.product_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/products/{product_id}/images/{image_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an image from a product (API 2020-04)
      effect: destructive
      questions:
      - Can I get rid of an outdated product photo via release 2020-04?
      - Which 2020-04 call removes one image from a product's gallery?
      instructions:
      - text: Erase product {product} image {image} with 2020-04.
        slots:
          product: path.product_id
          image: path.image_id
      - text: Take image {image} off product {product} via version 2020-04.
        slots:
          image: path.image_id
          product: path.product_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/products/{product_id}/images/{image_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an image from a product (API 2020-07)
      effect: destructive
      questions:
      - Can version 2020-07 delete a single picture from a product?
      - What happens to a product image I delete on API 2020-07?
      instructions:
      - text: Delete the product photo {image} from item {product}, 2020-07.
        slots:
          image: path.image_id
          product: path.product_id
      - text: Drop image {image} from product {product} using API 2020-07.
        slots:
          image: path.image_id
          product: path.product_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/products/{product_id}/images/{image_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an image from a product (API 2020-10)
      effect: destructive
      questions:
      - What's the 2020-10 request to remove a product image?
      - Can I delete one image without touching the rest of a product's photos on 2020-10?
      instructions:
      - text: Remove image {image} from product {product} on version 2020-10.
        slots:
          image: path.image_id
          product: path.product_id
      - text: Delete product {product} picture {image}, API 2020-10.
        slots:
          product: path.product_id
          image: path.image_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/products/{product_id}/images/{image_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an image from a product (API 2021-01)
      effect: destructive
      questions:
      - How can I clear a wrong photo from a product using 2021-01?
      - Is there a 2021-01 endpoint for deleting one product image by ID?
      instructions:
      - text: Delete image {image} belonging to product {product}, release 2021-01.
        slots:
          image: path.image_id
          product: path.product_id
      - text: Pull photo {image} off product {product} with 2021-01.
        slots:
          image: path.image_id
          product: path.product_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/products/{product_id}/images/{image_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an image from a product (unstable API)
      effect: destructive
      questions:
      - Can I delete a product image through the unstable API version?
      - Does the unstable release support removing one photo from a product?
      instructions:
      - text: Delete product image {image} from {product} via the unstable API.
        slots:
          image: path.image_id
          product: path.product_id
      - text: Remove photo {image} of product {product}, unstable version.
        slots:
          image: path.image_id
          product: path.product_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/fulfillment_services.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List fulfillment services (API 2020-01)
      effect: read
      questions:
      - Which fulfillment services has my app registered on the store, per API 2020-01?
      - Can I list every fulfillment provider on the shop, not only my app's, with 2020-01?
      instructions:
      - text: List the fulfillment services my app created, using 2020-01.
      - text: List fulfillment services with scope {scope} on release 2020-01.
        slots:
          scope: query.scope
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/fulfillment_services/{fulfillment_service_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one fulfillment service (API 2020-01)
      effect: read
      questions:
      - How is a particular fulfillment service configured, read through 2020-01?
      - Can I look up one warehouse or 3PL service by its ID on version 2020-01?
      instructions:
      - text: Get fulfillment service {service} with API 2020-01.
        slots:
          service: path.fulfillment_service_id
      - text: Show details of fulfillment provider {service}, 2020-01.
        slots:
          service: path.fulfillment_service_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/fulfillment_services/{fulfillment_service_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a fulfillment service (API 2020-01)
      effect: write
      questions:
      - Can I change the settings of an existing fulfillment service on 2020-01?
      - Which 2020-01 call modifies a fulfillment service my app already registered?
      instructions:
      - text: Update fulfillment service {service} using version 2020-01.
        slots:
          service: path.fulfillment_service_id
      - text: Modify the existing fulfillment provider {service}, release 2020-01.
        slots:
          service: path.fulfillment_service_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/fulfillment_services/{fulfillment_service_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a fulfillment service (API 2020-01)
      effect: destructive
      questions:
      - How do I unregister a fulfillment service from the store with 2020-01?
      - Is deleting a fulfillment service on API 2020-01 reversible?
      instructions:
      - text: Delete fulfillment service {service} on 2020-01.
        slots:
          service: path.fulfillment_service_id
      - text: Unregister the fulfillment provider {service} via API 2020-01.
        slots:
          service: path.fulfillment_service_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/fulfillment_services.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List fulfillment services (API 2020-04)
      effect: read
      questions:
      - What fulfillment providers are set up on this shop, according to release 2020-04?
      - Does 2020-04 default to showing only the calling app's fulfillment services?
      instructions:
      - text: Show all fulfillment services created by my app via 2020-04.
      - text: Get fulfillment services for scope {scope}, API 2020-04.
        slots:
          scope: query.scope
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/fulfillment_services/{fulfillment_service_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one fulfillment service (API 2020-04)
      effect: read
      questions:
      - Can I read one fulfillment service record by ID using 2020-04?
      - What does version 2020-04 return for a single fulfillment service?
      instructions:
      - text: Fetch fulfillment service {service} through 2020-04.
        slots:
          service: path.fulfillment_service_id
      - text: Look up the 3PL service {service} on release 2020-04.
        slots:
          service: path.fulfillment_service_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/fulfillment_services/{fulfillment_service_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a fulfillment service (API 2020-04)
      effect: write
      questions:
      - Is it possible to edit a registered fulfillment service through 2020-04?
      - What 2020-04 request changes an existing fulfillment provider?
      instructions:
      - text: Edit fulfillment service {service} with release 2020-04.
        slots:
          service: path.fulfillment_service_id
      - text: Change the configuration of fulfillment provider {service}, 2020-04.
        slots:
          service: path.fulfillment_service_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/fulfillment_services/{fulfillment_service_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a fulfillment service (API 2020-04)
      effect: destructive
      questions:
      - Can I remove a fulfillment service my app no longer uses via 2020-04?
      - Which 2020-04 call deletes a fulfillment provider from the shop?
      instructions:
      - text: Remove fulfillment service {service} using API 2020-04.
        slots:
          service: path.fulfillment_service_id
      - text: Delete the 3PL provider {service} from my shop, version 2020-04.
        slots:
          service: path.fulfillment_service_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/fulfillment_services.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List fulfillment services (API 2020-07)
      effect: read
      questions:
      - Can I see the third-party fulfillment services on my store with 2020-07?
      - What scope values change which fulfillment services 2020-07 returns?
      instructions:
      - text: List fulfillment services on the store with version 2020-07.
      - text: Return fulfillment services in scope {scope} via 2020-07.
        slots:
          scope: query.scope
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/fulfillment_services/{fulfillment_service_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one fulfillment service (API 2020-07)
      effect: read
      questions:
      - Where do I check one fulfillment service's details on 2020-07?
      - Can release 2020-07 retrieve a fulfillment provider by its ID?
      instructions:
      - text: Retrieve fulfillment service {service} on API 2020-07.
        slots:
          service: path.fulfillment_service_id
      - text: Read the record for fulfillment provider {service}, version 2020-07.
        slots:
          service: path.fulfillment_service_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/fulfillment_services/{fulfillment_service_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a fulfillment service (API 2020-07)
      effect: write
      questions:
      - Can I revise an existing fulfillment service's setup on version 2020-07?
      - Which 2020-07 endpoint saves changes to a fulfillment provider?
      instructions:
      - text: Save changes to fulfillment service {service} via 2020-07.
        slots:
          service: path.fulfillment_service_id
      - text: Update 3PL service {service} using release 2020-07.
        slots:
          service: path.fulfillment_service_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/fulfillment_services/{fulfillment_service_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a fulfillment service (API 2020-07)
      effect: destructive
      questions:
      - How can I delete a fulfillment service from the shop using 2020-07?
      - What happens when I remove a fulfillment provider on release 2020-07?
      instructions:
      - text: Delete fulfillment provider {service} with 2020-07.
        slots:
          service: path.fulfillment_service_id
      - text: Remove the fulfillment service {service} from the store, API 2020-07.
        slots:
          service: path.fulfillment_service_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/fulfillment_services.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List fulfillment services (API 2020-10)
      effect: read
      questions:
      - Which fulfillment services exist on my store when I ask API 2020-10?
      - Can I include fulfillment providers created by other apps in the 2020-10 list?
      instructions:
      - text: List my app's fulfillment services on version 2020-10.
      - text: Show fulfillment services with scope set to {scope}, 2020-10.
        slots:
          scope: query.scope
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/fulfillment_services/{fulfillment_service_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one fulfillment service (API 2020-10)
      effect: read
      questions:
      - How do I view a single fulfillment service by ID on 2020-10?
      - What details about one fulfillment provider does version 2020-10 expose?
      instructions:
      - text: Get the fulfillment service {service} via API 2020-10.
        slots:
          service: path.fulfillment_service_id
      - text: Show fulfillment provider {service} as recorded in 2020-10.
        slots:
          service: path.fulfillment_service_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/fulfillment_services/{fulfillment_service_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a fulfillment service (API 2020-10)
      effect: write
      questions:
      - Can I update a fulfillment service that's already registered using 2020-10?
      - Which 2020-10 request edits an existing fulfillment provider?
      instructions:
      - text: Update the fulfillment service {service} on 2020-10.
        slots:
          service: path.fulfillment_service_id
      - text: Apply changes to fulfillment provider {service} with API 2020-10.
        slots:
          service: path.fulfillment_service_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/fulfillment_services/{fulfillment_service_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a fulfillment service (API 2020-10)
      effect: destructive
      questions:
      - Can I permanently delete a fulfillment service on version 2020-10?
      - Which 2020-10 call unregisters a fulfillment provider?
      instructions:
      - text: Delete fulfillment service {service} through 2020-10.
        slots:
          service: path.fulfillment_service_id
      - text: Unregister 3PL provider {service} from the shop, version 2020-10.
        slots:
          service: path.fulfillment_service_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/fulfillment_services.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List fulfillment services (API 2021-01)
      effect: read
      questions:
      - What fulfillment services does release 2021-01 show for my shop?
      - Can I ask 2021-01 for all fulfillment providers instead of just my app's?
      instructions:
      - text: Get the fulfillment services list with 2021-01.
      - text: List fulfillment providers for scope {scope}, release 2021-01.
        slots:
          scope: query.scope
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/fulfillment_services/{fulfillment_service_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one fulfillment service (API 2021-01)
      effect: read
      questions:
      - Can I fetch a single fulfillment service via version 2021-01?
      - What is stored on one fulfillment provider when read with 2021-01?
      instructions:
      - text: Fetch fulfillment provider {service} with 2021-01.
        slots:
          service: path.fulfillment_service_id
      - text: Retrieve fulfillment service {service} details on release 2021-01.
        slots:
          service: path.fulfillment_service_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/fulfillment_services/{fulfillment_service_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a fulfillment service (API 2021-01)
      effect: write
      questions:
      - Can I edit an existing fulfillment service through API 2021-01?
      - Which 2021-01 request updates a registered 3PL service?
      instructions:
      - text: Update fulfillment provider {service} via 2021-01.
        slots:
          service: path.fulfillment_service_id
      - text: Revise the fulfillment service {service} using version 2021-01.
        slots:
          service: path.fulfillment_service_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/fulfillment_services/{fulfillment_service_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a fulfillment service (API 2021-01)
      effect: destructive
      questions:
      - Can I remove a fulfillment service using release 2021-01?
      - What 2021-01 call deletes a 3PL service from my store?
      instructions:
      - text: Delete the fulfillment service {service} on API 2021-01.
        slots:
          service: path.fulfillment_service_id
      - text: Take fulfillment provider {service} off the store with 2021-01.
        slots:
          service: path.fulfillment_service_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/fulfillment_services.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List fulfillment services (unstable API)
      effect: read
      questions:
      - Which fulfillment services does the unstable API list for my store?
      - Is the scope filter available on the unstable fulfillment services list?
      instructions:
      - text: List fulfillment services from the unstable release.
      - text: Show unstable-API fulfillment services for scope {scope}.
        slots:
          scope: query.scope
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/fulfillment_services/{fulfillment_service_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one fulfillment service (unstable API)
      effect: read
      questions:
      - Can I retrieve one fulfillment service through the unstable version?
      - What does the unstable API return for a single 3PL service?
      instructions:
      - text: Get fulfillment service {service} from the unstable API.
        slots:
          service: path.fulfillment_service_id
      - text: Show 3PL provider {service} on the unstable release.
        slots:
          service: path.fulfillment_service_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/fulfillment_services/{fulfillment_service_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a fulfillment service (unstable API)
      effect: write
      questions:
      - Can I modify a fulfillment service through the unstable API?
      - Is updating a registered fulfillment provider supported on the unstable release?
      instructions:
      - text: Update fulfillment service {service} using the unstable version.
        slots:
          service: path.fulfillment_service_id
      - text: Edit 3PL provider {service} via the unstable API.
        slots:
          service: path.fulfillment_service_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/fulfillment_services/{fulfillment_service_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a fulfillment service (unstable API)
      effect: destructive
      questions:
      - Can the unstable API delete a fulfillment service from my store?
      - What unstable-release call unregisters a 3PL provider?
      instructions:
      - text: Delete fulfillment service {service} with the unstable API.
        slots:
          service: path.fulfillment_service_id
      - text: Unregister fulfillment provider {service} on the unstable release.
        slots:
          service: path.fulfillment_service_id
      method: generated
      generated: '2026-09-24'