WooCommerce API Dart plugin
Official WooSignal WooCommerce package
Build apps for WooCommerce easier with our new package. Our API provides many requests types e.g. getProducts, getOrders and many more. Free to get started, see the simple examples below.
For help getting started with WooSignal, view our online documentation, which offers a more detail guide.
Getting Started
In your flutter project add the dependency:
dependencies:
...
woosignal: ^4.0.2
Usage example
Import woosignal.dart
import 'package:woosignal/woosignal.dart';
Example using WooSignal API for WooCommerce
import 'package:woosignal/woosignal.dart';
...
// EXAMPLE GET PRODUCTS
_getProducts() async {
// Step 1 - Initialize WooSignal
await WooSignal.instance.init(appKey: "your app key");
// Step 2 - Call an API
List<Product> products = await WooSignal.instance.getProducts();
print(products[0].name); // prints a product name
});
}
Available API Requests
WooCommerce - Products
- Get Products
- Retrieve a Product by id
- Update a Product by id
- Delete a Product by id
- Create a Product
- Batch update Products
WooCommerce - Product Variations
- Get Product Variations
- Retrieve a Product Variation by id
WooCommerce - Product Attributes
- Get Product Attributes
WooCommerce - Products Attribute Terms
- Get Products Attribute Terms
See Products Attribute Terms API
WooCommerce - Product Categories
- Get Product Categories
WooCommerce - Products Shipping Classes
- Get Products Shipping Classes
See Products Shipping Classes API
WooCommerce - Product Reviews
- Get Product Reviews
WooCommerce - Tax Rates
- Get Tax Rates
WooCommerce - Tax Classes
- Get Tax Classes
WooCommerce - Shipping Zones
- Get Shipping Zones
- Retrieve a Shipping Zone by id
WooCommerce - Shipping Zone Locations
- Get Shipping Zone Locations
- Retrieve a Shipping Zone Location by id
See Shipping Zone Locations API
WooCommerce - Shipping Methods
- Get Shipping Methods
WooCommerce - Orders
- Get Orders
- Retrieve a Order by id
- Create an Order
- Update an Order
- Batch update Orders
WooCommerce - Customers
- Get Customers
- Create a Customer
- Delete a Customer
- Update a Customer
- Batch update Customers
WooCommerce - API Orders Notes
- List all Orders Notes
- Retrieve a Orders Notes by id
- Delete a Orders Notes by id
- Create a Orders Notes
WooCommerce - Refunds
- Get refunds from an order id
- Retrieve a retrieve and view a specific refund from an order
- Delete a delete an order refund.
- Create a new refund for an order
WooCommerce - Coupons
- Get all coupons.
- Retrieve and view a specific coupon by ID
- Update a coupon.
- Delete a coupon.
- Batch update Coupons.
WooCommerce - Reports
- Get Reports
- Retrieve a report of Sales
- Retrieve a report of Top Sellers
- Retrieve a report of the Total Coupons
- Retrieve a report of the Total Customers
- Retrieve a report of the Total Orders
- Retrieve a report of the Total Products
- Retrieve a report of the Total Reviews
WooCommerce - Data
- Retrieve a list of available data endpoints.
- Get continents.
- Retrieve continent data.
- Get countries.
- Retrieve country data.
- Get currencies.
- Retrieve currency data.
- Retrieve current currency data.
WooCommerce - System Status
- Get System Status Items
WooCommerce - Payment gateways
- Retrieve a Payment Gateway by id
- Get all the Payment Gateways
- Update a Payment Gateway
WooCommerce - Setting options
- Retrieve a specific Setting Option
- Get all the Setting Options
- Update a Setting Option by id
- Batch update Setting Options
Disclaimer: This plugin is not affiliated with or supported by Automattic, Inc. All logos and trademarks are the property of their respective owners.
Libraries
- models/collection
- models/image
- models/links
- models/meta_data
- models/payload/order_wc
- models/response/api_data
- models/response/continent
- models/response/countries
- models/response/coupon
- models/response/coupon_batch
- models/response/currencies
- models/response/customer
- models/response/customer_batch
- models/response/customer_download
- models/response/dimension
- models/response/order
- models/response/order_batch
- models/response/order_notes
- models/response/payment_gateway
- models/response/product
- models/response/product_attribute_term
- models/response/product_attributes
- models/response/product_batch
- models/response/product_category
- models/response/product_category_collection
- models/response/product_review
- models/response/product_shipping_class
- models/response/product_tag
- models/response/product_variation
- models/response/refund
- models/response/reports
- models/response/sale_report
- models/response/setting_option
- models/response/setting_option_batch
- models/response/shipping_method
- models/response/shipping_zone
- models/response/shipping_zone_location
- models/response/system_status
- models/response/tax_classes
- models/response/tax_rate
- models/response/top_seller_report
- models/response/woosignal_app
- models/self
- networking/api_provider
- woosignal