# 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 Promotion Codes API
  version: 1.0.0
extends: openapi/optimizely-order-promotion-codes-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/OrderPromotionCodes'].get
  update:
    x-apievangelist-phrasing:
      intent: List promotion codes applied to orders
      effect: read
      questions:
      - How can I see which promotion codes were used on orders?
      - Can I filter order promotion codes to one specific code?
      instructions:
      - text: List all order promotion codes.
      - text: List order promotion codes matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/OrderPromotionCodes'].post
  update:
    x-apievangelist-phrasing:
      intent: Apply a promotion code to an order
      effect: write
      questions:
      - How do I attach a promo code to a customer order?
      - What is required to record an order promotion code?
      instructions:
      - text: Apply promotion code {code} to order {customerOrderId}.
        slots:
          code: requestBody.code
          customerOrderId: requestBody.customerOrderId
      - text: Record promo code {code} on an order.
        slots:
          code: requestBody.code
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/OrderPromotionCodes({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one order promotion code
      effect: read
      questions:
      - How can I look up a single order promotion code record?
      - Which order does a given promotion code record belong to?
      instructions:
      - text: Show order promotion code {id}.
        slots:
          id: path.id
      - text: Fetch {select} for order promotion code {id}.
        slots:
          id: path.id
          select: query.$select
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/OrderPromotionCodes({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace an order promotion code
      effect: write
      questions:
      - How do I overwrite an order promotion code record completely?
      - Does replacing an order promo code record clear the order link if omitted?
      instructions:
      - text: Replace order promotion code {id} with code {code}.
        slots:
          id: path.id
          code: requestBody.code
      - text: Overwrite the full order promotion code record {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/OrderPromotionCodes({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a promotion code from an order
      effect: destructive
      questions:
      - How do I delete one promo code record from an order?
      - Can I guard removing an order promotion code with an ETag?
      instructions:
      - text: Delete order promotion code {id}.
        slots:
          id: path.id
      - text: Remove order promotion code {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/OrderPromotionCodes({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update an order promotion code
      effect: write
      questions:
      - How can I correct a mistyped promo code on an order?
      - Can I move a promotion code record to a different order?
      instructions:
      - text: Change the code on order promotion code {id} to {code}.
        slots:
          id: path.id
          code: requestBody.code
      - text: Reassign order promotion code {id} to order {customerOrderId}.
        slots:
          id: path.id
          customerOrderId: requestBody.customerOrderId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/OrderPromotionCodes/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get defaults for a new order promotion code
      effect: read
      questions:
      - What default values does a new order promotion code record have?
      - Where do I get a blank order promotion code template?
      instructions:
      - text: Fetch the default order promotion code template.
      - text: Show starting values for a new order promo code record.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/orderpromotioncodes/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete order promotion codes
      effect: destructive
      questions:
      - How do I delete several order promotion code records at once?
      - Can I pass a list of ids to remove promo codes from orders?
      instructions:
      - text: Bulk delete order promotion codes {ids}.
        slots:
          ids: query.ids
      - text: Permanently delete every order promo code record in {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/orderpromotioncodes({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a custom property of an order promotion code
      effect: read
      questions:
      - Where can I read a custom property on an order promotion code?
      - How do I fetch one custom attribute from an order promo code record?
      instructions:
      - text: Get custom property {custompropertyKey} of order promotion code {key}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      - text: Read custom field {custompropertyKey} on order promo code {key}.
        slots:
          key: path.key
          custompropertyKey: path.custompropertyKey
      method: generated
      generated: '2026-09-26'