API Reference — Fulfillments

naftiko: 1.0.0-alpha2
info:
  label: API Reference — Fulfillments
  description: 'API Reference — Fulfillments. 8 operations. Lead operation: Create fulfillment items. Self-contained Naftiko
    capability covering one Zuora business surface.'
  tags:
  - Zuora
  - Fulfillments
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ZUORA_API_KEY: ZUORA_API_KEY
capability:
  consumes:
  - type: http
    namespace: v1-fulfillments
    baseUri: https://rest.zuora.com
    description: API Reference — Fulfillments business capability. Self-contained, no shared references.
    resources:
    - name: v1-fulfillment-items
      path: /v1/fulfillment-items
      operations:
      - name: createfulfillmentitem
        method: POST
        description: Create fulfillment items
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: string
          required: true
    - name: v1-fulfillment-items-id
      path: /v1/fulfillment-items/{id}
      operations:
      - name: getfulfillmentitem
        method: GET
        description: Retrieve a fulfillment item
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The id of the Fulfillment Item to retrieve.
          required: true
      - name: putfulfillmentitem
        method: PUT
        description: Update a fulfillment item
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The id of the Fulfillment Item to update.
          required: true
        - name: body
          in: body
          type: string
          required: true
      - name: deletefulfillmentitem
        method: DELETE
        description: Delete a fulfillment item
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: The id of the Fulfillment Item to delete.
          required: true
    - name: v1-fulfillments
      path: /v1/fulfillments
      operations:
      - name: createfulfillment
        method: POST
        description: Create fulfillments
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: string
          required: true
    - name: v1-fulfillments-key
      path: /v1/fulfillments/{key}
      operations:
      - name: getfulfillment
        method: GET
        description: Retrieve a fulfillment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: key
          in: path
          type: string
          description: The id or fulfillment number of the Fulfillment to retrieve.
          required: true
        - name: fulfillment-items
          in: query
          type: boolean
          description: Return the related fulfillment items or not.
      - name: putfulfillment
        method: PUT
        description: Update a fulfillment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: key
          in: path
          type: string
          description: The id or fulfillment number of the Fulfillment to update.
          required: true
        - name: body
          in: body
          type: string
          required: true
      - name: deletefulfillment
        method: DELETE
        description: Delete a fulfillment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: key
          in: path
          type: string
          description: The id or fulfillment number of the Fulfillment to delete.
          required: true
  exposes:
  - type: rest
    namespace: v1-fulfillments-rest
    port: 8080
    description: REST adapter for API Reference — Fulfillments. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/v1/fulfillment-items
      name: v1-fulfillment-items
      description: REST surface for v1-fulfillment-items.
      operations:
      - method: POST
        name: createfulfillmentitem
        description: Create fulfillment items
        call: v1-fulfillments.createfulfillmentitem
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/fulfillment-items/{id}
      name: v1-fulfillment-items-id
      description: REST surface for v1-fulfillment-items-id.
      operations:
      - method: GET
        name: getfulfillmentitem
        description: Retrieve a fulfillment item
        call: v1-fulfillments.getfulfillmentitem
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: putfulfillmentitem
        description: Update a fulfillment item
        call: v1-fulfillments.putfulfillmentitem
        with:
          id: rest.id
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletefulfillmentitem
        description: Delete a fulfillment item
        call: v1-fulfillments.deletefulfillmentitem
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/fulfillments
      name: v1-fulfillments
      description: REST surface for v1-fulfillments.
      operations:
      - method: POST
        name: createfulfillment
        description: Create fulfillments
        call: v1-fulfillments.createfulfillment
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/fulfillments/{key}
      name: v1-fulfillments-key
      description: REST surface for v1-fulfillments-key.
      operations:
      - method: GET
        name: getfulfillment
        description: Retrieve a fulfillment
        call: v1-fulfillments.getfulfillment
        with:
          key: rest.key
          fulfillment-items: rest.fulfillment-items
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: putfulfillment
        description: Update a fulfillment
        call: v1-fulfillments.putfulfillment
        with:
          key: rest.key
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletefulfillment
        description: Delete a fulfillment
        call: v1-fulfillments.deletefulfillment
        with:
          key: rest.key
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: v1-fulfillments-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Reference — Fulfillments. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: create-fulfillment-items
      description: Create fulfillment items
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: v1-fulfillments.createfulfillmentitem
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-fulfillment-item
      description: Retrieve a fulfillment item
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: v1-fulfillments.getfulfillmentitem
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: update-fulfillment-item
      description: Update a fulfillment item
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: v1-fulfillments.putfulfillmentitem
      with:
        id: tools.id
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-fulfillment-item
      description: Delete a fulfillment item
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: v1-fulfillments.deletefulfillmentitem
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: create-fulfillments
      description: Create fulfillments
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: v1-fulfillments.createfulfillment
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-fulfillment
      description: Retrieve a fulfillment
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: v1-fulfillments.getfulfillment
      with:
        key: tools.key
        fulfillment-items: tools.fulfillment-items
      outputParameters:
      - type: object
        mapping: $.
    - name: update-fulfillment
      description: Update a fulfillment
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: v1-fulfillments.putfulfillment
      with:
        key: tools.key
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-fulfillment
      description: Delete a fulfillment
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: v1-fulfillments.deletefulfillment
      with:
        key: tools.key
      outputParameters:
      - type: object
        mapping: $.