# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Accounting Subpackage Item Fulfillments API
  version: 1.0.0
extends: openapi/merge-subpackage-itemfulfillments-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: 7
- target: $.paths['/accounting/v1/item-fulfillments'].get
  update:
    x-apievangelist-phrasing:
      intent: List item fulfillments
      effect: read
      questions:
      - How do I see which orders have been shipped or fulfilled in my customer's accounting system?
      - Can I pull item fulfillments that were deleted in the source platform too?
      instructions:
      - text: List item fulfillments for linked account {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Show fulfillments including deleted ones, with {relations} expanded.
        slots:
          relations: query.expand
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/item-fulfillments'].post
  update:
    x-apievangelist-phrasing:
      intent: Record a single item fulfillment
      effect: write
      questions:
      - Can I mark goods as fulfilled against an order in the linked accounting platform?
      - What does creating one item fulfillment require?
      instructions:
      - text: Create an item fulfillment from {fulfillment}.
        slots:
          fulfillment: requestBody.model
      - text: 'Record this shipment as one fulfillment: {fulfillment}.'
        slots:
          fulfillment: requestBody.model
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/item-fulfillments/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one item fulfillment
      effect: read
      questions:
      - How do I read the lines on a single fulfillment?
      - Can I see the original platform values behind one item fulfillment's enums?
      instructions:
      - text: Get item fulfillment {id}.
        slots:
          id: path.id
      - text: Fetch fulfillment {id} with its remote custom fields.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/item-fulfillments/lines/remote-field-classes'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom field definitions for fulfillment lines
      effect: read
      questions:
      - What custom fields exist on individual fulfillment line items?
      - Can I list only custom field classes for item fulfillment lines?
      instructions:
      - text: List remote field classes for fulfillment lines on {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Show custom fields defined on item fulfillment line items.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/item-fulfillments/remote-field-classes'].get
  update:
    x-apievangelist-phrasing:
      intent: List custom field definitions for item fulfillments
      effect: read
      questions:
      - Which custom fields are defined at the item fulfillment header level?
      - Can I tell common-model fulfillment fields apart from custom ones?
      instructions:
      - text: List item fulfillment remote field classes for {account_token}.
        slots:
          account_token: header.X-Account-Token
      - text: Show only the custom field classes on fulfillment records.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/item-fulfillments/bulk'].post
  update:
    x-apievangelist-phrasing:
      intent: Create many item fulfillments in one batch
      effect: write
      questions:
      - Can I submit a batch of fulfillments at once?
      - How do I bulk load shipped orders into the accounting system?
      instructions:
      - text: 'Bulk create these item fulfillments: {batch_items}.'
        slots:
          batch_items: requestBody.batch_items
      - text: Submit {batch_items} as an asynchronous fulfillment batch.
        slots:
          batch_items: requestBody.batch_items
      method: generated
      generated: '2026-09-26'
- target: $.paths['/accounting/v1/item-fulfillments/bulk/{batch_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the status of a fulfillment bulk batch
      effect: read
      questions:
      - Did my bulk item fulfillment upload complete?
      - Where can I see which fulfillments in a batch failed?
      instructions:
      - text: Check the status of fulfillment batch {batch_id}.
        slots:
          batch_id: path.batch_id
      - text: Show results for item fulfillment bulk job {batch_id}.
        slots:
          batch_id: path.batch_id
      method: generated
      generated: '2026-09-26'