Magento REST API — Orders

naftiko: 1.0.0-alpha2
info:
  label: Magento REST API — Orders
  description: 'Magento REST API — Orders. 5 operations. Lead operation: List orders. Self-contained Naftiko capability covering
    one Magento business surface.'
  tags:
  - Magento
  - Orders
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    MAGENTO_API_KEY: MAGENTO_API_KEY
capability:
  consumes:
  - type: http
    namespace: rest-orders
    baseUri: https://{store_domain}/rest/{store_code}
    description: Magento REST API — Orders business capability. Self-contained, no shared references.
    resources:
    - name: V1-orders
      path: /V1/orders
      operations:
      - name: listorders
        method: GET
        description: List 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: V1-orders-orderId
      path: /V1/orders/{orderId}
      operations:
      - name: getorder
        method: GET
        description: Get order by ID
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: V1-orders-orderId-cancel
      path: /V1/orders/{orderId}/cancel
      operations:
      - name: cancelorder
        method: POST
        description: Cancel an order
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: V1-orders-orderId-comments
      path: /V1/orders/{orderId}/comments
      operations:
      - name: addordercomment
        method: POST
        description: Add a comment to an order
        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.MAGENTO_API_KEY}}'
  exposes:
  - type: rest
    namespace: rest-orders-rest
    port: 8080
    description: REST adapter for Magento REST API — Orders. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/v1/orders
      name: v1-orders
      description: REST surface for V1-orders.
      operations:
      - method: GET
        name: listorders
        description: List orders
        call: rest-orders.listorders
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createorder
        description: Create an order
        call: rest-orders.createorder
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/orders/{orderid}
      name: v1-orders-orderid
      description: REST surface for V1-orders-orderId.
      operations:
      - method: GET
        name: getorder
        description: Get order by ID
        call: rest-orders.getorder
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/orders/{orderid}/cancel
      name: v1-orders-orderid-cancel
      description: REST surface for V1-orders-orderId-cancel.
      operations:
      - method: POST
        name: cancelorder
        description: Cancel an order
        call: rest-orders.cancelorder
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v1/orders/{orderid}/comments
      name: v1-orders-orderid-comments
      description: REST surface for V1-orders-orderId-comments.
      operations:
      - method: POST
        name: addordercomment
        description: Add a comment to an order
        call: rest-orders.addordercomment
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: rest-orders-mcp
    port: 9090
    transport: http
    description: MCP adapter for Magento REST API — Orders. One tool per consumed operation, routed inline through this capability's
      consumes block.
    tools:
    - name: list-orders
      description: List orders
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-orders.listorders
      outputParameters:
      - type: object
        mapping: $.
    - name: create-order
      description: Create an order
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-orders.createorder
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-order-id
      description: Get order by ID
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-orders.getorder
      outputParameters:
      - type: object
        mapping: $.
    - name: cancel-order
      description: Cancel an order
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-orders.cancelorder
      outputParameters:
      - type: object
        mapping: $.
    - name: add-comment-order
      description: Add a comment to an order
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-orders.addordercomment
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.