A Python wrapper for the WooCommerce REST API. Easily interact with the WooCommerce REST API using this library.
pip install woocommerceGenerate API credentials (Consumer Key & Consumer Secret) following this instructions http://docs.woocommerce.com/document/woocommerce-rest-api/.
Check out the WooCommerce API endpoints and data that can be manipulated in http://woocommerce.github.io/woocommerce-rest-api-docs/.
Setup for the old WooCommerce API v3:
from woocommerce import API
wcapi = API(
url="http://example.com",
consumer_key="ck_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
consumer_secret="cs_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
)Setup for the new WP REST API integration (WooCommerce 2.6 or later):
from woocommerce import API
wcapi = API(
url="http://example.com",
consumer_key="ck_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
consumer_secret="cs_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
wp_api=True,
version="wc/v1"
)| Option | Type | Required | Description |
|---|---|---|---|
url |
string |
yes | Your Store URL, example: http://woo.dev/ |
consumerKey |
string |
yes | Your API consumer key |
consumerSecret |
string |
yes | Your API consumer secret |
wp_api |
bool |
no | Allow requests to the WP REST API (WooCommerce 2.6 or later) |
version |
string |
no | API version, default is v3 |
timeout |
integer |
no | Connection timeout, default is 5 |
verify_ssl |
bool |
no | Verify SSL when connect, use this option as False when need to test with self-signed certificates |
query_string_auth |
bool |
no | Force Basic Authentication as query string when True and using under HTTPS, default is False |
| Params | Type | Description |
|---|---|---|
endpoint |
string |
WooCommerce API endpoint, example: customers or order/12 |
data |
dictionary |
Data that will be converted to JSON |
.get(endpoint)
.post(endpoint, data)
.put(endpoint, data)
.delete(endpoint)
.options(endpoint)
All methods will return Response object.
Example of returned data:
>>> r = wcapi.get("products")
>>> r.status_code
200
>>> r.headers['content-type']
'application/json; charset=UTF-8'
>>> r.encoding
'UTF-8'
>>> r.text
u'{"products":[{"title":"Flying Ninja","id":70,...' // Json text
>>> r.json()
{u'products': [{u'sold_individually': False,... // Dictionary data- Fixed WordPress 4.7 compatibility.
- Added option
query_string_authto allow Basic Auth as query strings.
- Fixed oAuth signature for WP REST API.
- Added support for WP REST API.
- Added method to do HTTP OPTIONS requests.
- Fixed oAuth filters sorting.
- Implemented
timeoutargument forAPIclass.
- Forced utf-8 encoding on
API.__request()to avoidUnicodeDecodeError
- Fixed handler for query strings
- Fixed support for Python 2.6
- Initial version