# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for 2026-07 Consignment Products API
  version: 1.0.0
extends: openapi/lightspeed-consignment-products-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: 5
- target: $.paths['/consignments/{consignment_id}/bulk'].post
  update:
    x-apievangelist-phrasing:
      intent: Bulk add or update consignment products
      effect: write
      questions:
      - How do I add or update many products on a stock order at once?
      - Is there a limit on how many consignment products to update in one bulk call?
      instructions:
      - text: Bulk add or update the products on consignment {consignment_id}.
        slots:
          consignment_id: path.consignment_id
      - text: Set counts and received quantities in bulk for consignment {consignment_id}.
        slots:
          consignment_id: path.consignment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/consignments/{consignment_id}/products'].get
  update:
    x-apievangelist-phrasing:
      intent: List products on a consignment
      effect: read
      questions:
      - Which products are on a particular stock order or transfer?
      - Can I page through the product lines of a consignment?
      instructions:
      - text: List the products on consignment {consignment_id}.
        slots:
          consignment_id: path.consignment_id
      - text: Show consignment {consignment_id} products, {page_size} per page.
        slots:
          consignment_id: path.consignment_id
          page_size: query.page_size
      method: generated
      generated: '2026-09-26'
- target: $.paths['/consignments/{consignment_id}/products'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a product to a consignment
      effect: write
      questions:
      - How do I add a single product to a supplier order?
      - Can I add products to a consignment that's already received or cancelled?
      instructions:
      - text: Add product {data} to consignment {consignment_id}.
        slots:
          data: requestBody.data
          consignment_id: path.consignment_id
      - text: Put one more product line on consignment {consignment_id}.
        slots:
          consignment_id: path.consignment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/consignments/{consignment_id}/products/{product_id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a product's quantity on a consignment
      effect: write
      questions:
      - How do I change the ordered count for one product on a stock order?
      - Can I record the received quantity for a product on a dispatched order?
      instructions:
      - text: Update product {product_id} on consignment {consignment_id} with {data}.
        slots:
          product_id: path.product_id
          consignment_id: path.consignment_id
          data: requestBody.data
      - text: Change the count of product {product_id} already on consignment {consignment_id}.
        slots:
          product_id: path.product_id
          consignment_id: path.consignment_id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/consignments/{consignment_id}/products/{product_id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a product from a consignment
      effect: destructive
      questions:
      - How do I take a product off a stock order?
      - Can I remove a product from a consignment once it's dispatched?
      instructions:
      - text: Remove product {product_id} from consignment {consignment_id}.
        slots:
          product_id: path.product_id
          consignment_id: path.consignment_id
      - text: Delete the line for product {product_id} on consignment {consignment_id}.
        slots:
          product_id: path.product_id
          consignment_id: path.consignment_id
      method: generated
      generated: '2026-09-26'