# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Admin API V1 Ship Charges API
  version: 1.0.0
extends: openapi/optimizely-ship-charges-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 9
- target: $.paths['/api/v1/admin/ShipCharges'].get
  update:
    x-apievangelist-phrasing:
      intent: List shipping charges
      effect: read
      questions:
      - What shipping charges are configured for my carriers and ship methods?
      - Can I list only enabled ship charges?
      instructions:
      - text: List all ship charges.
      - text: List ship charges where {filter}.
        slots:
          filter: query.$filter
      - text: Return ship charges sorted by {orderby}, first {top} only.
        slots:
          orderby: query.$orderby
          top: query.$top
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ShipCharges'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a shipping charge
      effect: write
      questions:
      - How do I add a flat shipping charge to a carrier's ship method?
      - Can I create a ship charge that starts out disabled?
      instructions:
      - text: Create ship charge {name} described as {description} for ship via {shipViaId}.
        slots:
          name: requestBody.name
          description: requestBody.description
          shipViaId: requestBody.shipViaId
      - text: Add ship charge {name} of {charge} for carrier {carrierId}.
        slots:
          name: requestBody.name
          charge: requestBody.charge
          carrierId: requestBody.carrierId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ShipCharges({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a shipping charge by id
      effect: read
      questions:
      - How much is a particular ship charge and is it enabled?
      - Can I look up one ship charge record by id?
      instructions:
      - text: Get ship charge {id}.
        slots:
          id: path.id
      - text: Fetch ship charge {id} with {expand} expanded.
        slots:
          id: path.id
          expand: query.$expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ShipCharges({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a shipping charge
      effect: write
      questions:
      - How do I overwrite every field of a ship charge at once?
      - What does a full replacement of a ship charge require?
      instructions:
      - text: Replace ship charge {id} with name {name}, description {description} and charge {charge}.
        slots:
          id: path.id
          name: requestBody.name
          description: requestBody.description
          charge: requestBody.charge
      - text: Overwrite the full ship charge record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ShipCharges({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a shipping charge
      effect: destructive
      questions:
      - Can I remove one ship charge by its id?
      - Does deleting a ship charge support an If-Match ETag?
      instructions:
      - text: Delete ship charge {id}.
        slots:
          id: path.id
      - text: Delete ship charge {id} if its ETag is {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ShipCharges({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Change the amount or status of a ship charge
      effect: write
      questions:
      - How do I raise the price of an existing ship charge?
      - Can I disable a ship charge without deleting it?
      instructions:
      - text: Set the charge on ship charge {id} to {charge}.
        slots:
          id: path.id
          charge: requestBody.charge
      - text: Set ship charge {id} enabled to {enable}.
        slots:
          id: path.id
          enable: requestBody.enable
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ShipCharges/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a blank ship charge template
      effect: read
      questions:
      - What default values does a new ship charge start with?
      - Is there an empty ship charge template to fill in?
      instructions:
      - text: Get the default ship charge template.
      - text: Show the defaults for a new ship charge.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/shipcharges/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete shipping charges
      effect: destructive
      questions:
      - Can I delete several ship charges in one request?
      - How do I remove a list of ship charges by id?
      instructions:
      - text: Bulk delete ship charges {ids}.
        slots:
          ids: query.ids
      - text: Remove the ship charges with ids {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/shipcharges({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property of a ship charge
      effect: read
      questions:
      - What custom property values are stored on a ship charge?
      - Can I read one extension field from a ship charge?
      instructions:
      - text: Get custom property {custompropertyKey} of ship charge {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Read custom field {custompropertyKey} on ship charge {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      method: generated
      generated: '2026-09-26'