Ryder TM Shipment Management API — Shipments

naftiko: 1.0.0-alpha2
info:
  label: Ryder TM Shipment Management API — Shipments
  description: 'Ryder TM Shipment Management API — Shipments. 4 operations. Lead operation: List Shipments. Self-contained
    Naftiko capability covering one Ryder System business surface.'
  tags:
  - Ryder System
  - Shipments
  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-shipments
    baseUri: https://api.ryder.com/tmshipment/v1
    description: Ryder TM Shipment Management API — Shipments business capability. Self-contained, no shared references.
    resources:
    - name: shipments
      path: /shipments
      operations:
      - name: listshipments
        method: GET
        description: List Shipments
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: status
          in: query
          type: string
        - name: startDate
          in: query
          type: string
        - name: endDate
          in: query
          type: string
        - name: page
          in: query
          type: integer
        - name: pageSize
          in: query
          type: integer
      - name: createshipment
        method: POST
        description: Create Shipment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: shipments-shipmentId
      path: /shipments/{shipmentId}
      operations:
      - name: getshipment
        method: GET
        description: Get Shipment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: shipmentId
          in: path
          type: string
          required: true
      - name: updateshipment
        method: PUT
        description: Update Shipment
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: shipmentId
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: bearer
      token: '{{env.RYDER_SYSTEM_API_KEY}}'
  exposes:
  - type: rest
    namespace: ryder-tm-shipment-shipments-rest
    port: 8080
    description: REST adapter for Ryder TM Shipment Management 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: List Shipments
        call: ryder-tm-shipment-shipments.listshipments
        with:
          status: rest.status
          startDate: rest.startDate
          endDate: rest.endDate
          page: rest.page
          pageSize: rest.pageSize
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createshipment
        description: Create Shipment
        call: ryder-tm-shipment-shipments.createshipment
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/shipments/{shipmentid}
      name: shipments-shipmentid
      description: REST surface for shipments-shipmentId.
      operations:
      - method: GET
        name: getshipment
        description: Get Shipment
        call: ryder-tm-shipment-shipments.getshipment
        with:
          shipmentId: rest.shipmentId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateshipment
        description: Update Shipment
        call: ryder-tm-shipment-shipments.updateshipment
        with:
          shipmentId: rest.shipmentId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: ryder-tm-shipment-shipments-mcp
    port: 9090
    transport: http
    description: MCP adapter for Ryder TM Shipment Management API — Shipments. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: list-shipments
      description: List Shipments
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: ryder-tm-shipment-shipments.listshipments
      with:
        status: tools.status
        startDate: tools.startDate
        endDate: tools.endDate
        page: tools.page
        pageSize: tools.pageSize
      outputParameters:
      - type: object
        mapping: $.
    - name: create-shipment
      description: Create Shipment
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: ryder-tm-shipment-shipments.createshipment
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-shipment
      description: Get Shipment
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: ryder-tm-shipment-shipments.getshipment
      with:
        shipmentId: tools.shipmentId
      outputParameters:
      - type: object
        mapping: $.
    - name: update-shipment
      description: Update Shipment
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: ryder-tm-shipment-shipments.updateshipment
      with:
        shipmentId: tools.shipmentId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.