Conga · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Administration Price Lists API

26 actions 26 updates phrasing extends openapi/conga-price-lists-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Conga's API. It is a proposal applied on top of the contract, not a document Conga publishes.
View Overlay File View on GitHub Overlay Specification
What the actions change

x-apievangelist-phrasing
Targets 26 · first 16 shown; the file carries all of them

$.info
$.paths['/price-lists'].get
$.paths['/price-lists'].post
$.paths['/price-lists'].delete
$.paths['/price-lists'].patch
$.paths['/price-lists/{Id}'].get
$.paths['/price-lists/{Id}'].delete
$.paths['/price-lists/{Id}'].patch
$.paths['/price-lists/{id}/products'].get
$.paths['/price-lists/{parentId}/price-list-categories'].get
$.paths['/price-lists/{parentId}/price-list-categories'].post
$.paths['/price-lists/{parentId}/price-list-categories'].delete
$.paths['/price-lists/{parentId}/price-list-categories'].patch
$.paths['/price-lists/{parentId}/price-list-categories/{id}'].get
$.paths['/price-lists/{parentId}/price-list-categories/{id}'].delete
$.paths['/price-lists/{parentId}/price-list-categories/{id}'].patch
OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Administration Price Lists API
  version: 1.0.0
extends: openapi/conga-price-lists-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: 25
- target: $.paths['/price-lists'].get
  update:
    x-apievangelist-phrasing:
      intent: List price lists
      effect: read
      questions:
      - Which price lists do we have?
      - Can I filter or page through price lists?
      instructions:
      - text: List all price lists.
      - text: List price lists matching {filter}.
        slots:
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/price-lists'].post
  update:
    x-apievangelist-phrasing:
      intent: Create price lists
      effect: write
      questions:
      - How do I create a new price list?
      - Can I create several price lists at once?
      instructions:
      - text: Create new price lists.
      - text: Add a batch of price lists.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/price-lists'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete price lists in bulk
      effect: destructive
      questions:
      - Can I delete several price lists at once?
      - How do I bulk-remove price lists?
      instructions:
      - text: Bulk delete the selected price lists.
      - text: Remove many price lists in one call.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/price-lists'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update price lists in bulk
      effect: write
      questions:
      - Can I edit multiple price lists in one request?
      - How do I bulk-update price lists?
      instructions:
      - text: Bulk update the selected price lists.
      - text: Edit several price lists at once.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/price-lists/{Id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a price list
      effect: read
      questions:
      - Where can I see one price list's details?
      - Can I include related records when fetching a price list?
      instructions:
      - text: Get price list {id}.
        slots:
          id: path.Id
      - text: Show price list {id} including {includes}.
        slots:
          id: path.Id
          includes: query.includes
      method: generated
      generated: '2026-10-01'
- target: $.paths['/price-lists/{Id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a price list
      effect: destructive
      questions:
      - Can I delete a single price list?
      - What happens when one price list is removed?
      instructions:
      - text: Delete price list {id}.
        slots:
          id: path.Id
      - text: Remove only the price list {id}.
        slots:
          id: path.Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/price-lists/{Id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a price list
      effect: write
      questions:
      - How do I edit one price list?
      - Can I change a single price list's currency?
      instructions:
      - text: Update price list {id}.
        slots:
          id: path.Id
      - text: Edit only the price list {id}.
        slots:
          id: path.Id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/price-lists/{id}/products'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up products available for a price list
      effect: read
      questions:
      - Which product lookup records can I pick for a price list?
      - Can I page through products available to a price list?
      instructions:
      - text: Look up products for price list {id}.
        slots:
          id: path.id
      - text: Show page {page} of product lookups for price list {id}.
        slots:
          page: query.page
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/price-lists/{parentId}/price-list-categories'].get
  update:
    x-apievangelist-phrasing:
      intent: List a price list's categories
      effect: read
      questions:
      - Which categories are assigned to a price list?
      - Can I filter the categories of a price list?
      instructions:
      - text: List price list categories of {pl}.
        slots:
          pl: path.parentId
      - text: Show categories assigned to {pl} matching {filter}.
        slots:
          pl: path.parentId
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/price-lists/{parentId}/price-list-categories'].post
  update:
    x-apievangelist-phrasing:
      intent: Add categories to a price list
      effect: write
      questions:
      - How do I assign categories to a price list?
      - Can I add several categories to a price list at once?
      instructions:
      - text: Create price list categories on {pl}.
        slots:
          pl: path.parentId
      - text: Assign new categories to price list {pl}.
        slots:
          pl: path.parentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/price-lists/{parentId}/price-list-categories'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove price list categories in bulk
      effect: destructive
      questions:
      - Can I remove many categories from a price list?
      - How do I bulk-delete a price list's categories?
      instructions:
      - text: Bulk delete price list categories on {pl}.
        slots:
          pl: path.parentId
      - text: Remove the selected categories from price list {pl}.
        slots:
          pl: path.parentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/price-lists/{parentId}/price-list-categories'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update price list categories in bulk
      effect: write
      questions:
      - Can I edit several price list categories at once?
      - How do I bulk-update the categories on a price list?
      instructions:
      - text: Bulk update price list categories on {pl}.
        slots:
          pl: path.parentId
      - text: Edit the selected categories of price list {pl}.
        slots:
          pl: path.parentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/price-lists/{parentId}/price-list-categories/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a price list category
      effect: read
      questions:
      - Where do I see one category assignment on a price list?
      - What does a single price list category record show?
      instructions:
      - text: Get price list category {id} on {pl}.
        slots:
          id: path.id
          pl: path.parentId
      - text: Show category assignment {id} of price list {pl}.
        slots:
          id: path.id
          pl: path.parentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/price-lists/{parentId}/price-list-categories/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a price list category
      effect: destructive
      questions:
      - Can I remove one category from a price list?
      - How do I delete a single category assignment?
      instructions:
      - text: Delete price list category {id} from {pl}.
        slots:
          id: path.id
          pl: path.parentId
      - text: Remove only category assignment {id} on price list {pl}.
        slots:
          id: path.id
          pl: path.parentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/price-lists/{parentId}/price-list-categories/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a price list category
      effect: write
      questions:
      - How do I edit one category on a price list?
      - Can I change a single category assignment?
      instructions:
      - text: Update price list category {id} on {pl}.
        slots:
          id: path.id
          pl: path.parentId
      - text: Edit only category assignment {id} of price list {pl}.
        slots:
          id: path.id
          pl: path.parentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/price-lists/{parentId}/price-list-items'].get
  update:
    x-apievangelist-phrasing:
      intent: List price list items
      effect: read
      questions:
      - What products and prices are on a price list?
      - Can I filter the items on a price list?
      instructions:
      - text: List items on price list {pl}.
        slots:
          pl: path.parentId
      - text: Show price list items on {pl} matching {filter}.
        slots:
          pl: path.parentId
          filter: query.filter
      method: generated
      generated: '2026-10-01'
- target: $.paths['/price-lists/{parentId}/price-list-items'].post
  update:
    x-apievangelist-phrasing:
      intent: Add items to a price list
      effect: write
      questions:
      - How do I add product prices to a price list?
      - Can I add several price list items at once?
      instructions:
      - text: Create price list items on {pl}.
        slots:
          pl: path.parentId
      - text: Add new product prices to price list {pl}.
        slots:
          pl: path.parentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/price-lists/{parentId}/price-list-items'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove price list items in bulk
      effect: destructive
      questions:
      - Can I remove many items from a price list?
      - How do I bulk-delete price list items?
      instructions:
      - text: Bulk delete items on price list {pl}.
        slots:
          pl: path.parentId
      - text: Remove the selected product prices from {pl}.
        slots:
          pl: path.parentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/price-lists/{parentId}/price-list-items'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update price list items in bulk
      effect: write
      questions:
      - Can I change many prices on a price list at once?
      - How do I bulk-update price list items?
      instructions:
      - text: Bulk update items on price list {pl}.
        slots:
          pl: path.parentId
      - text: Edit the selected product prices on {pl}.
        slots:
          pl: path.parentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/price-lists/{parentId}/price-list-items/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a price list item
      effect: read
      questions:
      - Where can I see one product's price on a price list?
      - What does a single price list item contain?
      instructions:
      - text: Get price list item {id} on {pl}.
        slots:
          id: path.id
          pl: path.parentId
      - text: Show the product price {id} from price list {pl}.
        slots:
          id: path.id
          pl: path.parentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/price-lists/{parentId}/price-list-items/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a price list item
      effect: destructive
      questions:
      - Can I remove one product price from a price list?
      - How do I delete a single price list item?
      instructions:
      - text: Delete price list item {id} from {pl}.
        slots:
          id: path.id
          pl: path.parentId
      - text: Remove only product price {id} on price list {pl}.
        slots:
          id: path.id
          pl: path.parentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/price-lists/{parentId}/price-list-items/{id}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a price list item
      effect: write
      questions:
      - How do I change one product's price on a price list?
      - Can I edit a single price list item?
      instructions:
      - text: Update price list item {id} on {pl}.
        slots:
          id: path.id
          pl: path.parentId
      - text: Change only product price {id} of price list {pl}.
        slots:
          id: path.id
          pl: path.parentId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/price-lists/{parentId}/price-list-items/{id}/clone'].post
  update:
    x-apievangelist-phrasing:
      intent: Clone a price list item
      effect: write
      questions:
      - Can I copy a price list item to create a similar one?
      - Does cloning a price list item copy related objects too?
      instructions:
      - text: Clone price list item {id} on {pl}.
        slots:
          id: path.id
          pl: path.parentId
      - text: Deep clone item {id} of price list {pl} excluding {exclude}.
        slots:
          id: path.id
          pl: path.parentId
          exclude: query.excludeObjects
      method: generated
      generated: '2026-10-01'
- target: $.paths['/price-lists/{priceListId}/categories'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up category records for a price list
      effect: read
      questions:
      - Which category lookup records are available for a price list?
      - Can I page through the category picker records of a price list?
      instructions:
      - text: Look up category records for price list {pl}.
        slots:
          pl: path.priceListId
      - text: Show page {page} of category lookups for price list {pl}.
        slots:
          page: query.page
          pl: path.priceListId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/price-lists/active'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the active price list
      effect: read
      questions:
      - Which price list is active for an account or storefront?
      - How do I find the price list in effect for a storefront?
      instructions:
      - text: Get the active price list for account {account}.
        slots:
          account: header.accountId
      - text: Show the active price list for storefront {store}.
        slots:
          store: header.storeFrontId
      method: generated
      generated: '2026-10-01'