SAP Commerce Cloud Commerce Web Services API — Checkout

naftiko: 1.0.0-alpha2
info:
  label: SAP Commerce Cloud Commerce Web Services API — Checkout
  description: 'SAP Commerce Cloud Commerce Web Services API — Checkout. 7 operations. Lead operation: SAP Commerce Cloud
    Set delivery address. Self-contained Naftiko capability covering one Sap Commerce Cloud business surface.'
  tags:
  - Sap Commerce Cloud
  - Checkout
  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-checkout
    baseUri: https://{tenant}.{region}.commercecloud.sap/occ/v2/{baseSiteId}
    description: SAP Commerce Cloud Commerce Web Services API — Checkout business capability. Self-contained, no shared references.
    resources:
    - name: users-userId-carts-cartId-deliveryaddress
      path: /users/{userId}/carts/{cartId}/deliveryaddress
      operations:
      - name: setcartdeliveryaddress
        method: PUT
        description: SAP Commerce Cloud Set delivery address
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: addressId
          in: query
          type: string
          description: Address identifier
          required: true
      - name: removecartdeliveryaddress
        method: DELETE
        description: SAP Commerce Cloud Remove delivery address
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: users-userId-carts-cartId-deliverymode
      path: /users/{userId}/carts/{cartId}/deliverymode
      operations:
      - name: getcartdeliverymode
        method: GET
        description: SAP Commerce Cloud Get delivery mode
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: setcartdeliverymode
        method: PUT
        description: SAP Commerce Cloud Set delivery mode
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: deliveryModeId
          in: query
          type: string
          description: Delivery mode identifier
          required: true
      - name: removecartdeliverymode
        method: DELETE
        description: SAP Commerce Cloud Remove delivery mode
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: users-userId-carts-cartId-deliverymodes
      path: /users/{userId}/carts/{cartId}/deliverymodes
      operations:
      - name: getcartdeliverymodes
        method: GET
        description: SAP Commerce Cloud List delivery modes
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: users-userId-carts-cartId-paymentdetails
      path: /users/{userId}/carts/{cartId}/paymentdetails
      operations:
      - name: createcartpaymentdetails
        method: POST
        description: SAP Commerce Cloud Create payment details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    authentication:
      type: bearer
      token: '{{env.SAP_COMMERCE_CLOUD_API_KEY}}'
  exposes:
  - type: rest
    namespace: commerce-web-services-checkout-rest
    port: 8080
    description: REST adapter for SAP Commerce Cloud Commerce Web Services API — Checkout. One Spectral-compliant resource
      per consumed operation, prefixed with /v1.
    resources:
    - path: /v1/users/{userid}/carts/{cartid}/deliveryaddress
      name: users-userid-carts-cartid-deliveryaddress
      description: REST surface for users-userId-carts-cartId-deliveryaddress.
      operations:
      - method: PUT
        name: setcartdeliveryaddress
        description: SAP Commerce Cloud Set delivery address
        call: commerce-web-services-checkout.setcartdeliveryaddress
        with:
          addressId: rest.addressId
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: removecartdeliveryaddress
        description: SAP Commerce Cloud Remove delivery address
        call: commerce-web-services-checkout.removecartdeliveryaddress
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/users/{userid}/carts/{cartid}/deliverymode
      name: users-userid-carts-cartid-deliverymode
      description: REST surface for users-userId-carts-cartId-deliverymode.
      operations:
      - method: GET
        name: getcartdeliverymode
        description: SAP Commerce Cloud Get delivery mode
        call: commerce-web-services-checkout.getcartdeliverymode
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: setcartdeliverymode
        description: SAP Commerce Cloud Set delivery mode
        call: commerce-web-services-checkout.setcartdeliverymode
        with:
          deliveryModeId: rest.deliveryModeId
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: removecartdeliverymode
        description: SAP Commerce Cloud Remove delivery mode
        call: commerce-web-services-checkout.removecartdeliverymode
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/users/{userid}/carts/{cartid}/deliverymodes
      name: users-userid-carts-cartid-deliverymodes
      description: REST surface for users-userId-carts-cartId-deliverymodes.
      operations:
      - method: GET
        name: getcartdeliverymodes
        description: SAP Commerce Cloud List delivery modes
        call: commerce-web-services-checkout.getcartdeliverymodes
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/users/{userid}/carts/{cartid}/paymentdetails
      name: users-userid-carts-cartid-paymentdetails
      description: REST surface for users-userId-carts-cartId-paymentdetails.
      operations:
      - method: POST
        name: createcartpaymentdetails
        description: SAP Commerce Cloud Create payment details
        call: commerce-web-services-checkout.createcartpaymentdetails
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: commerce-web-services-checkout-mcp
    port: 9090
    transport: http
    description: MCP adapter for SAP Commerce Cloud Commerce Web Services API — Checkout. One tool per consumed operation,
      routed inline through this capability's consumes block.
    tools:
    - name: sap-commerce-cloud-set-delivery
      description: SAP Commerce Cloud Set delivery address
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: commerce-web-services-checkout.setcartdeliveryaddress
      with:
        addressId: tools.addressId
      outputParameters:
      - type: object
        mapping: $.
    - name: sap-commerce-cloud-remove-delivery
      description: SAP Commerce Cloud Remove delivery address
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: commerce-web-services-checkout.removecartdeliveryaddress
      outputParameters:
      - type: object
        mapping: $.
    - name: sap-commerce-cloud-get-delivery
      description: SAP Commerce Cloud Get delivery mode
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: commerce-web-services-checkout.getcartdeliverymode
      outputParameters:
      - type: object
        mapping: $.
    - name: sap-commerce-cloud-set-delivery-2
      description: SAP Commerce Cloud Set delivery mode
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: commerce-web-services-checkout.setcartdeliverymode
      with:
        deliveryModeId: tools.deliveryModeId
      outputParameters:
      - type: object
        mapping: $.
    - name: sap-commerce-cloud-remove-delivery-2
      description: SAP Commerce Cloud Remove delivery mode
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: commerce-web-services-checkout.removecartdeliverymode
      outputParameters:
      - type: object
        mapping: $.
    - name: sap-commerce-cloud-list-delivery
      description: SAP Commerce Cloud List delivery modes
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: commerce-web-services-checkout.getcartdeliverymodes
      outputParameters:
      - type: object
        mapping: $.
    - name: sap-commerce-cloud-create-payment
      description: SAP Commerce Cloud Create payment details
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: commerce-web-services-checkout.createcartpaymentdetails
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.