SAP S/4HANA Sales Order API — Sales Orders

naftiko: 1.0.0-alpha2
info:
  label: SAP S/4HANA Sales Order API — Sales Orders
  description: 'SAP S/4HANA Sales Order API — Sales Orders. 5 operations. Lead operation: Sap S/4hana Retrieve a List of Sales
    Orders. Self-contained Naftiko capability covering one Sap S4hana business surface.'
  tags:
  - Sap S4hana
  - Sales Orders
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SAP_S4HANA_API_KEY: SAP_S4HANA_API_KEY
capability:
  consumes:
  - type: http
    namespace: sales-order-sales-orders
    baseUri: https://sandbox.api.sap.com/s4hanacloud/sap/opu/odata/sap/API_SALES_ORDER_SRV
    description: SAP S/4HANA Sales Order API — Sales Orders business capability. Self-contained, no shared references.
    resources:
    - name: A_SalesOrder
      path: /A_SalesOrder
      operations:
      - name: listsalesorders
        method: GET
        description: Sap S/4hana Retrieve a List of Sales Orders
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createsalesorder
        method: POST
        description: Sap S/4hana Create a New Sales Order
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: A_SalesOrder('{SalesOrder}')
      path: /A_SalesOrder('{SalesOrder}')
      operations:
      - name: getsalesorder
        method: GET
        description: Sap S/4hana Retrieve a Single Sales Order by Key
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatesalesorder
        method: PATCH
        description: Sap S/4hana Update a Sales Order Header
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletesalesorder
        method: DELETE
        description: Sap S/4hana Delete a Sales Order
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.SAP_S4HANA_API_KEY}}'
  exposes:
  - type: rest
    namespace: sales-order-sales-orders-rest
    port: 8080
    description: REST adapter for SAP S/4HANA Sales Order API — Sales Orders. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/a-salesorder
      name: a-salesorder
      description: REST surface for A_SalesOrder.
      operations:
      - method: GET
        name: listsalesorders
        description: Sap S/4hana Retrieve a List of Sales Orders
        call: sales-order-sales-orders.listsalesorders
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createsalesorder
        description: Sap S/4hana Create a New Sales Order
        call: sales-order-sales-orders.createsalesorder
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/a-salesorder-salesorder
      name: a-salesorder-salesorder
      description: REST surface for A_SalesOrder('{SalesOrder}').
      operations:
      - method: GET
        name: getsalesorder
        description: Sap S/4hana Retrieve a Single Sales Order by Key
        call: sales-order-sales-orders.getsalesorder
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updatesalesorder
        description: Sap S/4hana Update a Sales Order Header
        call: sales-order-sales-orders.updatesalesorder
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletesalesorder
        description: Sap S/4hana Delete a Sales Order
        call: sales-order-sales-orders.deletesalesorder
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: sales-order-sales-orders-mcp
    port: 9090
    transport: http
    description: MCP adapter for SAP S/4HANA Sales Order API — Sales Orders. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: sap-s-4hana-retrieve-list
      description: Sap S/4hana Retrieve a List of Sales Orders
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: sales-order-sales-orders.listsalesorders
      outputParameters:
      - type: object
        mapping: $.
    - name: sap-s-4hana-create-new
      description: Sap S/4hana Create a New Sales Order
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: sales-order-sales-orders.createsalesorder
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: sap-s-4hana-retrieve-single
      description: Sap S/4hana Retrieve a Single Sales Order by Key
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: sales-order-sales-orders.getsalesorder
      outputParameters:
      - type: object
        mapping: $.
    - name: sap-s-4hana-update-sales
      description: Sap S/4hana Update a Sales Order Header
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: sales-order-sales-orders.updatesalesorder
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: sap-s-4hana-delete-sales
      description: Sap S/4hana Delete a Sales Order
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: sales-order-sales-orders.deletesalesorder
      outputParameters:
      - type: object
        mapping: $.