API Reference — Delivery Adjustments

naftiko: 1.0.0-alpha2
info:
  label: API Reference — Delivery Adjustments
  description: 'API Reference — Delivery Adjustments. 5 operations. Lead operation: Create a delivery adjustment. Self-contained
    Naftiko capability covering one Zuora business surface.'
  tags:
  - Zuora
  - Delivery Adjustments
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ZUORA_API_KEY: ZUORA_API_KEY
capability:
  consumes:
  - type: http
    namespace: v1-delivery-adjustments
    baseUri: https://rest.zuora.com
    description: API Reference — Delivery Adjustments business capability. Self-contained, no shared references.
    resources:
    - name: v1-adjustments
      path: /v1/adjustments
      operations:
      - name: createadjustment
        method: POST
        description: Create a delivery adjustment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: string
          required: true
      - name: getsubscriptionadjustments
        method: GET
        description: List all delivery adjustments of a subscription
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: subscription-number
          in: query
          type: string
          description: A subscription number.
          required: true
    - name: v1-adjustments-preview
      path: /v1/adjustments/preview
      operations:
      - name: previewadjustment
        method: POST
        description: Preview a delivery adjustment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: string
          required: true
    - name: v1-adjustments-adjustment-key
      path: /v1/adjustments/{adjustment-key}
      operations:
      - name: getadjustment
        method: GET
        description: Retrieve a delivery adjustment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: adjustment-key
          in: path
          type: string
          description: The delivery adjustment ID or number to retrieve.
          required: true
    - name: v1-adjustments-adjustmentId-cancel
      path: /v1/adjustments/{adjustmentId}/cancel
      operations:
      - name: putcanceladjustment
        method: PUT
        description: Cancel a delivery adjustment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: adjustmentId
          in: path
          type: string
          description: The ID of the delivery adjustment to cancel.
          required: true
  exposes:
  - type: rest
    namespace: v1-delivery-adjustments-rest
    port: 8080
    description: REST adapter for API Reference — Delivery Adjustments. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/v1/adjustments
      name: v1-adjustments
      description: REST surface for v1-adjustments.
      operations:
      - method: POST
        name: createadjustment
        description: Create a delivery adjustment
        call: v1-delivery-adjustments.createadjustment
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: getsubscriptionadjustments
        description: List all delivery adjustments of a subscription
        call: v1-delivery-adjustments.getsubscriptionadjustments
        with:
          subscription-number: rest.subscription-number
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/adjustments/preview
      name: v1-adjustments-preview
      description: REST surface for v1-adjustments-preview.
      operations:
      - method: POST
        name: previewadjustment
        description: Preview a delivery adjustment
        call: v1-delivery-adjustments.previewadjustment
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/adjustments/{adjustment-key}
      name: v1-adjustments-adjustment-key
      description: REST surface for v1-adjustments-adjustment-key.
      operations:
      - method: GET
        name: getadjustment
        description: Retrieve a delivery adjustment
        call: v1-delivery-adjustments.getadjustment
        with:
          adjustment-key: rest.adjustment-key
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/adjustments/{adjustmentid}/cancel
      name: v1-adjustments-adjustmentid-cancel
      description: REST surface for v1-adjustments-adjustmentId-cancel.
      operations:
      - method: PUT
        name: putcanceladjustment
        description: Cancel a delivery adjustment
        call: v1-delivery-adjustments.putcanceladjustment
        with:
          adjustmentId: rest.adjustmentId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: v1-delivery-adjustments-mcp
    port: 9090
    transport: http
    description: MCP adapter for API Reference — Delivery Adjustments. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: create-delivery-adjustment
      description: Create a delivery adjustment
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: v1-delivery-adjustments.createadjustment
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: list-all-delivery-adjustments-subscription
      description: List all delivery adjustments of a subscription
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: v1-delivery-adjustments.getsubscriptionadjustments
      with:
        subscription-number: tools.subscription-number
      outputParameters:
      - type: object
        mapping: $.
    - name: preview-delivery-adjustment
      description: Preview a delivery adjustment
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: v1-delivery-adjustments.previewadjustment
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-delivery-adjustment
      description: Retrieve a delivery adjustment
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: v1-delivery-adjustments.getadjustment
      with:
        adjustment-key: tools.adjustment-key
      outputParameters:
      - type: object
        mapping: $.
    - name: cancel-delivery-adjustment
      description: Cancel a delivery adjustment
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: v1-delivery-adjustments.putcanceladjustment
      with:
        adjustmentId: tools.adjustmentId
      outputParameters:
      - type: object
        mapping: $.