# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Avalara AvaTax Upcs API
  version: 1.0.0
extends: openapi/avalara-upcs-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 6
- target: $.paths['/api/v2/companies/{companyId}/upcs'].get
  update:
    x-apievangelist-phrasing:
      intent: List a company's UPC codes
      effect: read
      questions:
      - Which UPC codes are mapped to tax codes for my company?
      - Can I filter one company's UPC catalog?
      instructions:
      - text: List UPCs for company {companyId}.
        slots:
          companyId: path.companyId
      - text: Show the UPC-to-tax-code mappings of company {companyId}.
        slots:
          companyId: path.companyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/companies/{companyId}/upcs'].post
  update:
    x-apievangelist-phrasing:
      intent: Add UPC codes to a company
      effect: write
      questions:
      - How do I map a product's UPC to a tax code?
      - Can I add many UPCs in one call?
      instructions:
      - text: Create UPCs for company {companyId}.
        slots:
          companyId: path.companyId
      - text: Add new UPC codes to the catalog of company {companyId}.
        slots:
          companyId: path.companyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/companies/{companyId}/upcs/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one UPC record
      effect: read
      questions:
      - Can I look up a single UPC record by ID?
      - Which tax code is a particular UPC matched to?
      instructions:
      - text: Get UPC {id} of company {companyId}.
        slots:
          id: path.id
          companyId: path.companyId
      - text: Show UPC record {id} in company {companyId}.
        slots:
          id: path.id
          companyId: path.companyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/companies/{companyId}/upcs/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a UPC record
      effect: write
      questions:
      - How do I change the tax code a UPC maps to?
      - Does updating a UPC replace the whole record?
      instructions:
      - text: Update UPC {id} for company {companyId}.
        slots:
          id: path.id
          companyId: path.companyId
      - text: Replace UPC record {id} in company {companyId}.
        slots:
          id: path.id
          companyId: path.companyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/companies/{companyId}/upcs/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a UPC record
      effect: destructive
      questions:
      - How do I remove a UPC from my company's catalog?
      - Is a deleted UPC marked deleted rather than erased?
      instructions:
      - text: Delete UPC {id} from company {companyId}.
        slots:
          id: path.id
          companyId: path.companyId
      - text: Mark UPC record {id} of company {companyId} as deleted.
        slots:
          id: path.id
          companyId: path.companyId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v2/upcs'].get
  update:
    x-apievangelist-phrasing:
      intent: Query UPCs across all companies
      effect: read
      questions:
      - Can I search UPC codes across every company?
      - Which companies have a particular UPC in their catalog?
      instructions:
      - text: Query UPCs across all companies.
      - text: Search every company's UPC catalog.
      method: generated
      generated: '2026-10-01'