https://github.com/wtx-labs/woocommerce-api-client-java
The WooCommerce REST API Client for Java provides easy access to the features of the e-commerce platform's API.
https://github.com/wtx-labs/woocommerce-api-client-java
api api-client apiclient integration integrations java-client java-client-sdk rest rest-api restapi woocommerce woocommerce-extension woocommerce-plugin woocommerce-shop
Last synced: 3 months ago
JSON representation
The WooCommerce REST API Client for Java provides easy access to the features of the e-commerce platform's API.
- Host: GitHub
- URL: https://github.com/wtx-labs/woocommerce-api-client-java
- Owner: wtx-labs
- Created: 2024-12-26T19:33:28.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-02-07T09:19:38.000Z (3 months ago)
- Last Synced: 2025-02-07T10:25:30.092Z (3 months ago)
- Topics: api, api-client, apiclient, integration, integrations, java-client, java-client-sdk, rest, rest-api, restapi, woocommerce, woocommerce-extension, woocommerce-plugin, woocommerce-shop
- Language: Java
- Homepage:
- Size: 89.8 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# The WooCommerce REST API Client for Java
Effortlessly integrate your Java applications with WooCommerce using our REST API client! 🚀
This library provides an intuitive and developer-friendly way to interact with the latest **WooCommerce REST API (v3)**, allowing seamless access to store data and operations.
## 🚨 Project Status
> ⚠️ **Note: This is an early development version!**
>
> We are actively expanding the API coverage to support more WooCommerce features.
> Contributions and feedback are welcome!
## 📦 Version Information
- **Current Version**: `0.1.3-alpha-20250212`
- **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
### 1️⃣ Installation
Clone this repository and build the library using Maven:
```sh
git clone https://github.com/wtx-labs/woocommerce-api-client-java.git
cd woocommerce-api-client-java
mvn clean install
```
After a successful build, add the generated artifact as a dependency in your Java project:
```xml
wtx.woocommerce
woocommerce-api-client
0.1.3-alpha-20250212
```
### 2️⃣ Usage Example
Easily fetch WooCommerce customer data:
```java
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 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.");
}
}
```
## 🔗 Stay Connected
- ✨ We're constantly improving this client with new features!
- 💡 Have suggestions or need help? Open an issue or contribute!
🚀 Happy coding! 😊
**Your WTX Labs Team** 🚀