Skip to content

Latest commit

 

History

History
155 lines (105 loc) · 5.09 KB

README.md

File metadata and controls

155 lines (105 loc) · 5.09 KB

WooCommerce Java REST API Client

License: MIT Java Version

A lightweight Java client library for WooCommerce REST API integration. Built for Java developers who need to integrate their applications with WooCommerce e-commerce platform. 🚀

This API client provides a type-safe Java interface for WooCommerce REST API v3, enabling seamless management of:

  • WooCommerce products and inventory
  • Customer data and orders
  • E-commerce operations via REST API

✨ Why Choose This Client?

  • 💡 Type-Safe Java API - fully typed interfaces for WooCommerce REST endpoints
  • 🛡️ Basic Authentication - secure WooCommerce API access
  • 📚 Clear Documentation - comprehensive examples for Java integration
  • 🚀 Wide Java Support - compatible with Java 8 and newer
  • ⚡ OpenAPI Generated - based on our OpenAPI specification developed from official WooCommerce documentation

🎯 Currently Implemented Features

  • ✅ Products API
    • List/search WooCommerce products
    • Create/Read/Update/Delete products
    • Filter products by status, date, stock status
    • Manage product inventory
  • ✅ Customers API
    • List/search WooCommerce customers
    • Create/Read/Update/Delete customers
    • Search and filter customer data
    • Manage customer accounts
  • ✅ Orders API
    • List/search WooCommerce orders
    • Create/Read/Update/Delete orders
    • Filter orders by status and date
    • Process order management

🚨 Project Status

⚠️ Note: This is an early development version!

We are actively implementing more WooCommerce API features. Contributions and feedback are welcome on GitHub!

📦 Version Information

  • Current Version: 0.1.5-alpha-20250412
  • Supported WooCommerce API Version: v3
  • Java Compatibility: Java 8+

🔓 License

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files, to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the software.

The only requirement is to preserve the original author attribution in the source code and documentation.

🚀 Quick Start Guide

1️⃣ Installation

Clone and build the library from source:

git clone https://github.com/wtx-labs/woocommerce-api-client-java.git
cd woocommerce-api-client-java
mvn clean install

Then add the locally built artifact to your project:

<dependency>
    <groupId>wtx.woocommerce</groupId>
    <artifactId>woocommerce-api-client</artifactId>
    <version>0.1.5-alpha-20250412</version>
</dependency>

2️⃣ Java Integration Example

Here's how to fetch WooCommerce customer data using the client:

package wtx.woocommerce;

import java.util.List;

import wtx.woocommerce.api.client.CustomersApi;
import wtx.woocommerce.api.client.invoker.ApiException;
import wtx.woocommerce.api.client.model.Customer;

public class WooCommerceApiClientUsageDemo {

    // TODO: Set your WooCommerce API base path!
    private static final String API_BASE_PATH = "https://your-woocommerce-shop.com/wp-json/wc/v3";
    private static final String API_USERNAME = "TODO_SET_API_USERNAME";
    private static final String API_PASSWORD = "TODO_SET_API_PASSWORD";

    public static void main(String[] args) {

        System.out.println(">>> Start running the WooCommerceApiClientUsageDemo...");

        // Use WooCommerceApiClient(true) if you need to log API communication messages.
        WooCommerceApiClient apiClient = new WooCommerceApiClient();

        apiClient.setBasePath(API_BASE_PATH);
        apiClient.setUsername(API_USERNAME);
        apiClient.setPassword(API_PASSWORD);

        CustomersApi customersApi = new CustomersApi(apiClient);

        try {

            List<Customer> customers = customersApi.listAllCustomers(
                null, null, null, null, null, null, null, null, null, null, null
            );

            // Example list of customer's emails:
            customers.forEach(customer -> System.out.println("Customer: " + customer.getEmail()));

        } catch (ApiException e) {
            System.err.println("Error occurred during API call: " + e);
        }

        System.out.println("<<< The WooCommerceApiClientUsageDemo has been finished.");

    }

}

🔗 Get Involved

  • ✨ Check our GitHub Issues for latest updates
  • 💡 Have suggestions? Open an Issue or contribute to the project
  • 🌟 Star this repository if you find it helpful!

📊 Project Statistics

  • ⭐ 2 GitHub stars
  • 🔄 Regular updates and improvements
  • 👥 Open for community contributions

🔍 Keywords

woocommerce java client, woocommerce rest api java, java woocommerce integration, woocommerce api v3 java, e-commerce java integration, woocommerce java library, java rest api client woocommerce

🚀 Happy coding! 😊

Your WTX Labs Team 🚀