U.S. Steel SteelTrack API — Shipments

naftiko: 1.0.0-alpha2
info:
  label: U.S. Steel SteelTrack API — Shipments
  description: 'U.S. Steel SteelTrack API — Shipments. 1 operations. Lead operation: U.S. Steel SteelTrack List Shipments.
    Self-contained Naftiko capability covering one United States Steel business surface.'
  tags:
  - United States Steel
  - Shipments
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    UNITED_STATES_STEEL_API_KEY: UNITED_STATES_STEEL_API_KEY
capability:
  consumes:
  - type: http
    namespace: steeltrack-shipments
    baseUri: https://steeltrack.ussteel.com/api
    description: U.S. Steel SteelTrack API — Shipments business capability. Self-contained, no shared references.
    resources:
    - name: shipments
      path: /shipments
      operations:
      - name: listshipments
        method: GET
        description: U.S. Steel SteelTrack List Shipments
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orderId
          in: query
          type: string
          description: Filter by order ID.
        - name: purchaseOrder
          in: query
          type: string
          description: Filter by purchase order number.
        - name: fromDate
          in: query
          type: string
          description: Start date for shipment date range.
        - name: toDate
          in: query
          type: string
          description: End date for shipment date range.
        - name: includeCoilDetail
          in: query
          type: boolean
          description: Whether to include coil-level detail in the response.
        - name: limit
          in: query
          type: integer
          description: Maximum number of results to return.
    authentication:
      type: bearer
      token: '{{env.UNITED_STATES_STEEL_API_KEY}}'
  exposes:
  - type: rest
    namespace: steeltrack-shipments-rest
    port: 8080
    description: REST adapter for U.S. Steel SteelTrack 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: U.S. Steel SteelTrack List Shipments
        call: steeltrack-shipments.listshipments
        with:
          orderId: rest.orderId
          purchaseOrder: rest.purchaseOrder
          fromDate: rest.fromDate
          toDate: rest.toDate
          includeCoilDetail: rest.includeCoilDetail
          limit: rest.limit
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: steeltrack-shipments-mcp
    port: 9090
    transport: http
    description: MCP adapter for U.S. Steel SteelTrack API — Shipments. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: u-s-steel-steeltrack-list-shipments
      description: U.S. Steel SteelTrack List Shipments
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: steeltrack-shipments.listshipments
      with:
        orderId: tools.orderId
        purchaseOrder: tools.purchaseOrder
        fromDate: tools.fromDate
        toDate: tools.toDate
        includeCoilDetail: tools.includeCoilDetail
        limit: tools.limit
      outputParameters:
      - type: object
        mapping: $.