API Evangelist conversational phrasing for Shopify Carrier 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 Carrier API
  version: 1.0.0
extends: openapi/shopify-carrier-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/carrier_services.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List carrier services (2020-01 API)
      effect: read
      questions:
      - How do I see every carrier service registered on my store with the 2020-01 API?
      - Which live shipping-rate providers are set up for my shop, per 2020-01?
      instructions:
      - text: List all carrier services using the 2020-01 API.
      - text: Show every shipping rate provider my store has, version 2020-01.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/carrier_services.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a carrier service (2020-01 API)
      effect: write
      questions:
      - How do I add a carrier service so checkout can request live shipping rates on 2020-01?
      - Can my app create its own carrier service with the 2020-01 API?
      instructions:
      - text: Create a new carrier service using the 2020-01 API.
      - text: Register my shipping rate provider as a carrier service, version 2020-01.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/carrier_services/{carrier_service_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one carrier service (2020-01 API)
      effect: read
      questions:
      - How do I fetch a single carrier service by its ID on the 2020-01 API?
      - What settings come back for one carrier service in version 2020-01?
      instructions:
      - text: Show carrier service {service} using the 2020-01 API.
        slots:
          service: path.carrier_service_id
      - text: Fetch the details of carrier service {service}, version 2020-01.
        slots:
          service: path.carrier_service_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/carrier_services/{carrier_service_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a carrier service (2020-01 API)
      effect: write
      questions:
      - How do I change the settings of an existing carrier service on the 2020-01 API?
      - Can I modify a carrier service I already registered, in 2020-01?
      instructions:
      - text: Update carrier service {service} using version 2020-01.
        slots:
          service: path.carrier_service_id
      - text: Edit the existing carrier service {service} with the 2020-01 API.
        slots:
          service: path.carrier_service_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/carrier_services/{carrier_service_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a carrier service (2020-01 API)
      effect: destructive
      questions:
      - How do I remove a carrier service I no longer need on the 2020-01 API?
      - Can I stop a carrier service from quoting rates by deleting it in 2020-01?
      instructions:
      - text: Delete carrier service {service} using the 2020-01 API.
        slots:
          service: path.carrier_service_id
      - text: Remove the unused carrier service {service}, version 2020-01.
        slots:
          service: path.carrier_service_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/carrier_services.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List carrier services (2020-04 API)
      effect: read
      questions:
      - What carrier services does my store currently have under the 2020-04 release?
      - Can I get all calculated-shipping carrier services at once on 2020-04?
      instructions:
      - text: Get the full list of carrier services on 2020-04.
      - text: Enumerate the store's carrier services via the 2020-04 release.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/carrier_services.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a carrier service (2020-04 API)
      effect: write
      questions:
      - Which 2020-04 call sets up a new carrier service for calculated shipping?
      - Is creating a carrier service supported in the 2020-04 release?
      instructions:
      - text: Set up a carrier service on 2020-04.
      - text: Add a new live-rate carrier service to the shop via the 2020-04 release.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/carrier_services/{carrier_service_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one carrier service (2020-04 API)
      effect: read
      questions:
      - Can I read one carrier service's configuration in the 2020-04 release?
      - Which 2020-04 call returns a specific carrier service by ID?
      instructions:
      - text: Retrieve carrier service {service} on 2020-04.
        slots:
          service: path.carrier_service_id
      - text: Pull up the carrier service with ID {service} via the 2020-04 release.
        slots:
          service: path.carrier_service_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/carrier_services/{carrier_service_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a carrier service (2020-04 API)
      effect: write
      questions:
      - Which 2020-04 call modifies a carrier service that already exists?
      - Is updating a carrier service supported in the 2020-04 release?
      instructions:
      - text: Change carrier service {service} on the 2020-04 release.
        slots:
          service: path.carrier_service_id
      - text: Revise the configuration of carrier service {service} via 2020-04.
        slots:
          service: path.carrier_service_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/carrier_services/{carrier_service_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a carrier service (2020-04 API)
      effect: destructive
      questions:
      - Which 2020-04 endpoint deletes a carrier service from the shop?
      - Is deleting a carrier service supported in the 2020-04 release?
      instructions:
      - text: Remove carrier service {service} on 2020-04.
        slots:
          service: path.carrier_service_id
      - text: Drop carrier service {service} from the store via the 2020-04 release.
        slots:
          service: path.carrier_service_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/carrier_services.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List carrier services (2020-07 API)
      effect: read
      questions:
      - Where do I list the carrier services my apps created, in version 2020-07?
      - Is there a 2020-07 call returning all carrier services for the shop?
      instructions:
      - text: Retrieve every carrier service through the 2020-07 version.
      - text: Give me all carrier services configured in the shop with 2020-07.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/carrier_services.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a carrier service (2020-07 API)
      effect: write
      questions:
      - Where do I create a carrier service in version 2020-07?
      - What does it take to register a new carrier service under 2020-07?
      instructions:
      - text: Add a carrier service through the 2020-07 version.
      - text: Make a new carrier service for my shipping app with 2020-07.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/carrier_services/{carrier_service_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one carrier service (2020-07 API)
      effect: read
      questions:
      - Where do I read a single carrier service in version 2020-07?
      - Does 2020-07 support getting one carrier service by its ID?
      instructions:
      - text: Get carrier service {service} from the 2020-07 version.
        slots:
          service: path.carrier_service_id
      - text: Look up the one carrier service {service} with 2020-07.
        slots:
          service: path.carrier_service_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/carrier_services/{carrier_service_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a carrier service (2020-07 API)
      effect: write
      questions:
      - Where do I update an existing carrier service in version 2020-07?
      - What endpoint in 2020-07 lets me adjust a registered carrier service?
      instructions:
      - text: Modify carrier service {service} through the 2020-07 version.
        slots:
          service: path.carrier_service_id
      - text: Adjust existing carrier service {service} with 2020-07.
        slots:
          service: path.carrier_service_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/carrier_services/{carrier_service_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a carrier service (2020-07 API)
      effect: destructive
      questions:
      - Where do I delete a carrier service in version 2020-07?
      - What happens to live rates at checkout if I delete a carrier service in 2020-07?
      instructions:
      - text: Delete carrier service {service} through the 2020-07 version.
        slots:
          service: path.carrier_service_id
      - text: Erase the carrier service {service} with 2020-07.
        slots:
          service: path.carrier_service_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/carrier_services.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List carrier services (2020-10 API)
      effect: read
      questions:
      - Which carrier services are providing shipping rates to my checkout, per the 2020-10 API?
      - Does the 2020-10 Admin API list carrier services in one request?
      instructions:
      - text: List the store's carrier services with the 2020-10 Admin API.
      - text: Show all registered carrier services, API 2020-10.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/carrier_services.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a carrier service (2020-10 API)
      effect: write
      questions:
      - How can my app start supplying shipping rates by creating a carrier service on 2020-10?
      - Does the 2020-10 Admin API let an app register a carrier service?
      instructions:
      - text: Create a carrier service with the 2020-10 Admin API.
      - text: Register a new carrier service to return shipping rates, API 2020-10.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/carrier_services/{carrier_service_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one carrier service (2020-10 API)
      effect: read
      questions:
      - How can I inspect a particular carrier service's setup using the 2020-10 API?
      - What does the 2020-10 Admin API return for one carrier service?
      instructions:
      - text: Show me carrier service {service} on the 2020-10 API.
        slots:
          service: path.carrier_service_id
      - text: Read the configuration of carrier service {service}, API 2020-10.
        slots:
          service: path.carrier_service_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/carrier_services/{carrier_service_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a carrier service (2020-10 API)
      effect: write
      questions:
      - How can I update a carrier service my app created, using the 2020-10 API?
      - Does the 2020-10 Admin API support editing an existing carrier service?
      instructions:
      - text: Update carrier service {service} on the 2020-10 API.
        slots:
          service: path.carrier_service_id
      - text: Change the settings of existing carrier service {service}, version 2020-10.
        slots:
          service: path.carrier_service_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/carrier_services/{carrier_service_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a carrier service (2020-10 API)
      effect: destructive
      questions:
      - How can I get rid of an old carrier service with the 2020-10 API?
      - Does the 2020-10 Admin API let me delete a carrier service?
      instructions:
      - text: Remove carrier service {service} with the 2020-10 API.
        slots:
          service: path.carrier_service_id
      - text: Delete the obsolete carrier service {service}, API version 2020-10.
        slots:
          service: path.carrier_service_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/carrier_services.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List carrier services (2021-01 API)
      effect: read
      questions:
      - Can I pull the list of carrier services using the 2021-01 release?
      - What endpoint in 2021-01 enumerates the shop's carrier services?
      instructions:
      - text: Using 2021-01, list every carrier service.
      - text: Fetch all shipping carrier services defined on the 2021-01 release.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/carrier_services.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a carrier service (2021-01 API)
      effect: write
      questions:
      - Can I create a carrier service using the 2021-01 release?
      - Which 2021-01 endpoint adds a brand-new carrier service?
      instructions:
      - text: Using 2021-01, create a carrier service.
      - text: Stand up a new carrier service for rate calculation on the 2021-01 release.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/carrier_services/{carrier_service_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one carrier service (2021-01 API)
      effect: read
      questions:
      - Can I retrieve just one carrier service in the 2021-01 release?
      - Which endpoint in 2021-01 gives me a single carrier service by ID?
      instructions:
      - text: Using 2021-01, fetch carrier service {service}.
        slots:
          service: path.carrier_service_id
      - text: Display carrier service {service} on the 2021-01 release.
        slots:
          service: path.carrier_service_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/carrier_services/{carrier_service_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a carrier service (2021-01 API)
      effect: write
      questions:
      - Can I change an existing carrier service with the 2021-01 release?
      - Which 2021-01 endpoint edits a carrier service already in place?
      instructions:
      - text: With the 2021-01 release, edit carrier service {service}.
        slots:
          service: path.carrier_service_id
      - text: Overwrite the settings on carrier service {service} using 2021-01.
        slots:
          service: path.carrier_service_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/carrier_services/{carrier_service_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a carrier service (2021-01 API)
      effect: destructive
      questions:
      - Can I delete a carrier service using the 2021-01 release?
      - Which 2021-01 call permanently removes a carrier service?
      instructions:
      - text: Using 2021-01, delete carrier service {service}.
        slots:
          service: path.carrier_service_id
      - text: Take carrier service {service} out of the shop on the 2021-01 release.
        slots:
          service: path.carrier_service_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/carrier_services.json'].get
  update:
    x-apievangelist-phrasing:
      intent: List carrier services (unstable API)
      effect: read
      questions:
      - Is listing carrier services available on the unstable API?
      - How would I list all carrier services against the unstable version?
      instructions:
      - text: List carrier services on the unstable API version.
      - text: On the unstable release, show every carrier service in the shop.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/carrier_services.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a carrier service (unstable API)
      effect: write
      questions:
      - Is creating a carrier service possible on the unstable API?
      - How would I test registering a carrier service against the unstable release?
      instructions:
      - text: Create a carrier service on the unstable API version.
      - text: On the unstable version, register a new carrier service.
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/carrier_services/{carrier_service_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one carrier service (unstable API)
      effect: read
      questions:
      - Is reading a single carrier service available on the unstable API?
      - How would I get one carrier service by ID from the unstable version?
      instructions:
      - text: Retrieve carrier service {service} from the unstable API.
        slots:
          service: path.carrier_service_id
      - text: On the unstable version, look up carrier service {service}.
        slots:
          service: path.carrier_service_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/carrier_services/{carrier_service_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a carrier service (unstable API)
      effect: write
      questions:
      - Is there an unstable-version call to update a carrier service?
      - How would I edit an existing carrier service on the unstable Admin API?
      instructions:
      - text: Update carrier service {service} on the unstable version.
        slots:
          service: path.carrier_service_id
      - text: Via the unstable API, change existing carrier service {service}.
        slots:
          service: path.carrier_service_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/carrier_services/{carrier_service_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a carrier service (unstable API)
      effect: destructive
      questions:
      - Is removing a carrier service possible on the unstable API version?
      - How would I delete a carrier service against the unstable release?
      instructions:
      - text: Delete carrier service {service} on the unstable API.
        slots:
          service: path.carrier_service_id
      - text: On the unstable version, remove carrier service {service}.
        slots:
          service: path.carrier_service_id
      method: generated
      generated: '2026-09-24'