Ryder TM Shipment Management API — Loads

naftiko: 1.0.0-alpha2
info:
  label: Ryder TM Shipment Management API — Loads
  description: 'Ryder TM Shipment Management API — Loads. 2 operations. Lead operation: List Loads. Self-contained Naftiko
    capability covering one Ryder System business surface.'
  tags:
  - Ryder System
  - Loads
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    RYDER_SYSTEM_API_KEY: RYDER_SYSTEM_API_KEY
capability:
  consumes:
  - type: http
    namespace: ryder-tm-shipment-loads
    baseUri: https://api.ryder.com/tmshipment/v1
    description: Ryder TM Shipment Management API — Loads business capability. Self-contained, no shared references.
    resources:
    - name: loads
      path: /loads
      operations:
      - name: listloads
        method: GET
        description: List Loads
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: shipmentId
          in: query
          type: string
        - name: status
          in: query
          type: string
        - name: page
          in: query
          type: integer
        - name: pageSize
          in: query
          type: integer
    - name: loads-loadId
      path: /loads/{loadId}
      operations:
      - name: getload
        method: GET
        description: Get Load
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: loadId
          in: path
          type: string
          required: true
    authentication:
      type: bearer
      token: '{{env.RYDER_SYSTEM_API_KEY}}'
  exposes:
  - type: rest
    namespace: ryder-tm-shipment-loads-rest
    port: 8080
    description: REST adapter for Ryder TM Shipment Management API — Loads. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/loads
      name: loads
      description: REST surface for loads.
      operations:
      - method: GET
        name: listloads
        description: List Loads
        call: ryder-tm-shipment-loads.listloads
        with:
          shipmentId: rest.shipmentId
          status: rest.status
          page: rest.page
          pageSize: rest.pageSize
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/loads/{loadid}
      name: loads-loadid
      description: REST surface for loads-loadId.
      operations:
      - method: GET
        name: getload
        description: Get Load
        call: ryder-tm-shipment-loads.getload
        with:
          loadId: rest.loadId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: ryder-tm-shipment-loads-mcp
    port: 9090
    transport: http
    description: MCP adapter for Ryder TM Shipment Management API — Loads. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: list-loads
      description: List Loads
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: ryder-tm-shipment-loads.listloads
      with:
        shipmentId: tools.shipmentId
        status: tools.status
        page: tools.page
        pageSize: tools.pageSize
      outputParameters:
      - type: object
        mapping: $.
    - name: get-load
      description: Get Load
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: ryder-tm-shipment-loads.getload
      with:
        loadId: tools.loadId
      outputParameters:
      - type: object
        mapping: $.