Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 110 Commits
.github/workflows		.github/workflows
woocommerce		woocommerce
.editorconfig		.editorconfig
.flake8		.flake8
.gitignore		.gitignore
CHANGELOG.md		CHANGELOG.md
LICENSE.txt		LICENSE.txt
README.rst		README.rst
requirements-test.txt		requirements-test.txt
requirements.txt		requirements.txt
setup.py		setup.py
test_api.py		test_api.py

Repository files navigation

WooCommerce API - Python Client

A Python wrapper for the WooCommerce REST API. Easily interact with the WooCommerce REST API using this library.

https://github.com/woocommerce/wc-api-python/actions/workflows/ci.yml/badge.svg?branch=trunk

Installation

pip install woocommerce

Getting started

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/.

Setup

fromwoocommerceimportAPIwcapi=API(url="http://example.com",consumer_key="ck_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",consumer_secret="cs_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",version="wc/v3")

Options

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)

Methods

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

.get(endpoint, **kwargs)

POST

.post(endpoint, data, **kwargs)

PUT

.put(endpoint, data), **kwargs

DELETE

.delete(endpoint, **kwargs)

OPTIONS

.options(endpoint, **kwargs)

Response

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

Request with params example

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())