WooCommerce REST API — Order Notes

naftiko: 1.0.0-alpha2
info:
  label: WooCommerce REST API — Order Notes
  description: 'WooCommerce REST API — Order Notes. 4 operations. Lead operation: WooCommerce List All Order Notes. Self-contained
    Naftiko capability covering one Woocommerce business surface.'
  tags:
  - Woocommerce
  - Order Notes
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    WOOCOMMERCE_API_KEY: WOOCOMMERCE_API_KEY
capability:
  consumes:
  - type: http
    namespace: rest-order-notes
    baseUri: https://example.com/wp-json/wc/v3
    description: WooCommerce REST API — Order Notes business capability. Self-contained, no shared references.
    resources:
    - name: orders-order_id-notes
      path: /orders/{order_id}/notes
      operations:
      - name: listordernotes
        method: GET
        description: WooCommerce List All Order Notes
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: type
          in: query
          type: string
          description: 'Limit results to a note type. Options: any, customer, internal.'
      - name: createordernote
        method: POST
        description: WooCommerce Create an Order Note
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: orders-order_id-notes-id
      path: /orders/{order_id}/notes/{id}
      operations:
      - name: getordernote
        method: GET
        description: WooCommerce Retrieve an Order Note
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deleteordernote
        method: DELETE
        description: WooCommerce Delete an Order Note
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: basic
      username: '{{env.WOOCOMMERCE_USER}}'
      password: '{{env.WOOCOMMERCE_PASS}}'
  exposes:
  - type: rest
    namespace: rest-order-notes-rest
    port: 8080
    description: REST adapter for WooCommerce REST API — Order Notes. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/orders/{order-id}/notes
      name: orders-order-id-notes
      description: REST surface for orders-order_id-notes.
      operations:
      - method: GET
        name: listordernotes
        description: WooCommerce List All Order Notes
        call: rest-order-notes.listordernotes
        with:
          type: rest.type
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createordernote
        description: WooCommerce Create an Order Note
        call: rest-order-notes.createordernote
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/orders/{order-id}/notes/{id}
      name: orders-order-id-notes-id
      description: REST surface for orders-order_id-notes-id.
      operations:
      - method: GET
        name: getordernote
        description: WooCommerce Retrieve an Order Note
        call: rest-order-notes.getordernote
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteordernote
        description: WooCommerce Delete an Order Note
        call: rest-order-notes.deleteordernote
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: rest-order-notes-mcp
    port: 9090
    transport: http
    description: MCP adapter for WooCommerce REST API — Order Notes. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: woocommerce-list-all-order-notes
      description: WooCommerce List All Order Notes
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-order-notes.listordernotes
      with:
        type: tools.type
      outputParameters:
      - type: object
        mapping: $.
    - name: woocommerce-create-order-note
      description: WooCommerce Create an Order Note
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rest-order-notes.createordernote
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: woocommerce-retrieve-order-note
      description: WooCommerce Retrieve an Order Note
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-order-notes.getordernote
      outputParameters:
      - type: object
        mapping: $.
    - name: woocommerce-delete-order-note
      description: WooCommerce Delete an Order Note
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: rest-order-notes.deleteordernote
      outputParameters:
      - type: object
        mapping: $.