# 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 Shipment Packages API
  version: 1.0.0
extends: openapi/optimizely-shipment-packages-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: 10
- target: $.paths['/api/v1/admin/ShipmentPackages'].get
  update:
    x-apievangelist-phrasing:
      intent: List shipment packages
      effect: read
      questions:
      - Which packages have been recorded against my shipments?
      - Can I filter shipment packages by tracking number?
      - How many shipment package records exist in the commerce admin?
      instructions:
      - text: List all shipment packages.
      - text: List shipment packages matching {filter}.
        slots:
          filter: query.$filter
      - text: Show the first {top} shipment packages sorted by {orderby}.
        slots:
          top: query.$top
          orderby: query.$orderby
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ShipmentPackages'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a package to a shipment
      effect: write
      questions:
      - How do I record a new package with its carrier and tracking number?
      - Can I add freight cost when creating a shipment package?
      instructions:
      - text: Add package {packageNumber} shipped by {carrier} via {shipVia} with tracking number {trackingNumber}.
        slots:
          packageNumber: requestBody.packageNumber
          carrier: requestBody.carrier
          shipVia: requestBody.shipVia
          trackingNumber: requestBody.trackingNumber
      - text: Create a package on shipment {shipmentId} with tracking {trackingNumber}.
        slots:
          shipmentId: requestBody.shipmentId
          trackingNumber: requestBody.trackingNumber
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ShipmentPackages({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a shipment package
      effect: read
      questions:
      - What tracking number and carrier does a specific package have?
      - Can I look up one shipment package by its ID?
      instructions:
      - text: Get shipment package {id}.
        slots:
          id: path.id
      - text: Show the tracking details of package {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ShipmentPackages({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a shipment package
      effect: write
      questions:
      - How do I overwrite a shipment package record entirely?
      - Does replacing a package reset the fields I omit?
      instructions:
      - text: Replace shipment package {id} with package number {packageNumber}, carrier {carrier}, ship via {shipVia} and tracking {trackingNumber}.
        slots:
          id: path.id
          packageNumber: requestBody.packageNumber
          carrier: requestBody.carrier
          shipVia: requestBody.shipVia
          trackingNumber: requestBody.trackingNumber
      - text: Overwrite all fields of shipment package {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ShipmentPackages({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a shipment package
      effect: destructive
      questions:
      - Can I delete one package from a shipment by its ID?
      - Is it possible to delete a package only if its ETag matches?
      instructions:
      - text: Delete shipment package {id}.
        slots:
          id: path.id
      - text: Delete shipment package {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/ShipmentPackages({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a shipment package
      effect: write
      questions:
      - How do I correct the tracking number on an existing package?
      - Can I update just the freight on a shipment package?
      instructions:
      - text: Change the tracking number of package {id} to {trackingNumber}.
        slots:
          id: path.id
          trackingNumber: requestBody.trackingNumber
      - text: Set the freight on shipment package {id} to {freight}.
        slots:
          id: path.id
          freight: requestBody.freight
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ShipmentPackages/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a blank shipment package template
      effect: read
      questions:
      - What default values does a new shipment package have?
      - Can I fetch an empty shipment package template?
      instructions:
      - text: Fetch the default shipment package template.
      - text: Show the starting values for a new shipment package.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/shipmentpackages/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete shipment packages
      effect: destructive
      questions:
      - Can I delete several shipment packages at once?
      - How do I remove a batch of packages by ID?
      instructions:
      - text: Bulk delete shipment packages {ids}.
        slots:
          ids: query.ids
      - text: 'Remove these shipment packages together: {ids}.'
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/shipmentpackages({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on a shipment package
      effect: read
      questions:
      - Can I read a custom property stored on a shipment package?
      - What extra custom values does a package record carry?
      instructions:
      - text: Get custom property {custompropertyKey} on shipment package {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show package {key}'s custom property {custompropertyKey}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/shipmentpackages({key})/shipmentpackagelines({shipmentpackagelineKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a line item inside a shipment package
      effect: read
      questions:
      - Which items were packed into a particular shipment package?
      - Can I look up one package line within a shipment package?
      instructions:
      - text: Get package line {shipmentpackagelineKey} in shipment package {key}.
        slots:
          shipmentpackagelineKey: path.shipmentpackagelineKey
          key: path.key
      - text: Show line {shipmentpackagelineKey} packed in package {key}.
        slots:
          shipmentpackagelineKey: path.shipmentpackagelineKey
          key: path.key
      method: generated
      generated: '2026-09-26'