# 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 Customer Order Changes API
  version: 1.0.0
extends: openapi/optimizely-customer-order-changes-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/CustomerOrderChanges'].get
  update:
    x-apievangelist-phrasing:
      intent: List customer order change records
      effect: read
      questions:
      - Where can I see the history of changes made to customer orders?
      - Can I filter order changes to a single order to see quantity or price edits?
      instructions:
      - text: List customer order changes.
      - text: List order changes matching {filter}, newest first by {orderby}.
        slots:
          filter: query.$filter
          orderby: query.$orderby
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CustomerOrderChanges'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a change to a customer order
      effect: write
      questions:
      - How do I log that a product price or quantity changed on an order?
      - What old and new values does an order change record need?
      instructions:
      - text: Record a {type} change on order {customerOrderId} from {oldValue} to {newValue} in {unitOfMeasure}.
        slots:
          type: requestBody.type
          customerOrderId: requestBody.customerOrderId
          oldValue: requestBody.oldValue
          newValue: requestBody.newValue
          unitOfMeasure: requestBody.unitOfMeasure
      - text: Log a price change for product {productId} from {oldProductPrice} to {newProductPrice}.
        slots:
          productId: requestBody.productId
          oldProductPrice: requestBody.oldProductPrice
          newProductPrice: requestBody.newProductPrice
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CustomerOrderChanges({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a customer order change record
      effect: read
      questions:
      - Can I open one order change record by its id?
      - What were the old and new values in a specific order change?
      instructions:
      - text: Get customer order change {id}.
        slots:
          id: path.id
      - text: Show the before and after values of order change {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CustomerOrderChanges({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a customer order change record
      effect: write
      questions:
      - Is there a way to overwrite an order change record in full?
      - What must I resend to completely replace an order change entry?
      instructions:
      - text: Replace order change {id} with a {type} change from {oldValue} to {newValue}.
        slots:
          id: path.id
          type: requestBody.type
          oldValue: requestBody.oldValue
          newValue: requestBody.newValue
      - text: Overwrite the whole order change record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CustomerOrderChanges({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a customer order change record
      effect: destructive
      questions:
      - Can I delete one order change record by id?
      - Does removing a single order change honor an If-Match ETag?
      instructions:
      - text: Delete order change record {id}.
        slots:
          id: path.id
      - text: Delete order change {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/CustomerOrderChanges({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update fields on an order change record
      effect: write
      questions:
      - How do I fix just the new value on an order change entry?
      - Can I patch only the new product price on an order change?
      instructions:
      - text: Set the new value on order change {id} to {newValue}.
        slots:
          id: path.id
          newValue: requestBody.newValue
      - text: Correct the new product price on order change {id} to {newProductPrice}.
        slots:
          id: path.id
          newProductPrice: requestBody.newProductPrice
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/CustomerOrderChanges/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a blank order change template
      effect: read
      questions:
      - What default values does a new order change record start with?
      - Is there an empty order change template to fill in?
      instructions:
      - text: Get the default customer order change template.
      - text: Show starting values for a new order change record.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/customerorderchanges/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete order change records
      effect: destructive
      questions:
      - Can I delete many order change records at once?
      - Is there a bulk delete that takes a list of order change ids?
      instructions:
      - text: Bulk delete order change records {ids}.
        slots:
          ids: query.ids
      - text: 'Remove these order change entries in one call: {ids}.'
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/customerorderchanges({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property on an order change
      effect: read
      questions:
      - How can I read a custom property on an order change record?
      - Can extra metadata on an order change be fetched by property id?
      instructions:
      - text: Get custom property {custompropertyKey} on order change {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Read order change {key}'s custom field {custompropertyKey}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'