Oracle Retail Order Management Suite Cloud Service API — Orders

naftiko: 1.0.0-alpha2
info:
  label: Oracle Retail Order Management Suite Cloud Service API — Orders
  description: 'Oracle Retail Order Management Suite Cloud Service API — Orders. 5 operations. Lead operation: List orders.
    Self-contained Naftiko capability covering one Oracle Retail business surface.'
  tags:
  - Oracle Retail
  - Orders
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    ORACLE_RETAIL_API_KEY: ORACLE_RETAIL_API_KEY
capability:
  consumes:
  - type: http
    namespace: order-management-orders
    baseUri: https://{host}/oms/api/v1
    description: Oracle Retail Order Management Suite Cloud Service API — Orders business capability. Self-contained, no shared
      references.
    resources:
    - name: orders
      path: /orders
      operations:
      - name: listorders
        method: GET
        description: List orders
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: status
          in: query
          type: string
          description: Filter by order status
        - name: channelId
          in: query
          type: string
          description: Filter by sales channel
        - name: customerId
          in: query
          type: string
          description: Filter by customer ID
        - name: fromDate
          in: query
          type: string
        - name: toDate
          in: query
          type: string
        - name: offset
          in: query
          type: integer
        - name: limit
          in: query
          type: integer
      - name: createorder
        method: POST
        description: Create an order
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: orders-orderId
      path: /orders/{orderId}
      operations:
      - name: getorder
        method: GET
        description: Get an order
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateorder
        method: PATCH
        description: Update an order
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: orders-orderId-cancel
      path: /orders/{orderId}/cancel
      operations:
      - name: cancelorder
        method: POST
        description: Cancel an order
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: bearer
      token: '{{env.ORACLE_RETAIL_API_KEY}}'
  exposes:
  - type: rest
    namespace: order-management-orders-rest
    port: 8080
    description: REST adapter for Oracle Retail Order Management Suite Cloud Service API — Orders. One Spectral-compliant
      resource per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/orders
      name: orders
      description: REST surface for orders.
      operations:
      - method: GET
        name: listorders
        description: List orders
        call: order-management-orders.listorders
        with:
          status: rest.status
          channelId: rest.channelId
          customerId: rest.customerId
          fromDate: rest.fromDate
          toDate: rest.toDate
          offset: rest.offset
          limit: rest.limit
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createorder
        description: Create an order
        call: order-management-orders.createorder
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/orders/{orderid}
      name: orders-orderid
      description: REST surface for orders-orderId.
      operations:
      - method: GET
        name: getorder
        description: Get an order
        call: order-management-orders.getorder
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updateorder
        description: Update an order
        call: order-management-orders.updateorder
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/orders/{orderid}/cancel
      name: orders-orderid-cancel
      description: REST surface for orders-orderId-cancel.
      operations:
      - method: POST
        name: cancelorder
        description: Cancel an order
        call: order-management-orders.cancelorder
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: order-management-orders-mcp
    port: 9090
    transport: http
    description: MCP adapter for Oracle Retail Order Management Suite Cloud Service API — Orders. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: list-orders
      description: List orders
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: order-management-orders.listorders
      with:
        status: tools.status
        channelId: tools.channelId
        customerId: tools.customerId
        fromDate: tools.fromDate
        toDate: tools.toDate
        offset: tools.offset
        limit: tools.limit
      outputParameters:
      - type: object
        mapping: $.
    - name: create-order
      description: Create an order
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: order-management-orders.createorder
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-order
      description: Get an order
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: order-management-orders.getorder
      outputParameters:
      - type: object
        mapping: $.
    - name: update-order
      description: Update an order
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: order-management-orders.updateorder
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: cancel-order
      description: Cancel an order
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: order-management-orders.cancelorder
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.