# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Avalara Shipping Verification API
  version: 1.0.0
extends: openapi/avalara-shipping-verification-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: 4
- target: $.paths['/api/v2/companies/{companyCode}/transactions/{transactionCode}/shipment/registration'].put
  update:
    x-apievangelist-phrasing:
      intent: Register a shipment for multi-transaction rules
      effect: write
      questions:
      - How do I make a transaction count toward shipping limits that span multiple orders?
      - Can I register a shipment without checking compliance first?
      instructions:
      - text: Register the shipment for transaction {transactionCode} in company {companyCode}.
        slots:
          transactionCode: path.transactionCode
          companyCode: path.companyCode
      - text: Register {documentType} {transactionCode} of company {companyCode} for cross-transaction rules.
        slots:
          documentType: query.documentType
          transactionCode: path.transactionCode
          companyCode: path.companyCode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/companies/{companyCode}/transactions/{transactionCode}/shipment/registration'].delete
  update:
    x-apievangelist-phrasing:
      intent: Deregister a shipment
      effect: destructive
      questions:
      - Can I remove a transaction from shipping regulation volume tracking?
      - What if a registered shipment was cancelled and shouldn't count toward limits?
      instructions:
      - text: Deregister the shipment for transaction {transactionCode} in company {companyCode}.
        slots:
          transactionCode: path.transactionCode
          companyCode: path.companyCode
      - text: Remove {transactionCode} from company {companyCode}'s shipment registrations.
        slots:
          transactionCode: path.transactionCode
          companyCode: path.companyCode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/companies/{companyCode}/transactions/{transactionCode}/shipment/registerIfCompliant'].put
  update:
    x-apievangelist-phrasing:
      intent: Register a shipment only if compliant
      effect: write
      questions:
      - Can I check compliance and register a shipment in one step?
      - Is there a way to only register an alcohol shipment if it passes the rules?
      instructions:
      - text: Register transaction {transactionCode} in company {companyCode} only if it's compliant.
        slots:
          transactionCode: path.transactionCode
          companyCode: path.companyCode
      - text: Verify and register {documentType} {transactionCode} for {companyCode} if it passes.
        slots:
          documentType: query.documentType
          transactionCode: path.transactionCode
          companyCode: path.companyCode
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v2/companies/{companyCode}/transactions/{transactionCode}/shipment/verify'].get
  update:
    x-apievangelist-phrasing:
      intent: Check a shipment against DTC shipping rules
      effect: read
      questions:
      - Can I ship this wine order direct to the consumer in their state?
      - What does a transaction need before direct-to-consumer shipping rules can be evaluated?
      instructions:
      - text: Verify shipping compliance for transaction {transactionCode} in company {companyCode}.
        slots:
          transactionCode: path.transactionCode
          companyCode: path.companyCode
      - text: Check whether {documentType} {transactionCode} of {companyCode} meets DTC shipping regulations without registering it.
        slots:
          documentType: query.documentType
          transactionCode: path.transactionCode
          companyCode: path.companyCode
      method: generated
      generated: '2026-09-26'