naftiko: 1.0.0-alpha2
info:
  label: Easyship API — Shipments
  description: 'Easyship API — Shipments. 6 operations: create, list, show, update, delete, cancel. Self-contained Naftiko capability covering one Easyship business surface.'
  tags:
    - Easyship
    - Shipments
    - Shipping
  created: '2026-05-25'
  modified: '2026-05-25'
binds:
  - namespace: env
    keys:
      EASYSHIP_API_TOKEN: EASYSHIP_API_TOKEN
capability:
  consumes:
    - type: http
      namespace: easyship-shipments
      baseUri: https://api.easyship.com/2024-09
      description: Easyship API — Shipments business capability.
      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: per_page
                  in: query
                  type: integer
            - name: createshipment
              method: POST
              description: Create a Shipment
              outputRawFormat: json
              outputParameters:
                - name: result
                  type: object
                  value: $.
              inputParameters:
                - name: body
                  in: body
                  type: object
                  description: Shipment payload
                  required: true
        - name: shipments-Id
          path: /shipments/{Id}
          operations:
            - name: getshipment
              method: GET
              description: Show a Shipment
              outputRawFormat: json
              outputParameters:
                - name: result
                  type: object
                  value: $.
              inputParameters:
                - name: Id
                  in: path
                  type: string
                  required: true
            - name: updateshipment
              method: PATCH
              description: Update a Shipment
              outputRawFormat: json
              outputParameters:
                - name: result
                  type: object
                  value: $.
              inputParameters:
                - name: Id
                  in: path
                  type: string
                  required: true
                - name: body
                  in: body
                  type: object
                  required: true
            - name: deleteshipment
              method: DELETE
              description: Delete a Shipment
              outputRawFormat: json
              outputParameters:
                - name: result
                  type: object
                  value: $.
              inputParameters:
                - name: Id
                  in: path
                  type: string
                  required: true
        - name: shipments-Id-cancel
          path: /shipments/{Id}/cancel
          operations:
            - name: cancelshipment
              method: POST
              description: Cancel a Shipment
              outputRawFormat: json
              outputParameters:
                - name: result
                  type: object
                  value: $.
              inputParameters:
                - name: Id
                  in: path
                  type: string
                  required: true
      authentication:
        type: bearer
        token: '{{env.EASYSHIP_API_TOKEN}}'
  exposes:
    - type: rest
      namespace: easyship-shipments-rest
      port: 8080
      description: REST adapter for Easyship API — Shipments.
      resources:
        - path: /v1/shipments
          name: shipments
          description: REST surface for shipments.
          operations:
            - method: GET
              name: listshipments
              description: List Shipments
              call: easyship-shipments.listshipments
              with:
                page: rest.page
                per_page: rest.per_page
              outputParameters:
                - type: object
                  mapping: $.
            - method: POST
              name: createshipment
              description: Create a Shipment
              call: easyship-shipments.createshipment
              with:
                body: rest.body
              outputParameters:
                - type: object
                  mapping: $.
        - path: /v1/shipments/{id}
          name: shipments-id
          description: REST surface for shipments-Id.
          operations:
            - method: GET
              name: getshipment
              description: Show a Shipment
              call: easyship-shipments.getshipment
              with:
                Id: rest.Id
              outputParameters:
                - type: object
                  mapping: $.
            - method: PATCH
              name: updateshipment
              description: Update a Shipment
              call: easyship-shipments.updateshipment
              with:
                Id: rest.Id
                body: rest.body
              outputParameters:
                - type: object
                  mapping: $.
            - method: DELETE
              name: deleteshipment
              description: Delete a Shipment
              call: easyship-shipments.deleteshipment
              with:
                Id: rest.Id
              outputParameters:
                - type: object
                  mapping: $.
        - path: /v1/shipments/{id}/cancel
          name: shipments-id-cancel
          description: REST surface for shipments-Id-cancel.
          operations:
            - method: POST
              name: cancelshipment
              description: Cancel a Shipment
              call: easyship-shipments.cancelshipment
              with:
                Id: rest.Id
              outputParameters:
                - type: object
                  mapping: $.
    - type: mcp
      namespace: easyship-shipments-mcp
      port: 9090
      transport: http
      description: MCP adapter for Easyship API — Shipments.
      tools:
        - name: list-shipments
          description: List Shipments
          hints:
            readOnly: true
            destructive: false
            idempotent: true
          call: easyship-shipments.listshipments
          with:
            page: tools.page
            per_page: tools.per_page
          outputParameters:
            - type: object
              mapping: $.
        - name: create-shipment
          description: Create a Shipment
          hints:
            readOnly: false
            destructive: false
            idempotent: false
          call: easyship-shipments.createshipment
          with:
            body: tools.body
          outputParameters:
            - type: object
              mapping: $.
        - name: get-shipment
          description: Show a Shipment
          hints:
            readOnly: true
            destructive: false
            idempotent: true
          call: easyship-shipments.getshipment
          with:
            Id: tools.Id
          outputParameters:
            - type: object
              mapping: $.
        - name: update-shipment
          description: Update a Shipment
          hints:
            readOnly: false
            destructive: false
            idempotent: true
          call: easyship-shipments.updateshipment
          with:
            Id: tools.Id
            body: tools.body
          outputParameters:
            - type: object
              mapping: $.
        - name: delete-shipment
          description: Delete a Shipment
          hints:
            readOnly: false
            destructive: true
            idempotent: true
          call: easyship-shipments.deleteshipment
          with:
            Id: tools.Id
          outputParameters:
            - type: object
              mapping: $.
        - name: cancel-shipment
          description: Cancel a Shipment
          hints:
            readOnly: false
            destructive: true
            idempotent: true
          call: easyship-shipments.cancelshipment
          with:
            Id: tools.Id
          outputParameters:
            - type: object
              mapping: $.