A Python wrapper for the WooCommerce REST API. Easily interact with the WooCommerce REST API using this library.
Generate API credentials (Consumer Key & Consumer Secret) following this instructions http://woocommerce.github.io/woocommerce-rest-api-docs/#rest-api-keys.
Check out the WooCommerce API endpoints and data that can be manipulated in http://woocommerce.github.io/woocommerce-rest-api-docs/.
from woocommerce import API
wcapi = API(
url="http://example.com",
consumer_key="ck_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
consumer_secret="cs_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
version="wc/v3"
) Option Type Required Description url string yes Your Store URL, example: http://woo.dev/ consumer_key string yes Your API consumer key consumer_secret string yes Your API consumer secret version string no API version, default is wc/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 user_agent string no Set a custom User-Agent, default is WooCommerce-Python-REST-API/3.0.0 oauth_timestamp integer no Custom timestamp for requests made with oAuth1.0a wp_api bool no Set to False in order to use the legacy WooCommerce API (deprecated) Params Type Description endpoint string WooCommerce API endpoint, example: customers or order/12 data dictionary Data that will be converted to JSON **kwargs dictionary Accepts params, also other Requests arguments
.get(endpoint, **kwargs).post(endpoint, data, **kwargs).put(endpoint, data), **kwargs.delete(endpoint, **kwargs).options(endpoint, **kwargs)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 Request with params example
from woocommerce import API
wcapi = API(
url="http://example.com",
consumer_key="ck_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
consumer_secret="cs_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
version="wc/v3"
)
# Force delete example.
print(wcapi.delete("products/100", params={"force": True}).json())
# Query example.
print(wcapi.get("products", params={"per_page": 20}).json())
See CHANGELOG.md.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4