WooCommerce System Status API

openapi: 3.2.0
info:
  title: WooCommerce REST System Status API
  description: The WooCommerce REST API is the primary server-side interface for reading and writing WooCommerce store data programmatically.
  version: v3
  contact:
    name: WooCommerce Developer Support
    url: https://developer.woocommerce.com/docs/apis/rest-api/
  termsOfService: https://woocommerce.com/terms-conditions/
servers:
- url: https://example.com/wp-json/wc/v3
  description: Production Server (replace example.com with your store domain)
security:
- basicAuth: []
tags:
- name: System Status
  description: Retrieve system environment, active plugins, and store configuration status
paths:
  /system_status:
    get:
      operationId: getSystemStatus
      summary: WooCommerce Retrieve System Status
      description: Returns detailed information about the WooCommerce store environment including WordPress version, WooCommerce version, PHP version, active plugins, theme, database tables, and security settings.
      tags:
      - System Status
      responses:
        '200':
          description: System status details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SystemStatus'
              examples:
                getSystemStatus200Example:
                  summary: Default getSystemStatus 200 response
                  x-microcks-default: true
                  value:
                    environment:
                      home_url: https://example.com/path
                      site_url: https://example.com/path
                      wc_version: string-value
                      wp_version: string-value
                      php_version: string-value
                      php_memory_limit: string-value
                      php_max_upload_size: string-value
                      mysql_version: string-value
                      log_directory_writable: true
                    active_plugins:
                    - plugin: string-value
                      name: Example Name
                      version: string-value
                      author_name: Example Name
                    theme:
                      name: Example Name
                      version: string-value
                      author_url: https://example.com/path
                      is_child_theme: true
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  responses:
    Unauthorized:
      description: Authentication credentials are missing or invalid.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    SystemStatus:
      type: object
      description: WooCommerce store system status and environment information.
      properties:
        environment:
          type: object
          description: Server environment details including PHP version, memory, and URLs.
          properties:
            home_url:
              type: string
              format: uri
              description: WordPress home URL.
            site_url:
              type: string
              format: uri
              description: WordPress site URL.
            wc_version:
              type: string
              description: Installed WooCommerce version.
            wp_version:
              type: string
              description: Installed WordPress version.
            php_version:
              type: string
              description: PHP version.
            php_memory_limit:
              type: string
              description: PHP memory limit.
            php_max_upload_size:
              type: string
              description: PHP maximum file upload size.
            mysql_version:
              type: string
              description: MySQL or MariaDB version.
            log_directory_writable:
              type: boolean
              description: Whether the WooCommerce log directory is writable.
          example:
            home_url: https://example.com/path
            site_url: https://example.com/path
            wc_version: string-value
            wp_version: string-value
            php_version: string-value
            php_memory_limit: string-value
            php_max_upload_size: string-value
            mysql_version: string-value
            log_directory_writable: true
        active_plugins:
          type: array
          description: List of active WordPress plugins.
          items:
            type: object
            properties:
              plugin:
                type: string
                description: Plugin file path.
              name:
                type: string
                description: Plugin display name.
              version:
                type: string
                description: Plugin version.
              author_name:
                type: string
                description: Plugin author.
          example:
          - plugin: string-value
            name: Example Name
            version: string-value
            author_name: Example Name
        theme:
          type: object
          description: Active WordPress theme details.
          properties:
            name:
              type: string
              description: Theme name.
            version:
              type: string
              description: Theme version.
            author_url:
              type: string
              format: uri
              description: Theme author URL.
            is_child_theme:
              type: boolean
              description: Whether the active theme is a child theme.
          example:
            name: Example Name
            version: string-value
            author_url: https://example.com/path
            is_child_theme: true
    Error:
      type: object
      properties:
        code:
          type: string
          description: Machine-readable error code.
          example: string-value
        message:
          type: string
          description: Human-readable error message.
          example: string-value
        data:
          type: object
          description: Additional error context including HTTP status code.
          properties:
            status:
              type: integer
              description: HTTP status code associated with the error.
          example:
            status: 1
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic Auth using the WooCommerce Consumer Key as the username and Consumer Secret as the password over HTTPS. Over plain HTTP use OAuth 1.0a one-legged authentication instead.
externalDocs:
  description: WooCommerce REST API Documentation
  url: https://woocommerce.github.io/woocommerce-rest-api-docs/