# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Commerce Price Books Items API
  version: 1.0.0
extends: openapi/hubspot-items-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-24'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/commerce/price-books/2026-09/price-books/{priceBookId}/items'].get
  update:
    x-apievangelist-phrasing:
      intent: List the items in a price book
      effect: read
      questions:
      - Which products are in a given price book?
      - Can I choose which properties come back when listing price book items?
      instructions:
      - text: List the items in price book {priceBookId}.
        slots:
          priceBookId: path.priceBookId
      - text: Show items in price book {priceBookId} with properties {properties}.
        slots:
          priceBookId: path.priceBookId
          properties: query.properties
      method: generated
      generated: '2026-09-24'
- target: $.paths['/commerce/price-books/2026-09/price-books/{priceBookId}/items'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a product to a price book
      effect: write
      questions:
      - How do I add a product to one of my price books?
      - What do I need to put a product into a price book?
      instructions:
      - text: Add product {productId} to price book {priceBookId}.
        slots:
          productId: requestBody.productId
          priceBookId: path.priceBookId
      - text: Put product {productId} into price book {priceBookId} as a new item.
        slots:
          productId: requestBody.productId
          priceBookId: path.priceBookId
      method: generated
      generated: '2026-09-24'
- target: $.paths['/commerce/price-books/2026-09/price-books/{priceBookId}/items/{priceBookItemId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one price book item
      effect: read
      questions:
      - How do I see the pricing details of one item in a price book?
      - Can I retrieve a price book item that has been archived?
      instructions:
      - text: Get item {priceBookItemId} from price book {priceBookId}.
        slots:
          priceBookItemId: path.priceBookItemId
          priceBookId: path.priceBookId
      - text: Show the details of price book item {priceBookItemId} in {priceBookId}.
        slots:
          priceBookItemId: path.priceBookItemId
          priceBookId: path.priceBookId
      method: generated
      generated: '2026-09-24'
- target: $.paths['/commerce/price-books/2026-09/price-books/{priceBookId}/items/{priceBookItemId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove an item from a price book
      effect: destructive
      questions:
      - How do I take a product out of a price book?
      - Is removing a price book item permanent?
      instructions:
      - text: Delete item {priceBookItemId} from price book {priceBookId}.
        slots:
          priceBookItemId: path.priceBookItemId
          priceBookId: path.priceBookId
      - text: Permanently remove {priceBookItemId} from price book {priceBookId}.
        slots:
          priceBookItemId: path.priceBookItemId
          priceBookId: path.priceBookId
      method: generated
      generated: '2026-09-24'
- target: $.paths['/commerce/price-books/2026-09/price-books/{priceBookId}/items/{priceBookItemId}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a price book item
      effect: write
      questions:
      - Can I change the price or billing frequency of an item already in a price book?
      - How do I set custom properties on a price book item?
      instructions:
      - text: Update pricing on item {priceBookItemId} in price book {priceBookId} to {pricing}.
        slots:
          priceBookItemId: path.priceBookItemId
          priceBookId: path.priceBookId
          pricing: requestBody.pricing
      - text: Change the billing frequency of item {priceBookItemId} in {priceBookId} to {billingFrequency}.
        slots:
          priceBookItemId: path.priceBookItemId
          priceBookId: path.priceBookId
          billingFrequency: requestBody.billingFrequency
      method: generated
      generated: '2026-09-24'