SAP Commerce Cloud Commerce Web Services API — Addresses

naftiko: 1.0.0-alpha2
info:
  label: SAP Commerce Cloud Commerce Web Services API — Addresses
  description: 'SAP Commerce Cloud Commerce Web Services API — Addresses. 5 operations. Lead operation: SAP Commerce Cloud
    List user addresses. Self-contained Naftiko capability covering one Sap Commerce Cloud business surface.'
  tags:
  - Sap Commerce Cloud
  - Addresses
  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-addresses
    baseUri: https://{tenant}.{region}.commercecloud.sap/occ/v2/{baseSiteId}
    description: SAP Commerce Cloud Commerce Web Services API — Addresses business capability. Self-contained, no shared references.
    resources:
    - name: users-userId-addresses
      path: /users/{userId}/addresses
      operations:
      - name: getuseraddresses
        method: GET
        description: SAP Commerce Cloud List user addresses
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createuseraddress
        method: POST
        description: SAP Commerce Cloud Create a user address
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: users-userId-addresses-addressId
      path: /users/{userId}/addresses/{addressId}
      operations:
      - name: getuseraddress
        method: GET
        description: SAP Commerce Cloud Get user address
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateuseraddress
        method: PATCH
        description: SAP Commerce Cloud Update user address
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteuseraddress
        method: DELETE
        description: SAP Commerce Cloud Delete user address
        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-addresses-rest
    port: 8080
    description: REST adapter for SAP Commerce Cloud Commerce Web Services API — Addresses. One Spectral-compliant resource
      per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/users/{userid}/addresses
      name: users-userid-addresses
      description: REST surface for users-userId-addresses.
      operations:
      - method: GET
        name: getuseraddresses
        description: SAP Commerce Cloud List user addresses
        call: commerce-web-services-addresses.getuseraddresses
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createuseraddress
        description: SAP Commerce Cloud Create a user address
        call: commerce-web-services-addresses.createuseraddress
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/users/{userid}/addresses/{addressid}
      name: users-userid-addresses-addressid
      description: REST surface for users-userId-addresses-addressId.
      operations:
      - method: GET
        name: getuseraddress
        description: SAP Commerce Cloud Get user address
        call: commerce-web-services-addresses.getuseraddress
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updateuseraddress
        description: SAP Commerce Cloud Update user address
        call: commerce-web-services-addresses.updateuseraddress
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteuseraddress
        description: SAP Commerce Cloud Delete user address
        call: commerce-web-services-addresses.deleteuseraddress
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: commerce-web-services-addresses-mcp
    port: 9090
    transport: http
    description: MCP adapter for SAP Commerce Cloud Commerce Web Services API — Addresses. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: sap-commerce-cloud-list-user
      description: SAP Commerce Cloud List user addresses
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: commerce-web-services-addresses.getuseraddresses
      outputParameters:
      - type: object
        mapping: $.
    - name: sap-commerce-cloud-create-user
      description: SAP Commerce Cloud Create a user address
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: commerce-web-services-addresses.createuseraddress
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: sap-commerce-cloud-get-user
      description: SAP Commerce Cloud Get user address
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: commerce-web-services-addresses.getuseraddress
      outputParameters:
      - type: object
        mapping: $.
    - name: sap-commerce-cloud-update-user
      description: SAP Commerce Cloud Update user address
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: commerce-web-services-addresses.updateuseraddress
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: sap-commerce-cloud-delete-user
      description: SAP Commerce Cloud Delete user address
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: commerce-web-services-addresses.deleteuseraddress
      outputParameters:
      - type: object
        mapping: $.