SAP Commerce Cloud Commerce Web Services API — Users

naftiko: 1.0.0-alpha2
info:
  label: SAP Commerce Cloud Commerce Web Services API — Users
  description: 'SAP Commerce Cloud Commerce Web Services API — Users. 5 operations. Lead operation: SAP Commerce Cloud Register
    a new user. Self-contained Naftiko capability covering one Sap Commerce Cloud business surface.'
  tags:
  - Sap Commerce Cloud
  - Users
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SAP_COMMERCE_CLOUD_API_KEY: SAP_COMMERCE_CLOUD_API_KEY
capability:
  consumes:
  - type: http
    namespace: commerce-web-services-users
    baseUri: https://{tenant}.{region}.commercecloud.sap/occ/v2/{baseSiteId}
    description: SAP Commerce Cloud Commerce Web Services API — Users business capability. Self-contained, no shared references.
    resources:
    - name: users
      path: /users
      operations:
      - name: registeruser
        method: POST
        description: SAP Commerce Cloud Register a new user
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: users-userId
      path: /users/{userId}
      operations:
      - name: getuser
        method: GET
        description: SAP Commerce Cloud Get user profile
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateuser
        method: PUT
        description: SAP Commerce Cloud Update user profile
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteuser
        method: DELETE
        description: SAP Commerce Cloud Delete user account
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: users-userId-paymentdetails
      path: /users/{userId}/paymentdetails
      operations:
      - name: getuserpaymentdetails
        method: GET
        description: SAP Commerce Cloud List user payment details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: bearer
      token: '{{env.SAP_COMMERCE_CLOUD_API_KEY}}'
  exposes:
  - type: rest
    namespace: commerce-web-services-users-rest
    port: 8080
    description: REST adapter for SAP Commerce Cloud Commerce Web Services API — Users. One Spectral-compliant resource per
      consumed operation, prefixed with /v1.
    resources:
    - path: /v1/users
      name: users
      description: REST surface for users.
      operations:
      - method: POST
        name: registeruser
        description: SAP Commerce Cloud Register a new user
        call: commerce-web-services-users.registeruser
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/users/{userid}
      name: users-userid
      description: REST surface for users-userId.
      operations:
      - method: GET
        name: getuser
        description: SAP Commerce Cloud Get user profile
        call: commerce-web-services-users.getuser
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateuser
        description: SAP Commerce Cloud Update user profile
        call: commerce-web-services-users.updateuser
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteuser
        description: SAP Commerce Cloud Delete user account
        call: commerce-web-services-users.deleteuser
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/users/{userid}/paymentdetails
      name: users-userid-paymentdetails
      description: REST surface for users-userId-paymentdetails.
      operations:
      - method: GET
        name: getuserpaymentdetails
        description: SAP Commerce Cloud List user payment details
        call: commerce-web-services-users.getuserpaymentdetails
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: commerce-web-services-users-mcp
    port: 9090
    transport: http
    description: MCP adapter for SAP Commerce Cloud Commerce Web Services API — Users. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: sap-commerce-cloud-register-new
      description: SAP Commerce Cloud Register a new user
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: commerce-web-services-users.registeruser
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: sap-commerce-cloud-get-user
      description: SAP Commerce Cloud Get user profile
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: commerce-web-services-users.getuser
      outputParameters:
      - type: object
        mapping: $.
    - name: sap-commerce-cloud-update-user
      description: SAP Commerce Cloud Update user profile
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: commerce-web-services-users.updateuser
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: sap-commerce-cloud-delete-user
      description: SAP Commerce Cloud Delete user account
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: commerce-web-services-users.deleteuser
      outputParameters:
      - type: object
        mapping: $.
    - name: sap-commerce-cloud-list-user
      description: SAP Commerce Cloud List user payment details
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: commerce-web-services-users.getuserpaymentdetails
      outputParameters:
      - type: object
        mapping: $.