# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Sales Orders Auxiliary Field Schema API
  version: 1.0.0
extends: openapi/vendasta-salesordersauxiliaryfieldschema-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 2
- target: $.paths['/v1/order/custom-fields/get'].post
  update:
    x-apievangelist-phrasing:
      intent: Get one order custom field definition
      effect: read
      questions:
      - What type and settings does a specific sales order custom field have?
      - Can I read one order auxiliary field schema by its identifier?
      instructions:
      - text: Get the order custom field schema {identifier}.
        slots:
          identifier: requestBody.identifier
      - text: Show the definition of sales order field {identifier}.
        slots:
          identifier: requestBody.identifier
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/order/custom-fields/list'].post
  update:
    x-apievangelist-phrasing:
      intent: List order custom field definitions
      effect: read
      questions:
      - Which custom fields has my partner defined for sales orders?
      - Can I filter and page through the order field schemas?
      instructions:
      - text: List sales order custom field schemas for partner {partnerId}.
        slots:
          partnerId: requestBody.partnerId
      - text: Show all auxiliary order field definitions.
      method: generated
      generated: '2026-10-01'