SAP Sales and Distribution (SD) SAP Sales Order API — Sales Order Header

naftiko: 1.0.0-alpha2
info:
  label: SAP Sales and Distribution (SD) SAP Sales Order API — Sales Order Header
  description: 'SAP Sales and Distribution (SD) SAP Sales Order API — Sales Order Header. 5 operations. Lead operation: Retrieve
    a list of sales orders. Self-contained Naftiko capability covering one Sap Sales And Distribution Sd business surface.'
  tags:
  - Sap Sales And Distribution Sd
  - Sales Order Header
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SAP_SALES_AND_DISTRIBUTION_SD_API_KEY: SAP_SALES_AND_DISTRIBUTION_SD_API_KEY
capability:
  consumes:
  - type: http
    namespace: sap-sd-sales-order-sales-order-header
    baseUri: https://sandbox.api.sap.com/s4hanacloud/sap/opu/odata/sap/API_SALES_ORDER_SRV
    description: SAP Sales and Distribution (SD) SAP Sales Order API — Sales Order Header business capability. Self-contained,
      no shared references.
    resources:
    - name: A_SalesOrder
      path: /A_SalesOrder
      operations:
      - name: listsalesorders
        method: GET
        description: Retrieve a list of sales orders
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createsalesorder
        method: POST
        description: 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: Retrieve a single sales order
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: SalesOrder
          in: path
          type: string
          description: Sales order number (10 characters)
          required: true
      - name: updatesalesorder
        method: PATCH
        description: Update a sales order
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: SalesOrder
          in: path
          type: string
          description: Sales order number (10 characters)
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletesalesorder
        method: DELETE
        description: Delete a sales order
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: SalesOrder
          in: path
          type: string
          description: Sales order number (10 characters)
          required: true
    authentication:
      type: bearer
      token: '{{env.SAP_SALES_AND_DISTRIBUTION_SD_API_KEY}}'
  exposes:
  - type: rest
    namespace: sap-sd-sales-order-sales-order-header-rest
    port: 8080
    description: REST adapter for SAP Sales and Distribution (SD) SAP Sales Order API — Sales Order Header. 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: Retrieve a list of sales orders
        call: sap-sd-sales-order-sales-order-header.listsalesorders
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createsalesorder
        description: Create a new sales order
        call: sap-sd-sales-order-sales-order-header.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: Retrieve a single sales order
        call: sap-sd-sales-order-sales-order-header.getsalesorder
        with:
          SalesOrder: rest.SalesOrder
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updatesalesorder
        description: Update a sales order
        call: sap-sd-sales-order-sales-order-header.updatesalesorder
        with:
          SalesOrder: rest.SalesOrder
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletesalesorder
        description: Delete a sales order
        call: sap-sd-sales-order-sales-order-header.deletesalesorder
        with:
          SalesOrder: rest.SalesOrder
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: sap-sd-sales-order-sales-order-header-mcp
    port: 9090
    transport: http
    description: MCP adapter for SAP Sales and Distribution (SD) SAP Sales Order API — Sales Order Header. One tool per consumed
      operation, routed inline through this capability's consumes block.
    tools:
    - name: retrieve-list-sales-orders
      description: Retrieve a list of sales orders
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: sap-sd-sales-order-sales-order-header.listsalesorders
      outputParameters:
      - type: object
        mapping: $.
    - name: create-new-sales-order
      description: Create a new sales order
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: sap-sd-sales-order-sales-order-header.createsalesorder
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-single-sales-order
      description: Retrieve a single sales order
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: sap-sd-sales-order-sales-order-header.getsalesorder
      with:
        SalesOrder: tools.SalesOrder
      outputParameters:
      - type: object
        mapping: $.
    - name: update-sales-order
      description: Update a sales order
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: sap-sd-sales-order-sales-order-header.updatesalesorder
      with:
        SalesOrder: tools.SalesOrder
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-sales-order
      description: Delete a sales order
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: sap-sd-sales-order-sales-order-header.deletesalesorder
      with:
        SalesOrder: tools.SalesOrder
      outputParameters:
      - type: object
        mapping: $.