Shippo API — Tracking

naftiko: 1.0.0-alpha2
info:
  label: Shippo API — Tracking
  description: 'Shippo API — Tracking. 2 operations. Lead operation: Register Tracking Webhook. Self-contained Naftiko capability
    covering one Shippo business surface.'
  tags:
  - Shippo
  - Tracking
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SHIPPO_API_KEY: SHIPPO_API_KEY
capability:
  consumes:
  - type: http
    namespace: shippo-tracking
    baseUri: https://api.goshippo.com
    description: Shippo API — Tracking business capability. Self-contained, no shared references.
    resources:
    - name: tracks
      path: /tracks
      operations:
      - name: registertrackingwebhook
        method: POST
        description: Register Tracking Webhook
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: tracks-Carrier-TrackingNumber
      path: /tracks/{Carrier}/{TrackingNumber}
      operations:
      - name: gettrackingstatus
        method: GET
        description: Get Tracking Status
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Carrier
          in: path
          type: string
          description: Carrier code (e.g. usps, fedex, ups, dhl_express)
          required: true
        - name: TrackingNumber
          in: path
          type: string
          description: Tracking number for the shipment
          required: true
    authentication:
      type: bearer
      token: '{{env.SHIPPO_API_KEY}}'
  exposes:
  - type: rest
    namespace: shippo-tracking-rest
    port: 8080
    description: REST adapter for Shippo API — Tracking. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/tracks
      name: tracks
      description: REST surface for tracks.
      operations:
      - method: POST
        name: registertrackingwebhook
        description: Register Tracking Webhook
        call: shippo-tracking.registertrackingwebhook
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/tracks/{carrier}/{trackingnumber}
      name: tracks-carrier-trackingnumber
      description: REST surface for tracks-Carrier-TrackingNumber.
      operations:
      - method: GET
        name: gettrackingstatus
        description: Get Tracking Status
        call: shippo-tracking.gettrackingstatus
        with:
          Carrier: rest.Carrier
          TrackingNumber: rest.TrackingNumber
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: shippo-tracking-mcp
    port: 9090
    transport: http
    description: MCP adapter for Shippo API — Tracking. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: register-tracking-webhook
      description: Register Tracking Webhook
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: shippo-tracking.registertrackingwebhook
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-tracking-status
      description: Get Tracking Status
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shippo-tracking.gettrackingstatus
      with:
        Carrier: tools.Carrier
        TrackingNumber: tools.TrackingNumber
      outputParameters:
      - type: object
        mapping: $.