Sitecore CDP REST API — Orders

naftiko: 1.0.0-alpha2
info:
  label: Sitecore CDP REST API — Orders
  description: 'Sitecore CDP REST API — Orders. 5 operations. Lead operation: List guest orders. Self-contained Naftiko capability
    covering one Sitecore business surface.'
  tags:
  - Sitecore
  - Orders
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SITECORE_API_KEY: SITECORE_API_KEY
capability:
  consumes:
  - type: http
    namespace: cdp-rest-orders
    baseUri: https://api-engage-eu.sitecorecloud.io
    description: Sitecore CDP REST API — Orders business capability. Self-contained, no shared references.
    resources:
    - name: v2.1-guests-guestRef-orders
      path: /v2.1/guests/{guestRef}/orders
      operations:
      - name: listguestorders
        method: GET
        description: List guest orders
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createorder
        method: POST
        description: Create an order
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: v2.1-guests-guestRef-orders-orderRef
      path: /v2.1/guests/{guestRef}/orders/{orderRef}
      operations:
      - name: getorder
        method: GET
        description: Get an order
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updateorder
        method: PUT
        description: Update an order
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteorder
        method: DELETE
        description: Delete an order
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: basic
      username: '{{env.SITECORE_USER}}'
      password: '{{env.SITECORE_PASS}}'
  exposes:
  - type: rest
    namespace: cdp-rest-orders-rest
    port: 8080
    description: REST adapter for Sitecore CDP REST API — Orders. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/v2-1/guests/{guestref}/orders
      name: v2-1-guests-guestref-orders
      description: REST surface for v2.1-guests-guestRef-orders.
      operations:
      - method: GET
        name: listguestorders
        description: List guest orders
        call: cdp-rest-orders.listguestorders
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createorder
        description: Create an order
        call: cdp-rest-orders.createorder
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v2-1/guests/{guestref}/orders/{orderref}
      name: v2-1-guests-guestref-orders-orderref
      description: REST surface for v2.1-guests-guestRef-orders-orderRef.
      operations:
      - method: GET
        name: getorder
        description: Get an order
        call: cdp-rest-orders.getorder
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updateorder
        description: Update an order
        call: cdp-rest-orders.updateorder
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteorder
        description: Delete an order
        call: cdp-rest-orders.deleteorder
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: cdp-rest-orders-mcp
    port: 9090
    transport: http
    description: MCP adapter for Sitecore CDP REST API — Orders. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: list-guest-orders
      description: List guest orders
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: cdp-rest-orders.listguestorders
      outputParameters:
      - type: object
        mapping: $.
    - name: create-order
      description: Create an order
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: cdp-rest-orders.createorder
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-order
      description: Get an order
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: cdp-rest-orders.getorder
      outputParameters:
      - type: object
        mapping: $.
    - name: update-order
      description: Update an order
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: cdp-rest-orders.updateorder
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-order
      description: Delete an order
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: cdp-rest-orders.deleteorder
      outputParameters:
      - type: object
        mapping: $.