SAP Sales and Distribution (SD) SAP Customer Material API — Customer Material

naftiko: 1.0.0-alpha2
info:
  label: SAP Sales and Distribution (SD) SAP Customer Material API — Customer Material
  description: 'SAP Sales and Distribution (SD) SAP Customer Material API — Customer Material. 5 operations. Lead operation:
    Retrieve a list of customer material records. Self-contained Naftiko capability covering one Sap Sales And Distribution
    Sd business surface.'
  tags:
  - Sap Sales And Distribution Sd
  - Customer Material
  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-customer-material-customer-material
    baseUri: https://sandbox.api.sap.com/s4hanacloud/sap/opu/odata/sap/API_CUSTOMER_MATERIAL_SRV
    description: SAP Sales and Distribution (SD) SAP Customer Material API — Customer Material business capability. Self-contained,
      no shared references.
    resources:
    - name: A_CustomerMaterial
      path: /A_CustomerMaterial
      operations:
      - name: listcustomermaterials
        method: GET
        description: Retrieve a list of customer material records
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createcustomermaterial
        method: POST
        description: Create a customer material record
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: A_CustomerMaterial(SalesOrganization='{SalesOrganization}',DistributionChannel='
      path: /A_CustomerMaterial(SalesOrganization='{SalesOrganization}',DistributionChannel='{DistributionChannel}',Customer='{Customer}',Material='{Material}')
      operations:
      - name: getcustomermaterial
        method: GET
        description: Retrieve a single customer material record
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: SalesOrganization
          in: path
          type: string
          description: Sales organization
          required: true
        - name: DistributionChannel
          in: path
          type: string
          description: Distribution channel
          required: true
        - name: Customer
          in: path
          type: string
          description: Customer number
          required: true
        - name: Material
          in: path
          type: string
          description: Material number
          required: true
      - name: updatecustomermaterial
        method: PATCH
        description: Update a customer material record
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: SalesOrganization
          in: path
          type: string
          required: true
        - name: DistributionChannel
          in: path
          type: string
          required: true
        - name: Customer
          in: path
          type: string
          required: true
        - name: Material
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletecustomermaterial
        method: DELETE
        description: Delete a customer material record
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: SalesOrganization
          in: path
          type: string
          required: true
        - name: DistributionChannel
          in: path
          type: string
          required: true
        - name: Customer
          in: path
          type: string
          required: true
        - name: Material
          in: path
          type: string
          required: true
    authentication:
      type: bearer
      token: '{{env.SAP_SALES_AND_DISTRIBUTION_SD_API_KEY}}'
  exposes:
  - type: rest
    namespace: sap-sd-customer-material-customer-material-rest
    port: 8080
    description: REST adapter for SAP Sales and Distribution (SD) SAP Customer Material API — Customer Material. One Spectral-compliant
      resource per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/a-customermaterial
      name: a-customermaterial
      description: REST surface for A_CustomerMaterial.
      operations:
      - method: GET
        name: listcustomermaterials
        description: Retrieve a list of customer material records
        call: sap-sd-customer-material-customer-material.listcustomermaterials
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createcustomermaterial
        description: Create a customer material record
        call: sap-sd-customer-material-customer-material.createcustomermaterial
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/a-customermaterial-salesorganization-salesorganization-distributionchannel-distributionchannel-customer-customer-material-material
      name: a-customermaterial-salesorganization-salesorganization-distributionchannel
      description: REST surface for A_CustomerMaterial(SalesOrganization='{SalesOrganization}',DistributionChannel='.
      operations:
      - method: GET
        name: getcustomermaterial
        description: Retrieve a single customer material record
        call: sap-sd-customer-material-customer-material.getcustomermaterial
        with:
          SalesOrganization: rest.SalesOrganization
          DistributionChannel: rest.DistributionChannel
          Customer: rest.Customer
          Material: rest.Material
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updatecustomermaterial
        description: Update a customer material record
        call: sap-sd-customer-material-customer-material.updatecustomermaterial
        with:
          SalesOrganization: rest.SalesOrganization
          DistributionChannel: rest.DistributionChannel
          Customer: rest.Customer
          Material: rest.Material
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletecustomermaterial
        description: Delete a customer material record
        call: sap-sd-customer-material-customer-material.deletecustomermaterial
        with:
          SalesOrganization: rest.SalesOrganization
          DistributionChannel: rest.DistributionChannel
          Customer: rest.Customer
          Material: rest.Material
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: sap-sd-customer-material-customer-material-mcp
    port: 9090
    transport: http
    description: MCP adapter for SAP Sales and Distribution (SD) SAP Customer Material API — Customer Material. One tool per
      consumed operation, routed inline through this capability's consumes block.
    tools:
    - name: retrieve-list-customer-material-records
      description: Retrieve a list of customer material records
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: sap-sd-customer-material-customer-material.listcustomermaterials
      outputParameters:
      - type: object
        mapping: $.
    - name: create-customer-material-record
      description: Create a customer material record
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: sap-sd-customer-material-customer-material.createcustomermaterial
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-single-customer-material-record
      description: Retrieve a single customer material record
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: sap-sd-customer-material-customer-material.getcustomermaterial
      with:
        SalesOrganization: tools.SalesOrganization
        DistributionChannel: tools.DistributionChannel
        Customer: tools.Customer
        Material: tools.Material
      outputParameters:
      - type: object
        mapping: $.
    - name: update-customer-material-record
      description: Update a customer material record
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: sap-sd-customer-material-customer-material.updatecustomermaterial
      with:
        SalesOrganization: tools.SalesOrganization
        DistributionChannel: tools.DistributionChannel
        Customer: tools.Customer
        Material: tools.Material
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-customer-material-record
      description: Delete a customer material record
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: sap-sd-customer-material-customer-material.deletecustomermaterial
      with:
        SalesOrganization: tools.SalesOrganization
        DistributionChannel: tools.DistributionChannel
        Customer: tools.Customer
        Material: tools.Material
      outputParameters:
      - type: object
        mapping: $.