woocommerceaio

An async Python wrapper for the WooCommerce REST API based on httpx.

This is an unofficial fork of the WooCommerce-provided Python client, originally created by Claudio Sanches.

The main difference between woocommerceaio and the official client resides in the use of the async HTTP library httpx instead of requests.

Other differences include:

• Support for retries.
• Type hints.
• And more to come (as I use the library I need to add more features)

Installation

pip install woocommerceaio

Getting started

Generate API credentials (Consumer Key & Consumer Secret) following this instructions at 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/.

Setup

    from woocommerceaio import API

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

Options

Methods

You can interact with the WooCommerce API using via the exposed methods get(), post(), put(), delete(), options().

• All methods

the following parameters.

kwargs params

woocommerceaio allows you to pass any httpx arguments as kwargs params. This is useful if you want to customize headers, timeouts, and other request parameters. For a list of available params, refer to the httpx documentation.

Additionally, woocommerceaio provides the following custom kwargs params:

Response

All methods will return an httpx Response object. For more information on how to use this object, refer to the httpx documentation.

Examples

Retrieving store products

    >>> r = await 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

Making requests with params

    from woocommerceaio import API

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

        # Force delete example.
        response = await wcapi.delete("products/100", params={"force": True})
        print(response.json())

        # Query example.
        response = await wcapi.get("products", params={"per_page": 20})
        print(response.json())

    if __name__ == "__main__":
        import asyncio
        loop = asyncio.get_event_loop()
        loop.run_until_complete(example())

Changelog

See CHANGELOG.md.