Shippo API — Shipments

naftiko: 1.0.0-alpha2
info:
  label: Shippo API — Shipments
  description: 'Shippo API — Shipments. 4 operations. Lead operation: List Shipments. Self-contained Naftiko capability covering
    one Shippo business surface.'
  tags:
  - Shippo
  - Shipments
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SHIPPO_API_KEY: SHIPPO_API_KEY
capability:
  consumes:
  - type: http
    namespace: shippo-shipments
    baseUri: https://api.goshippo.com
    description: Shippo API — Shipments business capability. Self-contained, no shared references.
    resources:
    - name: shipments
      path: /shipments
      operations:
      - name: listshipments
        method: GET
        description: List Shipments
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: page
          in: query
          type: integer
        - name: results
          in: query
          type: integer
        - name: object_created_gt
          in: query
          type: string
          description: Filter by creation date (greater than)
        - name: object_created_lt
          in: query
          type: string
          description: Filter by creation date (less than)
      - name: createshipment
        method: POST
        description: Create Shipment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: shipments-ShipmentId
      path: /shipments/{ShipmentId}
      operations:
      - name: getshipment
        method: GET
        description: Get Shipment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: ShipmentId
          in: path
          type: string
          required: true
    - name: shipments-ShipmentId-rates
      path: /shipments/{ShipmentId}/rates
      operations:
      - name: getshipmentrates
        method: GET
        description: Get Shipment Rates
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: ShipmentId
          in: path
          type: string
          required: true
        - name: currency_code
          in: query
          type: string
          description: Currency code for rate amounts (ISO 4217)
    authentication:
      type: bearer
      token: '{{env.SHIPPO_API_KEY}}'
  exposes:
  - type: rest
    namespace: shippo-shipments-rest
    port: 8080
    description: REST adapter for Shippo API — Shipments. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/shipments
      name: shipments
      description: REST surface for shipments.
      operations:
      - method: GET
        name: listshipments
        description: List Shipments
        call: shippo-shipments.listshipments
        with:
          page: rest.page
          results: rest.results
          object_created_gt: rest.object_created_gt
          object_created_lt: rest.object_created_lt
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createshipment
        description: Create Shipment
        call: shippo-shipments.createshipment
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/shipments/{shipmentid}
      name: shipments-shipmentid
      description: REST surface for shipments-ShipmentId.
      operations:
      - method: GET
        name: getshipment
        description: Get Shipment
        call: shippo-shipments.getshipment
        with:
          ShipmentId: rest.ShipmentId
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/shipments/{shipmentid}/rates
      name: shipments-shipmentid-rates
      description: REST surface for shipments-ShipmentId-rates.
      operations:
      - method: GET
        name: getshipmentrates
        description: Get Shipment Rates
        call: shippo-shipments.getshipmentrates
        with:
          ShipmentId: rest.ShipmentId
          currency_code: rest.currency_code
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: shippo-shipments-mcp
    port: 9090
    transport: http
    description: MCP adapter for Shippo API — Shipments. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: list-shipments
      description: List Shipments
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shippo-shipments.listshipments
      with:
        page: tools.page
        results: tools.results
        object_created_gt: tools.object_created_gt
        object_created_lt: tools.object_created_lt
      outputParameters:
      - type: object
        mapping: $.
    - name: create-shipment
      description: Create Shipment
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: shippo-shipments.createshipment
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-shipment
      description: Get Shipment
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shippo-shipments.getshipment
      with:
        ShipmentId: tools.ShipmentId
      outputParameters:
      - type: object
        mapping: $.
    - name: get-shipment-rates
      description: Get Shipment Rates
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shippo-shipments.getshipmentrates
      with:
        ShipmentId: tools.ShipmentId
        currency_code: tools.currency_code
      outputParameters:
      - type: object
        mapping: $.