What To Know ?

Before starting using this library, please, take a quick look over the YouCan Developers and get some ideas about what it contains, the endpoints it provides.

This will really help you understand and get familiar with this library very quickly, since it's based on it.

What to expect from this library

Well, the YouCan Developers offers an admin store APIs and front store APIs. Every part of the front store API is covered by this library including, authentication, products, customers, categories, reviews....

Example Of Working With The Library

As example, if you wanted to get all your store's products, you can simply call an all() method on products like this:

List<Product> allProducts = await YouCan.instance.products.all();

Yep, only one line to get all of them as a List<Product> and every Product object will contain a product data from your store that you can use.

Now let's say you wanted to search over them, you can simply create a new products query using search() then call all() like this:

List<Product> searchedProducts = await YouCan.instance.products.search("product 1").all();