project44 Tracking API — Shipments

naftiko: 1.0.0-alpha2
info:
  label: project44 Tracking API — Shipments
  description: 'project44 Tracking API — Shipments. 4 operations. Lead operation: Create a tracked shipment. Self-contained
    Naftiko capability covering one Project44 business surface.'
  tags:
  - Project44
  - Shipments
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    PROJECT44_API_KEY: PROJECT44_API_KEY
capability:
  consumes:
  - type: http
    namespace: tracking-shipments
    baseUri: https://api.project44.com/api/v4
    description: project44 Tracking API — Shipments business capability. Self-contained, no shared references.
    resources:
    - name: shipments
      path: /shipments
      operations:
      - name: createshipment
        method: POST
        description: Create a tracked shipment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: listshipments
        method: GET
        description: List tracked shipments
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: status
          in: query
          type: string
          description: Filter by shipment lifecycle status
        - name: mode
          in: query
          type: string
          description: Transportation mode filter
        - name: carrierId
          in: query
          type: string
          description: Carrier SCAC code or project44 carrier ID
        - name: updatedSince
          in: query
          type: string
          description: Return shipments updated after this ISO 8601 timestamp
        - name: page
          in: query
          type: integer
        - name: pageSize
          in: query
          type: integer
    - name: shipments-shipmentId
      path: /shipments/{shipmentId}
      operations:
      - name: getshipment
        method: GET
        description: Get a shipment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deleteshipment
        method: DELETE
        description: Stop tracking a shipment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.PROJECT44_API_KEY}}'
  exposes:
  - type: rest
    namespace: tracking-shipments-rest
    port: 8080
    description: REST adapter for project44 Tracking 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: POST
        name: createshipment
        description: Create a tracked shipment
        call: tracking-shipments.createshipment
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: GET
        name: listshipments
        description: List tracked shipments
        call: tracking-shipments.listshipments
        with:
          status: rest.status
          mode: rest.mode
          carrierId: rest.carrierId
          updatedSince: rest.updatedSince
          page: rest.page
          pageSize: rest.pageSize
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/shipments/{shipmentid}
      name: shipments-shipmentid
      description: REST surface for shipments-shipmentId.
      operations:
      - method: GET
        name: getshipment
        description: Get a shipment
        call: tracking-shipments.getshipment
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteshipment
        description: Stop tracking a shipment
        call: tracking-shipments.deleteshipment
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: tracking-shipments-mcp
    port: 9090
    transport: http
    description: MCP adapter for project44 Tracking API — Shipments. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: create-tracked-shipment
      description: Create a tracked shipment
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: tracking-shipments.createshipment
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: list-tracked-shipments
      description: List tracked shipments
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: tracking-shipments.listshipments
      with:
        status: tools.status
        mode: tools.mode
        carrierId: tools.carrierId
        updatedSince: tools.updatedSince
        page: tools.page
        pageSize: tools.pageSize
      outputParameters:
      - type: object
        mapping: $.
    - name: get-shipment
      description: Get a shipment
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: tracking-shipments.getshipment
      outputParameters:
      - type: object
        mapping: $.
    - name: stop-tracking-shipment
      description: Stop tracking a shipment
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: tracking-shipments.deleteshipment
      outputParameters:
      - type: object
        mapping: $.