Woocommerce MCP Server

🚀 WordPress and WooCommerce JSON-RPC Interface Documentation

This documentation provides a comprehensive guide to the JSON-RPC interfaces of WordPress and WooCommerce, enabling developers to interact with WordPress sites and WooCommerce stores programmatically.

🚀 Quick Start

Prerequisites

• A WordPress site with the WooCommerce plugin installed.
• API access keys (Consumer Key and Consumer Secret) for authentication.

Authentication

• Use the generated API access keys to authenticate your requests.
• Include the keys in the request headers or parameters as required.

✨ Features

• WordPress API: Create, read, update, and delete posts, pages, and users.
• WooCommerce API: Manage products, orders, payments, and reports.
• JSON-RPC Protocol: Standardized protocol for remote procedure calls.

📦 Installation

• Install the WooCommerce plugin on your WordPress site.
• Generate API access keys in the WooCommerce settings.

💻 Usage Examples

WordPress API Examples

Basic Usage

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "create_post",
  "params": {
    "siteUrl": "https://your-wordpress-site.com",
    "username": "your-wordpress-ainer",
    "password": "your-wordpress-password",
    "title": "My New Blog Post",
    "content": "This is the content of my new blog post.",
    "status": "publish"
  }
}

WooCommerce API Examples

Get Products

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "get_products",
  "params": {
    "perPage": 20,
    "page": 1,
    "filters": {
      "category": 19,
      "status": "publish"
    }
  }
}

Create Product

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "create_product",
  "params": {
    "productData": {
      "name": "Premium T-Shirt",
      "type": "simple",
      "regular_price": "29.99",
      "description": "Comfortable cotton t-shirt, available in various sizes.",
      "short_description": "Premium quality t-shirt.",
      "categories": [
        {
          "id": 19
        }
      ],
      "images": [
        {
          "src": "http://example.com/wp-content/uploads/2023/05/shirt.jpg"
        }
      ]
    }
  }
}

📚 Documentation

WordPress API Methods

Common Methods

• create_post: Create a new post.
• get_posts: Get a list of posts.
• update_post: Update an existing post.
• delete_post: Delete a post.
• create_page: Create a new page.
• get_pages: Get a list of pages.
• update_page: Update an existing page.
• delete_page: Delete a page.

WooCommerce Product Methods

Common Methods

• get_products: Get all products.
• create_product: Create a new product.
• update_product: Update an existing product.
• delete_product: Delete a product.
• get_product_variations: Get product variations.
• create_product_variation: Create a new product variation.
• update_product_variation: Update an existing product variation.
• delete_product_variation: Delete a product variation.

Parameter Explanation

• siteUrl: (Optional, if set in the environment) WordPress site URL.
• consumerKey: (Optional, if set in the environment) WooCommerce consumer key.
• consumerSecret: (Optional, if set in the environment) WooCommerce consumer secret.
• username: (Optional, if set in the environment) WordPress username.
• password: (Optional, if set in the environment) WordPress password.

WooCommerce Order Methods

Common Methods

• create_order: Create a new order.
• get_orders: Get all orders.
• update_order: Update an existing order.
• delete_order: Delete an order.

WooCommerce Payment Gateway Methods

Common Methods

• process_payment: Process a payment.
• refund_payment: Refund a payment.
• capture_payment: Capture a payment.
• void_payment: Void a payment.

WooCommerce Report and Analysis Methods

Common Methods

• get_sales_report: Get a sales report.
• get_orders_by_date: Get orders by date.
• get_top_selling_products: Get the top-selling products.
• get_customer_segments: Get customer segments.

WooCommerce User Methods

Common Methods

• create_user: Create a new user.
• get_users: Get all users.
• update_user: Update an existing user.
• delete_user: Delete a user.

WooCommerce Settings Methods

Common Methods

• get_settings: Get all settings.
• update_settings: Update existing settings.
• delete_settings: Delete settings.

WooCommerce Security and Authentication

Common Methods

• authenticate: Authenticate a user.
• authorize: Authorize access.
• invalidate_token: Invalidate a token.
• refresh_token: Refresh a token.

WooCommerce Plugins and Extensions

Common Methods

• activate_plugin: Activate a plugin.
• deactivate_plugin: Deactivate a plugin.
• delete_plugin: Delete a plugin.
• update_plugin: Update a plugin.

WooCommerce Database and Performance Optimization

Common Methods

• optimize_database: Optimize the database.
• flush_cache: Flush the cache.
• clear_logs: Clear the logs.
• reindex_search: Reindex the search.

WooCommerce API Error Handling

Common Methods

• handle_error: Handle an error.
• log_error: Log an error.
• recover_from_error: Recover from an error.
• display_error: Display an error.

WooCommerce API Performance Monitoring

Common Methods

• monitor_performance: Monitor performance.
• log_activity: Log activity.
• track_error: Track errors.
• report_usage: Report usage.

WooCommerce API Security Recommendations

• Use HTTPS to encrypt communication.
• Validate all input data.
• Implement rate limiting to prevent abuse.
• Regularly update software and plugins.
• Backup data regularly.
• Monitor logs and alerts.
• Limit API access permissions.
• Use strong passwords and authentication.
• Avoid transmitting sensitive information in plain text.
• Conduct regular security audits.

🔧 Technical Details

JSON-RPC Protocol

• The JSON-RPC protocol is used for remote procedure calls.
• Each request contains a jsonrpc version, a unique id, a method name, and params.
• Responses contain the id of the corresponding request and the result or error.

Authentication

• Use API access keys (Consumer Key and Consumer Secret) for authentication.
• Include the keys in the request headers or parameters as required.

Error Handling

• Errors are returned in the JSON-RPC response with an error object containing a code and message.
• Handle errors gracefully in your application to provide a better user experience.

📄 License

This project is licensed under the [License Name] license. See the LICENSE file for details.

⚠️ Important Note

Before using in a production environment, ensure that all API calls are properly tested and appropriate security measures are taken, such as using HTTPS and strong authentication mechanisms, to protect sensitive data from unauthorized access.