- Notifications
You must be signed in to change notification settings - Fork0
A Python wrapper for the WooCommerce API.
License
rooprob/wc-api-python
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
Having no feedback from the creator of wc-api-python, I have forked the project to add the session functionality of requests and the Retry functionality
A Python wrapper for the WooCommerce REST API. Easily interact with the WooCommerce REST API using this library.
pip install -U git+https://github.com/<user>/<repo>@tag
Generate API credentials (Consumer Key & Consumer Secret) following this instructionshttp://woocommerce.github.io/woocommerce-rest-api-docs/#rest-api-keys.
Check out the WooCommerce API endpoints and data that can be manipulated inhttp://woocommerce.github.io/woocommerce-rest-api-docs/.
fromwoocommerceimportAPIwcapi=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 iswc/v3 |
timeout | integer | no | Connection timeout, default is5 |
verify_ssl | bool | no | Verify SSL when connect, use this option asFalse when need to test with self-signed certificates |
query_string_auth | bool | no | Force Basic Authentication as query string whenTrue and using under HTTPS, default isFalse |
user_agent | string | no | Set a custom User-Agent, default isWooCommerce-Python-REST-API/3.0.0 |
oauth_timestamp | integer | no | Custom timestamp for requests made with oAuth1.0a |
retries | int | no | Set to3 in order to retry 3 times before exiting. |
backoff_factor | float | no | Set to0.3. Change how long the processes will sleep between failed requests (exponential). |
status_forcelist | list | no | Set to[500, 502, 503, 504, 429] List of status on which we have to try again |
| Params | Type | Description |
|---|---|---|
endpoint | string | WooCommerce API endpoint, example:customers ororder/12 |
data | dictionary | Data that will be converted to JSON |
**kwargs | dictionary | Acceptsparams, also other Requests arguments |
.get(endpoint, **kwargs)
.post(endpoint, data, **kwargs)
.put(endpoint, data), **kwargs
.delete(endpoint, **kwargs)
.options(endpoint, **kwargs)
All methods will returnResponse object.
Example of returned data:
>>> r = wcapi.get("products")>>> r.status_code200>>> r.headers['content-type']'application/json; charset=UTF-8'>>> r.encoding'UTF-8'>>> r.textu'{"products":[{"title":"Flying Ninja","id":70,...' // Json text>>>r.json(){u'products': [{u'sold_individually': False,... // Dictionary data
fromwoocommerceimportAPIwcapi=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())
SeeCHANGELOG.md.
About
A Python wrapper for the WooCommerce API.
Resources
License
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Packages0
Languages
- Python100.0%