Oracle Retail Merchandising Foundation Cloud Service API — PurchaseOrders

naftiko: 1.0.0-alpha2
info:
  label: Oracle Retail Merchandising Foundation Cloud Service API — PurchaseOrders
  description: 'Oracle Retail Merchandising Foundation Cloud Service API — PurchaseOrders. 3 operations. Lead operation: List
    purchase orders. Self-contained Naftiko capability covering one Oracle Retail business surface.'
  tags:
  - Oracle Retail
  - PurchaseOrders
  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: merchandising-purchaseorders
    baseUri: https://{host}/MerchServices/MerchRes/v1
    description: Oracle Retail Merchandising Foundation Cloud Service API — PurchaseOrders business capability. Self-contained,
      no shared references.
    resources:
    - name: purchaseorders
      path: /purchaseorders
      operations:
      - name: listpurchaseorders
        method: GET
        description: List purchase orders
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: status
          in: query
          type: string
          description: Filter by order status
        - name: supplier
          in: query
          type: integer
          description: Filter by supplier number
        - name: fromDate
          in: query
          type: string
          description: Filter orders not before this date (YYYY-MM-DD)
        - name: toDate
          in: query
          type: string
          description: Filter orders not after this date (YYYY-MM-DD)
        - name: offset
          in: query
          type: integer
        - name: limit
          in: query
          type: integer
      - name: createpurchaseorder
        method: POST
        description: Create a purchase order
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: purchaseorders-orderId
      path: /purchaseorders/{orderId}
      operations:
      - name: getpurchaseorder
        method: GET
        description: Get a purchase order
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orderId
          in: path
          type: integer
          required: true
    authentication:
      type: bearer
      token: '{{env.ORACLE_RETAIL_API_KEY}}'
  exposes:
  - type: rest
    namespace: merchandising-purchaseorders-rest
    port: 8080
    description: REST adapter for Oracle Retail Merchandising Foundation Cloud Service API — PurchaseOrders. One Spectral-compliant
      resource per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/purchaseorders
      name: purchaseorders
      description: REST surface for purchaseorders.
      operations:
      - method: GET
        name: listpurchaseorders
        description: List purchase orders
        call: merchandising-purchaseorders.listpurchaseorders
        with:
          status: rest.status
          supplier: rest.supplier
          fromDate: rest.fromDate
          toDate: rest.toDate
          offset: rest.offset
          limit: rest.limit
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createpurchaseorder
        description: Create a purchase order
        call: merchandising-purchaseorders.createpurchaseorder
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/purchaseorders/{orderid}
      name: purchaseorders-orderid
      description: REST surface for purchaseorders-orderId.
      operations:
      - method: GET
        name: getpurchaseorder
        description: Get a purchase order
        call: merchandising-purchaseorders.getpurchaseorder
        with:
          orderId: rest.orderId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: merchandising-purchaseorders-mcp
    port: 9090
    transport: http
    description: MCP adapter for Oracle Retail Merchandising Foundation Cloud Service API — PurchaseOrders. One tool per consumed
      operation, routed inline through this capability's consumes block.
    tools:
    - name: list-purchase-orders
      description: List purchase orders
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: merchandising-purchaseorders.listpurchaseorders
      with:
        status: tools.status
        supplier: tools.supplier
        fromDate: tools.fromDate
        toDate: tools.toDate
        offset: tools.offset
        limit: tools.limit
      outputParameters:
      - type: object
        mapping: $.
    - name: create-purchase-order
      description: Create a purchase order
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: merchandising-purchaseorders.createpurchaseorder
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-purchase-order
      description: Get a purchase order
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: merchandising-purchaseorders.getpurchaseorder
      with:
        orderId: tools.orderId
      outputParameters:
      - type: object
        mapping: $.