woocommerce 0.7.1

Woocommerce SDK for Flutter. The Complete Woo Commerce SDK for building Flutter Applications with WooCommerce.

woocommerce

Woocommerce SDK for Flutter.

Getting Started

Add the package to your pubspec.yaml and import.

import 'package:woocommerce/woocommerce.dart';

Create an instance of WooCommerce for your project.

Example:

WooCommerce woocommerce = WooCommerce(
  baseUrl: yourBaseUrl,
  consumerKey: yourConsumerKey,
  consumerSecret: consumerSecret);

Parameter, [baseUrl] is the base url of your site. For example, http://me.com, https://me.com or http://my.me.com

Parameter [consumerKey] is the consumer key provided by WooCommerce, e.g. ck_12abc34n56j.

Parameter [consumerSecret] is the consumer secret provided by WooCommerce, e.g. cs_1uab8h3s3op.

Optional Parameter [apiPath] is the direct url from your baseUrl to your Woo commerce endpoint. An example : "/wp-json/wc/v3/" This is useful if only you changed your default Wordpress Woocommerce path, otherwise default applies.

The goal of Woo Commerce SDK is to make building amazing Ecommerce apps with flutter and Woo Commerce as easy as can be, hope it improves your workflow.

Features.

• Customer / User Authentication.
• Cart Management.
• Order Management.
• Products management.
• Categories.
• Tags.
• Variations.
• Ability to filter on methods that returns a list.
• Supports custom endpoints.
• Shipping.
• Tax, TaxClasses.
• Etc and more.

Notes.

Install Wordpress Jwt Token Plugin and Wp Rest User, to be able to log in,

Examples

Login - Returns the access token on success.

final token = woocommerce.authenticateViaJWT(username: username, password: password);

Login - Signs a user in and returns the logged in user's wordpress user object.

final user = woocommerce.loginUser(username: username, password: password);

Get All Products - Returns list of product object, default is 10 per page, see Api reference for filter options.

final myProducts = await woocommerce.getProducts();

Get All Featured Products - Returns a list of featured products, see Api reference for more filter options.

final myFeaturedProducts = await woocommerce.getProducts(featured: true);

Get All Products marked with category id '22'.

final mySpecificProduct = await getProducts(category: '22');

Add To Cart! - Returns the added cart item object(Accepts quantity, product id, and list of variations(id) of the product to be added).

final myCart = await woocommerce.addToCart(quantity: 2, id: 17);

Create an Order. - Returns the created order object (Accepts an orderPayload object).

OrderPayload orderPayload = OrderPayload(customerId: customerId, setPaid=true);
final order = await woocommerce.CreateOrder(orderPayload);

Custom Requests - Make your custom authenticated requests to the Woocommerce api.

final response = await woocommerce.put(endpoint, data);

Updates

This project is under active development.

• ✅ Add documentation.
• ❌ Add helper Update methods.
• ❌ Add helper Delete methods.
• ❌ Multiple Examples.

Issues and FeedBack

If you find this useful 💙, feel free to click ⭐ You can create a Github issue anytime. Pull requests on both code and documentation are welcomed as well pls 😍. You can also send a mail to [e-mail]. For help getting started with Flutter, view our online documentation, which offers tutorials, samples, guidance on mobile development, and a full API reference.