API Evangelist conversational phrasing for Admin API V1 Order Lines API

# 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 Lines API
  version: 1.0.0
extends: openapi/optimizely-order-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: 10
- target: $.paths['/api/v1/admin/OrderLines'].get
  update:
    x-apievangelist-phrasing:
      intent: List order lines
      effect: read
      questions:
      - What line items are on my customer orders in Optimizely Commerce?
      - Can I filter order lines by status or product?
      instructions:
      - text: List all order lines.
      - text: List order lines where {filter}, sorted by {orderby}.
        slots:
          filter: query.$filter
          orderby: query.$orderby
      - text: Return the first {top} order lines.
        slots:
          top: query.$top
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/OrderLines'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a line to a customer order
      effect: write
      questions:
      - How do I add a new product line to an existing customer order?
      - Can I set quantity and unit price when creating an order line?
      instructions:
      - text: Add product {productId} to order {customerOrderId} with quantity {qtyOrdered}.
        slots:
          productId: requestBody.productId
          customerOrderId: requestBody.customerOrderId
          qtyOrdered: requestBody.qtyOrdered
      - text: Create an order line on order {customerOrderId} at unit net price {unitNetPrice} per {unitOfMeasure}.
        slots:
          customerOrderId: requestBody.customerOrderId
          unitNetPrice: requestBody.unitNetPrice
          unitOfMeasure: requestBody.unitOfMeasure
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/OrderLines({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an order line by id
      effect: read
      questions:
      - Can I look up a single order line and its pricing by id?
      - How many units of one order line have shipped?
      instructions:
      - text: Get order line {id}.
        slots:
          id: path.id
      - text: Fetch order line {id} with {expand} expanded.
        slots:
          id: path.id
          expand: query.$expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/OrderLines({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an order line
      effect: write
      questions:
      - How do I overwrite every field of an order line in one call?
      - What does fully replacing an order line record require?
      instructions:
      - text: Replace order line {id} with status {status} and quantity {qtyOrdered}.
        slots:
          id: path.id
          status: requestBody.status
          qtyOrdered: requestBody.qtyOrdered
      - text: Overwrite the full order line record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/OrderLines({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an order line
      effect: destructive
      questions:
      - Can I remove one line item from an order by its id?
      - Does deleting a single order line accept an If-Match ETag?
      instructions:
      - text: Delete order line {id}.
        slots:
          id: path.id
      - text: Delete order line {id} only if its ETag is {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/OrderLines({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update fields on an order line
      effect: write
      questions:
      - How do I change just the quantity on an existing order line?
      - Can I update an order line's promise date without resending everything?
      instructions:
      - text: Change the quantity on order line {id} to {qtyOrdered}.
        slots:
          id: path.id
          qtyOrdered: requestBody.qtyOrdered
      - text: Set the promise date of order line {id} to {promiseDate}.
        slots:
          id: path.id
          promiseDate: requestBody.promiseDate
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/OrderLines/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a blank order line template
      effect: read
      questions:
      - What default values does a new order line start with?
      - Is there an empty order line template to fill in?
      instructions:
      - text: Get the default order line template.
      - text: Show the defaults for a new order line.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/orderlines/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete order lines
      effect: destructive
      questions:
      - Can I delete several order lines by id in one request?
      - How do I clear a batch of order line items at once?
      instructions:
      - text: Bulk delete order lines {ids}.
        slots:
          ids: query.ids
      - text: Remove the order lines with ids {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/orderlines({key})/customerorderpromotions({customerorderpromotionKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a promotion applied to an order line
      effect: read
      questions:
      - Which promotion was applied to a specific order line?
      - Can I read one order promotion through the line it discounted?
      instructions:
      - text: Get order promotion {customerorderpromotionKey} on order line {key}.
        slots:
          customerorderpromotionKey: path.customerorderpromotionKey
          key: path.key
      - text: Show promotion {customerorderpromotionKey} applied to line {key} with {expand} expanded.
        slots:
          customerorderpromotionKey: path.customerorderpromotionKey
          key: path.key
          expand: query.$expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/orderlines({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property of an order line
      effect: read
      questions:
      - What custom property values are stored on an order line?
      - Can I read one extension field from an order line?
      instructions:
      - text: Get custom property {custompropertyKey} of order line {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Read custom field {custompropertyKey} on order line {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      method: generated
      generated: '2026-09-26'