WooCommerce REST API — Reports

naftiko: 1.0.0-alpha2
info:
  label: WooCommerce REST API — Reports
  description: 'WooCommerce REST API — Reports. 1 operations. Lead operation: WooCommerce Retrieve a Sales Report. Self-contained
    Naftiko capability covering one Woocommerce business surface.'
  tags:
  - Woocommerce
  - Reports
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    WOOCOMMERCE_API_KEY: WOOCOMMERCE_API_KEY
capability:
  consumes:
  - type: http
    namespace: rest-reports
    baseUri: https://example.com/wp-json/wc/v3
    description: WooCommerce REST API — Reports business capability. Self-contained, no shared references.
    resources:
    - name: reports-sales
      path: /reports/sales
      operations:
      - name: getsalesreport
        method: GET
        description: WooCommerce Retrieve a Sales Report
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: period
          in: query
          type: string
          description: 'Report period shortcut. Options: week, month, last_month, year.'
    authentication:
      type: basic
      username: '{{env.WOOCOMMERCE_USER}}'
      password: '{{env.WOOCOMMERCE_PASS}}'
  exposes:
  - type: rest
    namespace: rest-reports-rest
    port: 8080
    description: REST adapter for WooCommerce REST API — Reports. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/reports/sales
      name: reports-sales
      description: REST surface for reports-sales.
      operations:
      - method: GET
        name: getsalesreport
        description: WooCommerce Retrieve a Sales Report
        call: rest-reports.getsalesreport
        with:
          period: rest.period
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: rest-reports-mcp
    port: 9090
    transport: http
    description: MCP adapter for WooCommerce REST API — Reports. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: woocommerce-retrieve-sales-report
      description: WooCommerce Retrieve a Sales Report
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rest-reports.getsalesreport
      with:
        period: tools.period
      outputParameters:
      - type: object
        mapping: $.