Skip to content

Commit dfc7fdf

Browse files
author
WooSignal
authored
Update Readme
1 parent f7247ab commit dfc7fdf

File tree

1 file changed

+113
-4
lines changed

1 file changed

+113
-4
lines changed

README.md

Lines changed: 113 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,22 @@ Free to get started, see the simple examples below
99
For help getting started with WooSignal, view our
1010
[online documentation](https://woosignal.com/docs/api/1.0/overview), which offers a more detail guide.
1111

12-
## Usage
13-
To use this plugin, add `woosignal` as a [dependency in your pubspec.yaml file](https://flutter.io/platform-plugins/).
12+
### Getting Started #
13+
In your flutter project add the dependency:
1414

15-
### Example
15+
``` dart
16+
dependencies:
17+
...
18+
woosignal: ^1.0.8
19+
```
20+
21+
### Usage example #
22+
Import woosignal.dart
23+
``` dart
24+
import 'package:woosignal/woosignal.dart';
25+
```
26+
27+
### Example using WooSignal API for WooCommerce
1628

1729
``` dart
1830
import 'package:woosignal/woosignal.dart';
@@ -39,4 +51,101 @@ _getProducts() async {
3951
}
4052
```
4153

42-
Disclaimer: This plugin is not affiliated with or supported by Automattic, Inc. All logos and trademarks are the property of their respective owners.
54+
### Available API Requests
55+
56+
#### WooCommerce - Products
57+
- Get Products
58+
- Retrive a Product by id
59+
60+
[See Products API](https://woosignal.com/docs/api/1.0/products#list-all-products)
61+
62+
63+
#### WooCommerce - Product Variations
64+
- Get Product Variations
65+
- Retrive a Product Variation by id
66+
67+
[See Product Variations API](https://woosignal.com/docs/api/1.0/products-variations)
68+
69+
70+
#### WooCommerce - Product Attributes
71+
- Get Product Attributes
72+
73+
[See Product Attributes API](https://woosignal.com/docs/api/1.0/products-attributes)
74+
75+
76+
#### WooCommerce - Products Attribute Terms
77+
- Get Products Attribute Terms
78+
79+
[See Products Attribute Terms API](https://woosignal.com/docs/api/1.0/products-attribute-terms)
80+
81+
#### WooCommerce - Product Categories
82+
- Get Product Categories
83+
84+
[See Product Categories API](https://woosignal.com/docs/api/1.0/product-categories)
85+
86+
87+
#### WooCommerce - Products Shipping Classes
88+
- Get Products Shipping Classes
89+
90+
[See Products Shipping Classes API](https://woosignal.com/docs/api/1.0/product-shipping-classes)
91+
92+
93+
#### WooCommerce - Product Reviews
94+
- Get Product Reviews
95+
96+
[See Product Reviews API](https://woosignal.com/docs/api/1.0/product-reviews)
97+
98+
99+
#### WooCommerce - Tax Rates
100+
- Get Tax Rates
101+
102+
[See Tax Rates API](https://woosignal.com/docs/api/1.0/tax-rates)
103+
104+
105+
#### WooCommerce - Tax Classes
106+
- Get Tax Classes
107+
108+
[See Tax Classes API](https://woosignal.com/docs/api/1.0/tax-classes)
109+
110+
111+
#### WooCommerce - Shipping Zones
112+
- Get Shipping Zones
113+
- Retrive a Shipping Zone by id
114+
115+
[See Tax Classes API](https://woosignal.com/docs/api/1.0/tax-classes)
116+
117+
118+
#### WooCommerce - Shipping Zone Locations
119+
- Get Shipping Zone Locations
120+
- Retrive a Shipping Zone Location by id
121+
122+
[See Shipping Zone Locations API](https://woosignal.com/docs/api/1.0/shipping-zone-locations)
123+
124+
125+
#### WooCommerce - Shipping Zone Methods
126+
- Get Shipping Zone Methods
127+
- Retrive a Shipping Zone Method by id
128+
129+
[See Shipping Zone Methods API](https://woosignal.com/docs/api/1.0/shipping-zone-methods)
130+
131+
132+
#### WooCommerce - Shipping Methods
133+
- Get Shipping Methods
134+
135+
[See Shipping Methods API](https://woosignal.com/docs/api/1.0/shipping-methods)
136+
137+
138+
#### WooCommerce - Orders
139+
- Get Orders
140+
- Retrive a Order by id
141+
- Create an Order
142+
143+
[See Order API](https://woosignal.com/docs/api/1.0/orders)
144+
145+
146+
#### WooCommerce - Customers
147+
- Get Customers
148+
149+
[See Customers API](https://woosignal.com/docs/api/1.0/customers)
150+
151+
Disclaimer: This plugin is not affiliated with or supported by Automattic, Inc. All logos and trademarks are the property of their respective owners.

0 commit comments

Comments
 (0)