SAP Commerce Cloud Commerce Web Services API — Orders

naftiko: 1.0.0-alpha2
info:
  label: SAP Commerce Cloud Commerce Web Services API — Orders
  description: 'SAP Commerce Cloud Commerce Web Services API — Orders. 3 operations. Lead operation: SAP Commerce Cloud List
    user orders. Self-contained Naftiko capability covering one Sap Commerce Cloud business surface.'
  tags:
  - Sap Commerce Cloud
  - Orders
  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-orders
    baseUri: https://{tenant}.{region}.commercecloud.sap/occ/v2/{baseSiteId}
    description: SAP Commerce Cloud Commerce Web Services API — Orders business capability. Self-contained, no shared references.
    resources:
    - name: users-userId-orders
      path: /users/{userId}/orders
      operations:
      - name: getuserorders
        method: GET
        description: SAP Commerce Cloud List user orders
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: placeorder
        method: POST
        description: SAP Commerce Cloud Place an order
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: cartId
          in: query
          type: string
          description: Cart identifier to convert to order
          required: true
        - name: termsChecked
          in: query
          type: boolean
          description: Whether terms and conditions have been accepted
          required: true
    - name: users-userId-orders-orderCode
      path: /users/{userId}/orders/{orderCode}
      operations:
      - name: getorder
        method: GET
        description: SAP Commerce Cloud Get order details
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: orderCode
          in: path
          type: string
          description: Order code
          required: true
    authentication:
      type: bearer
      token: '{{env.SAP_COMMERCE_CLOUD_API_KEY}}'
  exposes:
  - type: rest
    namespace: commerce-web-services-orders-rest
    port: 8080
    description: REST adapter for SAP Commerce Cloud Commerce Web Services API — Orders. One Spectral-compliant resource per
      consumed operation, prefixed with /v1.
    resources:
    - path: /v1/users/{userid}/orders
      name: users-userid-orders
      description: REST surface for users-userId-orders.
      operations:
      - method: GET
        name: getuserorders
        description: SAP Commerce Cloud List user orders
        call: commerce-web-services-orders.getuserorders
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: placeorder
        description: SAP Commerce Cloud Place an order
        call: commerce-web-services-orders.placeorder
        with:
          cartId: rest.cartId
          termsChecked: rest.termsChecked
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/users/{userid}/orders/{ordercode}
      name: users-userid-orders-ordercode
      description: REST surface for users-userId-orders-orderCode.
      operations:
      - method: GET
        name: getorder
        description: SAP Commerce Cloud Get order details
        call: commerce-web-services-orders.getorder
        with:
          orderCode: rest.orderCode
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: commerce-web-services-orders-mcp
    port: 9090
    transport: http
    description: MCP adapter for SAP Commerce Cloud Commerce Web Services API — Orders. 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 orders
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: commerce-web-services-orders.getuserorders
      outputParameters:
      - type: object
        mapping: $.
    - name: sap-commerce-cloud-place-order
      description: SAP Commerce Cloud Place an order
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: commerce-web-services-orders.placeorder
      with:
        cartId: tools.cartId
        termsChecked: tools.termsChecked
      outputParameters:
      - type: object
        mapping: $.
    - name: sap-commerce-cloud-get-order
      description: SAP Commerce Cloud Get order details
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: commerce-web-services-orders.getorder
      with:
        orderCode: tools.orderCode
      outputParameters:
      - type: object
        mapping: $.