naftiko: 1.0.0-alpha2
info:
  label: Sendcloud API — Shipments
  description: 'Sendcloud API v3 — Shipments. Create, announce, retrieve, and cancel outgoing shipments. Self-contained Naftiko capability covering one Sendcloud business surface.'
  tags:
  - Sendcloud
  - Shipments
  created: '2026-05-25'
  modified: '2026-05-25'
binds:
- namespace: env
  keys:
    SENDCLOUD_PUBLIC_KEY: SENDCLOUD_PUBLIC_KEY
    SENDCLOUD_PRIVATE_KEY: SENDCLOUD_PRIVATE_KEY
capability:
  consumes:
  - type: http
    namespace: sendcloud-shipments
    baseUri: https://panel.sendcloud.sc/api/v3
    description: Sendcloud Shipments API v3.
    resources:
    - name: shipments
      path: /shipments
      operations:
      - name: createshipment
        method: POST
        description: Create a shipment asynchronously.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          required: true
    - name: shipments-announce
      path: /shipments/announce
      operations:
      - name: announceshipment
        method: POST
        description: Create and announce a shipment synchronously.
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          required: true
    - name: shipments-id
      path: /shipments/{id}
      operations:
      - name: retrieveshipment
        method: GET
        description: Retrieve a shipment by id.
        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: basic
      username: '{{env.SENDCLOUD_PUBLIC_KEY}}'
      password: '{{env.SENDCLOUD_PRIVATE_KEY}}'
  exposes:
  - type: rest
    namespace: sendcloud-shipments-rest
    port: 8080
    description: REST adapter for Sendcloud Shipments.
    resources:
    - path: /v1/shipments
      name: shipments
      operations:
      - method: POST
        name: createshipment
        description: Create a shipment.
        call: sendcloud-shipments.createshipment
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/shipments/{id}
      name: shipments-id
      operations:
      - method: GET
        name: retrieveshipment
        description: Retrieve a shipment.
        call: sendcloud-shipments.retrieveshipment
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: sendcloud-shipments-mcp
    port: 9090
    transport: http
    description: MCP adapter for Sendcloud Shipments.
    tools:
    - name: create-shipment
      description: Create a shipment asynchronously.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: sendcloud-shipments.createshipment
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: announce-shipment
      description: Create and announce a shipment synchronously.
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: sendcloud-shipments.announceshipment
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-shipment
      description: Retrieve a shipment by id.
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: sendcloud-shipments.retrieveshipment
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.
    - name: cancel-shipment
      description: Cancel a shipment.
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: sendcloud-shipments.cancelshipment
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.