# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Admin API V1 Order History Lines API
  version: 1.0.0
extends: openapi/optimizely-order-history-lines-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: 9
- target: $.paths['/api/v1/admin/OrderHistoryLines'].get
  update:
    x-apievangelist-phrasing:
      intent: List order history lines
      effect: read
      questions:
      - What line items are recorded in past orders from the ERP?
      - Can I filter order history lines by product ERP number or status?
      instructions:
      - text: List all order history lines.
      - text: List order history lines matching {filter}, top {top}.
        slots:
          filter: query.$filter
          top: query.$top
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/OrderHistoryLines'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a line to an order history record
      effect: write
      questions:
      - How do I add a line item to a historical order imported from the ERP?
      - What fields are required for a new order history line?
      instructions:
      - text: Add a line for product {productErpNumber} to order history {orderHistoryId}, qty {qtyOrdered}.
        slots:
          productErpNumber: requestBody.productErpNumber
          orderHistoryId: requestBody.orderHistoryId
          qtyOrdered: requestBody.qtyOrdered
      - text: Create order history line {lineNumber} for customer {customerNumber} with status {status} at net price {unitNetPrice}.
        slots:
          lineNumber: requestBody.lineNumber
          customerNumber: requestBody.customerNumber
          status: requestBody.status
          unitNetPrice: requestBody.unitNetPrice
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/OrderHistoryLines({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an order history line
      effect: read
      questions:
      - How do I see the quantities and pricing on one historical order line?
      - How much of a specific order line was actually shipped?
      instructions:
      - text: Get order history line {id}.
        slots:
          id: path.id
      - text: Show shipped vs ordered quantity for order line {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/OrderHistoryLines({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an order history line
      effect: write
      questions:
      - How do I overwrite an entire historical order line from the ERP?
      - Does replacing an order history line need every required field again?
      instructions:
      - text: Replace order history line {id} for product {productErpNumber} with status {status}.
        slots:
          id: path.id
          productErpNumber: requestBody.productErpNumber
          status: requestBody.status
      - text: Fully overwrite order line {id} with quantity ordered {qtyOrdered} and shipped {qtyShipped}.
        slots:
          id: path.id
          qtyOrdered: requestBody.qtyOrdered
          qtyShipped: requestBody.qtyShipped
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/OrderHistoryLines({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an order history line
      effect: destructive
      questions:
      - How do I remove a line from a historical order?
      - Can I delete an order history line only if its ETag still matches?
      instructions:
      - text: Delete order history line {id}.
        slots:
          id: path.id
      - text: Delete order history line {id} if its ETag is {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/OrderHistoryLines({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an order history line
      effect: write
      questions:
      - How do I update the shipped quantity on a past order line?
      - Can I change just the status of an order history line?
      instructions:
      - text: Set shipped quantity of order line {id} to {qtyShipped}.
        slots:
          id: path.id
          qtyShipped: requestBody.qtyShipped
      - text: Change status of order history line {id} to {status}.
        slots:
          id: path.id
          status: requestBody.status
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/OrderHistoryLines/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the default order history line template
      effect: read
      questions:
      - What default values does a new order history line start with?
      - Where can I get a blank order history line record?
      instructions:
      - text: Get the default order history line template.
      - text: Show default values for a new order history line.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/orderhistorylines/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete order history lines
      effect: destructive
      questions:
      - How do I delete many order history lines at once?
      - Can I remove a batch of historical order lines by id?
      instructions:
      - text: Delete order history lines {ids}.
        slots:
          ids: query.ids
      - text: Bulk remove order history lines {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/orderhistorylines({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an order history line custom property
      effect: read
      questions:
      - How do I read a custom property on an order history line?
      - Where is one custom property value for a historical order line?
      instructions:
      - text: Get custom property {custompropertyKey} of order history line {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show order history line {key}'s custom property {custompropertyKey}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      method: generated
      generated: '2026-09-26'