# 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 Ship To Address Fields API
  version: 1.0.0
extends: openapi/optimizely-ship-to-address-fields-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/ShipToAddressFields'].get
  update:
    x-apievangelist-phrasing:
      intent: List ship-to address fields
      effect: read
      questions:
      - Which fields appear on the shipping address form at checkout?
      - Can I list only the visible ship-to address fields for a website?
      instructions:
      - text: List all ship-to address fields.
      - text: List ship-to address fields matching {filter}.
        slots:
          filter: query.$filter
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ShipToAddressFields'].post
  update:
    x-apievangelist-phrasing:
      intent: Add a ship-to address field
      effect: write
      questions:
      - How do I add a new field to the shipping address form?
      - Can I make a new ship-to field required with a maximum length?
      instructions:
      - text: Add ship-to field {fieldName} displayed as {displayName}.
        slots:
          fieldName: requestBody.fieldName
          displayName: requestBody.displayName
      - text: Create shipping address field {fieldName} labeled {displayName}, required {isRequired}, max length {maxFieldLength}.
        slots:
          fieldName: requestBody.fieldName
          displayName: requestBody.displayName
          isRequired: requestBody.isRequired
          maxFieldLength: requestBody.maxFieldLength
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ShipToAddressFields({id})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a ship-to address field
      effect: read
      questions:
      - How do I read the settings of one shipping address field?
      - Is a particular ship-to field required and visible?
      instructions:
      - text: Get ship-to address field {id}.
        slots:
          id: path.id
      - text: Show whether shipping field {id} is required and visible.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ShipToAddressFields({id})'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace a ship-to address field
      effect: write
      questions:
      - How do I overwrite a shipping address field definition completely?
      - Do I need to resend the field name when replacing a ship-to field?
      instructions:
      - text: Replace ship-to field {id} with name {fieldName} and label {displayName}.
        slots:
          id: path.id
          fieldName: requestBody.fieldName
          displayName: requestBody.displayName
      - text: Overwrite shipping address field {id} in full for website {websiteId}.
        slots:
          id: path.id
          websiteId: requestBody.websiteId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ShipToAddressFields({id})'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a ship-to address field
      effect: destructive
      questions:
      - How do I remove a field from the shipping address form?
      - Can I delete a ship-to field only if its ETag still matches?
      instructions:
      - text: Delete ship-to address field {id}.
        slots:
          id: path.id
      - text: Delete shipping field {id} if ETag is {etag}.
        slots:
          id: path.id
          etag: header.If-Match
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ShipToAddressFields({id})'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update a ship-to address field
      effect: write
      questions:
      - How do I hide a shipping address field without deleting it?
      - Can I change the maximum length allowed on a ship-to field?
      instructions:
      - text: Set visibility of ship-to field {id} to {isVisible}.
        slots:
          id: path.id
          isVisible: requestBody.isVisible
      - text: Set max length of shipping field {id} to {maxFieldLength}.
        slots:
          id: path.id
          maxFieldLength: requestBody.maxFieldLength
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/ShipToAddressFields/Default.Default()'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the default ship-to field template
      effect: read
      questions:
      - What are the default settings for a new shipping address field?
      - Where do I get a blank ship-to address field record?
      instructions:
      - text: Get the default ship-to address field template.
      - text: Show default values for a new shipping address field.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/shiptoaddressfields/delete'].delete
  update:
    x-apievangelist-phrasing:
      intent: Bulk delete ship-to address fields
      effect: destructive
      questions:
      - How do I remove several shipping address fields at once?
      - Can I bulk delete ship-to fields by id?
      instructions:
      - text: Delete ship-to address fields {ids}.
        slots:
          ids: query.ids
      - text: Bulk remove shipping address fields {ids}.
        slots:
          ids: query.ids
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/admin/shiptoaddressfields({key})/customproperties({custompropertyKey})'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a ship-to field custom property
      effect: read
      questions:
      - How do I read a custom property on a shipping address field?
      - Where is one custom property value for a ship-to field?
      instructions:
      - text: Get custom property {custompropertyKey} of ship-to field {key}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      - text: Show shipping address field {key}'s custom property {custompropertyKey}.
        slots:
          custompropertyKey: path.custompropertyKey
          key: path.key
      method: generated
      generated: '2026-09-26'