Shippo API — Refunds

naftiko: 1.0.0-alpha2
info:
  label: Shippo API — Refunds
  description: 'Shippo API — Refunds. 3 operations. Lead operation: List Refunds. Self-contained Naftiko capability covering
    one Shippo business surface.'
  tags:
  - Shippo
  - Refunds
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SHIPPO_API_KEY: SHIPPO_API_KEY
capability:
  consumes:
  - type: http
    namespace: shippo-refunds
    baseUri: https://api.goshippo.com
    description: Shippo API — Refunds business capability. Self-contained, no shared references.
    resources:
    - name: refunds
      path: /refunds
      operations:
      - name: listrefunds
        method: GET
        description: List Refunds
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: page
          in: query
          type: integer
        - name: results
          in: query
          type: integer
      - name: createrefund
        method: POST
        description: Create Refund
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: refunds-RefundId
      path: /refunds/{RefundId}
      operations:
      - name: getrefund
        method: GET
        description: Get Refund
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: RefundId
          in: path
          type: string
          required: true
    authentication:
      type: bearer
      token: '{{env.SHIPPO_API_KEY}}'
  exposes:
  - type: rest
    namespace: shippo-refunds-rest
    port: 8080
    description: REST adapter for Shippo API — Refunds. One Spectral-compliant resource per consumed operation, prefixed with
      /v1.
    resources:
    - path: /v1/refunds
      name: refunds
      description: REST surface for refunds.
      operations:
      - method: GET
        name: listrefunds
        description: List Refunds
        call: shippo-refunds.listrefunds
        with:
          page: rest.page
          results: rest.results
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createrefund
        description: Create Refund
        call: shippo-refunds.createrefund
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/refunds/{refundid}
      name: refunds-refundid
      description: REST surface for refunds-RefundId.
      operations:
      - method: GET
        name: getrefund
        description: Get Refund
        call: shippo-refunds.getrefund
        with:
          RefundId: rest.RefundId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: shippo-refunds-mcp
    port: 9090
    transport: http
    description: MCP adapter for Shippo API — Refunds. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: list-refunds
      description: List Refunds
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shippo-refunds.listrefunds
      with:
        page: tools.page
        results: tools.results
      outputParameters:
      - type: object
        mapping: $.
    - name: create-refund
      description: Create Refund
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: shippo-refunds.createrefund
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-refund
      description: Get Refund
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shippo-refunds.getrefund
      with:
        RefundId: tools.RefundId
      outputParameters:
      - type: object
        mapping: $.