Oracle Transportation Management Business Object Resources REST API — ShipmentOrders

naftiko: 1.0.0-alpha2
info:
  label: Oracle Transportation Management Business Object Resources REST API — ShipmentOrders
  description: 'Oracle Transportation Management Business Object Resources REST API — ShipmentOrders. 5 operations. Lead operation:
    List shipment orders. Self-contained Naftiko capability covering one Oracle Transportation Management business surface.'
  tags:
  - Oracle Transportation Management
  - ShipmentOrders
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ORACLE_TRANSPORTATION_MANAGEMENT_API_KEY: ORACLE_TRANSPORTATION_MANAGEMENT_API_KEY
capability:
  consumes:
  - type: http
    namespace: oracle-otm-business-objects-shipmentorders
    baseUri: https://{host}/GC3/glog.integration.servlet.WMServlet/otm/rest/v1
    description: Oracle Transportation Management Business Object Resources REST API — ShipmentOrders business capability.
      Self-contained, no shared references.
    resources:
    - name: shipment-orders
      path: /shipment-orders
      operations:
      - name: listshipmentorders
        method: GET
        description: List shipment orders
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: status
          in: query
          type: string
          description: Filter by order status
        - name: startDate
          in: query
          type: string
          description: Early pickup date filter (ISO 8601)
        - name: endDate
          in: query
          type: string
        - name: sourceLocationGid
          in: query
          type: string
          description: Filter by origin location GID
        - name: destLocationGid
          in: query
          type: string
          description: Filter by destination location GID
        - name: offset
          in: query
          type: integer
        - name: limit
          in: query
          type: integer
      - name: createshipmentorder
        method: POST
        description: Create a shipment order
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: shipment-orders-gid
      path: /shipment-orders/{gid}
      operations:
      - name: getshipmentorder
        method: GET
        description: Get a shipment order
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateshipmentorder
        method: PUT
        description: Update a shipment order
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteshipmentorder
        method: DELETE
        description: Delete a shipment order
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.ORACLE_TRANSPORTATION_MANAGEMENT_API_KEY}}'
  exposes:
  - type: rest
    namespace: oracle-otm-business-objects-shipmentorders-rest
    port: 8080
    description: REST adapter for Oracle Transportation Management Business Object Resources REST API — ShipmentOrders. One
      Spectral-compliant resource per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/shipment-orders
      name: shipment-orders
      description: REST surface for shipment-orders.
      operations:
      - method: GET
        name: listshipmentorders
        description: List shipment orders
        call: oracle-otm-business-objects-shipmentorders.listshipmentorders
        with:
          status: rest.status
          startDate: rest.startDate
          endDate: rest.endDate
          sourceLocationGid: rest.sourceLocationGid
          destLocationGid: rest.destLocationGid
          offset: rest.offset
          limit: rest.limit
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createshipmentorder
        description: Create a shipment order
        call: oracle-otm-business-objects-shipmentorders.createshipmentorder
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/shipment-orders/{gid}
      name: shipment-orders-gid
      description: REST surface for shipment-orders-gid.
      operations:
      - method: GET
        name: getshipmentorder
        description: Get a shipment order
        call: oracle-otm-business-objects-shipmentorders.getshipmentorder
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateshipmentorder
        description: Update a shipment order
        call: oracle-otm-business-objects-shipmentorders.updateshipmentorder
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteshipmentorder
        description: Delete a shipment order
        call: oracle-otm-business-objects-shipmentorders.deleteshipmentorder
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: oracle-otm-business-objects-shipmentorders-mcp
    port: 9090
    transport: http
    description: MCP adapter for Oracle Transportation Management Business Object Resources REST API — ShipmentOrders. One
      tool per consumed operation, routed inline through this capability's consumes block.
    tools:
    - name: list-shipment-orders
      description: List shipment orders
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: oracle-otm-business-objects-shipmentorders.listshipmentorders
      with:
        status: tools.status
        startDate: tools.startDate
        endDate: tools.endDate
        sourceLocationGid: tools.sourceLocationGid
        destLocationGid: tools.destLocationGid
        offset: tools.offset
        limit: tools.limit
      outputParameters:
      - type: object
        mapping: $.
    - name: create-shipment-order
      description: Create a shipment order
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: oracle-otm-business-objects-shipmentorders.createshipmentorder
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-shipment-order
      description: Get a shipment order
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: oracle-otm-business-objects-shipmentorders.getshipmentorder
      outputParameters:
      - type: object
        mapping: $.
    - name: update-shipment-order
      description: Update a shipment order
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: oracle-otm-business-objects-shipmentorders.updateshipmentorder
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-shipment-order
      description: Delete a shipment order
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: oracle-otm-business-objects-shipmentorders.deleteshipmentorder
      outputParameters:
      - type: object
        mapping: $.